MongoCollection::getName
MongoCollection::getSlaveOkay
MongoCollection
PHP Manual

# MongoCollection::getReadPreference

(PECL mongo >=1.3.0)

MongoCollection::getReadPreference — このコレクションの優先読み込みを取得する

### 説明

public array MongoCollection::getReadPreference ( void )

### パラメータ

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

### 返り値

この関数は、優先読み込みに関する配列を返します。配列に含まれる内容は、type (優先読み込みモードを表す文字列。MongoClient の定数に対応)、そして tagsets (すべてのタグセット条件のリスト) です。タグセットを指定しなかった場合は、tagsets は存在しません。

### 変更履歴

バージョン | 説明
--- | ---
1.3.3 | 返り値が変わり、 MongoCollection::setReadPreference() との整合性があるものになりました。 type の値は数字から文字列に変わり、 type_string は削除され、そして tagsets はコロン区切りの文字列ではなくキー/値のペアでタグを表すようになりました。

### 例

例1 MongoCollection::getReadPreference() の返り値の例

`<?php
$m = new MongoClient();
$c = $m->test->users;
$c->setReadPreference(MongoClient::RP_SECONDARY, array(
array('dc' => 'east', 'use' => 'reporting'),
array('dc' => 'west'),
array(),
));
var_dump($c->getReadPreference());
?>`

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

    array(2) {
      ["type"]=>
      string(9) "secondary"
      ["tagsets"]=>
      array(3) {
        [0]=>
        array(2) {
          ["dc"]=>
          string(4) "east"
          ["use"]=>
          string(9) "reporting"
        }
        [1]=>
        array(1) {
          ["dc"]=>
          string(7) "west"
        }
        [2]=>
        array(0) {
        }
      }
    }

### 参考

- 優先読み込みのドキュメント

MongoCollection::getName
MongoCollection::getSlaveOkay
MongoCollection
PHP Manual