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

MongoDB\Driver\ReadPreference::getMode

PHP function Deprecated as of mongodb 1.20.0 Edit on GitHub ✎

(mongodb >=1.0.0)

Returns the ReadPreference's "mode" option

This function has been DEPRECATED as of extension version 1.20.0 and was removed in 2.0. Applications should use MongoDB\Driver\ReadPreference::getModeString instead.

Description

MongoDB\Driver\ReadPreference::getMode(): int

Parameters Parameters

Return Values

Returns the ReadPreference's "mode" option.

Errors/Exceptions

Changelog

Version	Description

Examples

MongoDB\Driver\ReadPreference::getMode() example

php

<?php

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

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

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

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

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

?>

The above example will output:

output

int(1)
int(5)
int(2)
int(6)
int(10)