mongocollection.getreadpreference(3) php man page | unix.com

MONGOCOLLECTION.GETREADPREFERENCE(3)					 1				      MONGOCOLLECTION.GETREADPREFERENCE(3)

MongoCollection::getReadPreference - Get the read preference for this collection

SYNOPSIS
       public array MongoCollection::getReadPreference (void  )

DESCRIPTION
PARAMETERS
       This function has no parameters.

RETURN VALUES
       This function returns an array describing the read preference. The array contains the values type for the string read preference mode (cor-
       responding to the MongoClient constants), and tagsets containing a list of all tag set criteria. If no tag  sets  were  specified,  tagsets
       will not be present in the array.

CHANGELOG
       +--------+---------------------------------------------------+
       |Version |						    |
       |	|						    |
       |	|		     Description		    |
       |	|						    |
       +--------+---------------------------------------------------+
       | 1.3.3	|						    |
       |	|						    |
       |	|  The	return	value  has changed to be consistent |
       |	| with MongoCollection::setReadPreference. The type |
       |	| value  was  changed  from  a	number to a string, |
       |	| type_string  was   removed,	and   tagsets	now |
       |	| expresses  tags  as  key/value  pairs  instead of |
       |	| colon-delimited strings.			    |
       |	|						    |
       +--------+---------------------------------------------------+
EXAMPLES
       Example #1

	      MongoCollection::getReadPreference return value example

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

	      The above example will output:

	      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) {
		  }
		}
	      }

SEE ALSO The read preferences documentation., MongoCollection.setReadPreference(3).
PHP Documentation Group 										      MONGOCOLLECTION.GETREADPREFERENCE(3)