MongoDB\Driver\ReadPreference::getModeString

Returns the ReadPreference's "mode" option as a string

&reftitle.description; final public `string` `MongoDB\Driver\ReadPreference::getModeString`
&reftitle.parameters; &no.function.parameters;
&reftitle.returnvalues;

Returns the ReadPreference's "mode" option as a string.

&reftitle.errors;

&mongodb.throws.argumentparsing;

&reftitle.examples;

### `MongoDB\Driver\ReadPreference::getModeString` example

    <?php

    $rp = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::PRIMARY);
    var_dump($rp->getModeString());

    $rp = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::PRIMARY_PREFERRED);
    var_dump($rp->getModeString());

    $rp = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::SECONDARY);
    var_dump($rp->getModeString());

    $rp = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::SECONDARY_PREFERRED);
    var_dump($rp->getModeString());

    $rp = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::NEAREST);
    var_dump($rp->getModeString());

    ?>

&example.outputs;

    string(7) "primary"
    string(16) "primaryPreferred"
    string(9) "secondary"
    string(18) "secondaryPreferred"
    string(7) "nearest"

&reftitle.seealso;

- `MongoDB\Driver\ReadPreference::getMode`
- Read Preference reference