Home/ Manual/ driver / readpreference/ MongoDB\Driver\ReadPreference::getModeString

MongoDB\Driver\ReadPreference::getModeString

PHP function Edit on GitHub ✎

(mongodb >=1.7.0)

Returns the ReadPreference's "mode" option

Description

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

Parameters Parameters

Return Values

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

Errors/Exceptions

Examples

MongoDB\Driver\ReadPreference::getModeString() example

php

<?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:

output

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