MongoDB\Driver\ReadPreference::getModeString

(mongodb >=1.7.0)

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

説明

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

パラメータ

この関数にはパラメータはありません。

戻り値

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

エラー / 例外

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

例

例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());

?>

上の例の出力は以下となります。

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

参考

MongoDB\Driver\ReadPreference::getMode() - Returns the ReadPreference's "mode" option
» Read Preference reference

関連キーワード:

ReadPreference MongoDB Driver getModeString mode option dump getMode getTagSets mongodb final Throws Exception InvalidArgumentException argument parsing errors example primary primaryPreferred secondary secondaryPreferred nearest 参考 Read