PHP Manual
MongoDB\Driver\ReadPreference
Returns the ReadPreference's "mode" option as a string

MongoDB\Driver\ReadPreference::getModeString

(mongodb >=1.7.0)

MongoDB\Driver\ReadPreference::getModeString — Returns the ReadPreference's "mode" option as a string

Description

final public MongoDB\Driver\ReadPreference::getModeString ( ) : string

Parameters

This function has no parameters.

Return Values

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

Errors/Exceptions

Throws MongoDB\Driver\Exception\InvalidArgumentException on argument parsing errors.

Examples

Example #1 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());?>

The above example will output:

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

Php/docs/mongodb-driver-readpreference.getmodestring

Contents