Commit da8a7fb3 authored by Jeremy Mikola's avatar Jeremy Mikola

PHPLIB-271: Revise docs for option accessors

parent bea897bf
...@@ -50,6 +50,8 @@ BSON Classes ...@@ -50,6 +50,8 @@ BSON Classes
serialize as a document type (:php:`object casting serialize as a document type (:php:`object casting
<types.type-juggling#language.types.typecasting>` is used internally). <types.type-juggling#language.types.typecasting>` is used internally).
.. _php-type-map:
Type Maps Type Maps
--------- ---------
......
======================================== =================================
MongoDB\\Client::getReadConcern() MongoDB\\Client::getReadConcern()
======================================== =================================
.. default-domain:: mongodb .. default-domain:: mongodb
...@@ -15,11 +15,7 @@ Definition ...@@ -15,11 +15,7 @@ Definition
.. phpmethod:: MongoDB\\Client::getReadConcern() .. phpmethod:: MongoDB\\Client::getReadConcern()
Accessor for the Returns the read concern for this client.
:php:`MongoDB\\Driver\\ReadConcern <class.mongodb-driver-readconcern>` used by this
:phpclass:`Client <MongoDB\\Client>`.
Returns the default read concern of this client.
.. code-block:: php .. code-block:: php
...@@ -37,16 +33,24 @@ Example ...@@ -37,16 +33,24 @@ Example
<?php <?php
$readConcern = new MongoDB\Driver\ReadConcern(MongoDB\Driver\ReadConcern::MAJORITY); $client = new MongoDB\Client('mongodb://127.0.0.1/', [
$client = new MongoDB\Client( 'readConcernLevel' => 'majority',
'mongodb://127.0.0.1/', ]);
['readConcernLevel' => MongoDB\Driver\ReadConcern::MAJORITY]
); var_dump($client->getReadConcern());
The output would then resemble::
MongoDB\Driver\ReadConcern::MAJORITY === $client->getReadConcern()->getLevel(); // true object(MongoDB\Driver\ReadConcern)#5 (1) {
["level"]=>
string(8) "majority"
}
See Also See Also
-------- --------
- :manual:`Read Concern </reference/read-concern>` in the MongoDB manual
- :php:`MongoDB\\Driver\\ReadConcern::isDefault() <mongodb-driver-readconcern.isdefault>`
- :phpmethod:`MongoDB\\Collection::getReadConcern()` - :phpmethod:`MongoDB\\Collection::getReadConcern()`
- :phpmethod:`MongoDB\\Database::getReadConcern()` - :phpmethod:`MongoDB\\Database::getReadConcern()`
- :phpmethod:`MongoDB\\GridFS\\Bucket::getReadConcern()`
======================================== ====================================
MongoDB\\Client::getReadPreference() MongoDB\\Client::getReadPreference()
======================================== ====================================
.. default-domain:: mongodb .. default-domain:: mongodb
...@@ -15,11 +15,7 @@ Definition ...@@ -15,11 +15,7 @@ Definition
.. phpmethod:: MongoDB\\Client::getReadPreference() .. phpmethod:: MongoDB\\Client::getReadPreference()
Accessor for the Returns the read preference for this client.
:php:`MongoDB\\Driver\\ReadPreference <class.mongodb-driver-readpreference>` used by this
:phpclass:`Client <MongoDB\\Client>`.
Returns the default read preference of this client.
.. code-block:: php .. code-block:: php
...@@ -28,7 +24,8 @@ Definition ...@@ -28,7 +24,8 @@ Definition
Return Values Return Values
------------- -------------
A :php:`MongoDB\\Driver\\ReadPreference <class.mongodb-driver-readpreference>` object. A :php:`MongoDB\\Driver\\ReadPreference <class.mongodb-driver-readpreference>`
object.
Example Example
------- -------
...@@ -37,23 +34,23 @@ Example ...@@ -37,23 +34,23 @@ Example
<?php <?php
$client = new MongoDB\Client( $client = new MongoDB\Client('mongodb://127.0.0.1/', [
'test', 'readPreference' => 'primaryPreferred',
[ ]);
'readPreference' => MongoDB\Driver\ReadPreference::RP_PRIMARY,
'readPreferenceTags' => ['foo' => 'bar', 'spam' => 'egg'], var_dump($client->getReadPreference());
'maxStalenessSeconds' => 150,
]
);
$readPreference = $client->getReadPreference(); The output would then resemble::
MongoDB\Driver\ReadPreference::RP_PRIMARY === $readPreference->getMode(); // true object(MongoDB\Driver\ReadPreference)#5 (1) {
['foo' => 'bar', 'spam' => 'egg'] === $readPreference->getTags(); // true ["mode"]=>
150 = $readPreference->getMaxStalenessSeconds(); // true string(16) "primaryPreferred"
}
See Also See Also
-------- --------
- :manual:`Read Preference </reference/read-preference>` in the MongoDB manual
- :phpmethod:`MongoDB\\Collection::getReadPreference()` - :phpmethod:`MongoDB\\Collection::getReadPreference()`
- :phpmethod:`MongoDB\\Database::getReadPreference()` - :phpmethod:`MongoDB\\Database::getReadPreference()`
- :phpmethod:`MongoDB\\GridFS\\Bucket::getReadPreference()`
======================================== =============================
MongoDB\\Client::getTypeMap() MongoDB\\Client::getTypeMap()
======================================== =============================
.. default-domain:: mongodb .. default-domain:: mongodb
...@@ -15,7 +15,7 @@ Definition ...@@ -15,7 +15,7 @@ Definition
.. phpmethod:: MongoDB\\Client::getTypeMap() .. phpmethod:: MongoDB\\Client::getTypeMap()
Accessor for the type map used by this :phpclass:`Client <MongoDB\\Client>`. Returns the type map for this client.
.. code-block:: php .. code-block:: php
...@@ -24,7 +24,7 @@ Definition ...@@ -24,7 +24,7 @@ Definition
Return Values Return Values
------------- -------------
A type map array. A :ref:`type map <php-type-map>` array.
Example Example
------- -------
...@@ -33,12 +33,17 @@ Example ...@@ -33,12 +33,17 @@ Example
<?php <?php
$typeMap = ['root' => 'array', 'document' => 'array', 'array' => 'array']; $client = new MongoDB\Client('mongodb://127.0.0.1/', [], [
$client = new MongoDB\Client('mongodb://127.0.0.1/', [], ['typeMap' => $typeMap]); 'typeMap' => [
$client->getTypeMap() === $typeMap; //true 'root' => 'array',
'document' => 'array',
'array' => 'array',
],
]);
var_dump($client->getTypeMap()); var_dump($client->getTypeMap());
The output will be as follows: The output would then resemble::
array(3) { array(3) {
["root"]=> ["root"]=>
...@@ -52,5 +57,7 @@ The output will be as follows: ...@@ -52,5 +57,7 @@ The output will be as follows:
See Also See Also
-------- --------
- :doc:`/reference/bson`
- :phpmethod:`MongoDB\\Collection::getTypeMap()` - :phpmethod:`MongoDB\\Collection::getTypeMap()`
- :phpmethod:`MongoDB\\Database::getTypeMap()` - :phpmethod:`MongoDB\\Database::getTypeMap()`
- :phpmethod:`MongoDB\\GridFS\\Bucket::getTypeMap()`
======================================== ==================================
MongoDB\\Client::getWriteConcern() MongoDB\\Client::getWriteConcern()
======================================== ==================================
.. default-domain:: mongodb .. default-domain:: mongodb
...@@ -15,11 +15,7 @@ Definition ...@@ -15,11 +15,7 @@ Definition
.. phpmethod:: MongoDB\\Client::getWriteConcern() .. phpmethod:: MongoDB\\Client::getWriteConcern()
Accessor for the Returns the write concern for this client.
:php:`MongoDB\\Driver\\WriteConcern <class.mongodb-driver-writeconcern>` used by this
:phpclass:`Client <MongoDB\\Client>`.
Returns the default write concern of this client.
.. code-block:: php .. code-block:: php
...@@ -28,7 +24,8 @@ Definition ...@@ -28,7 +24,8 @@ Definition
Return Values Return Values
------------- -------------
A :php:`MongoDB\\Driver\\WriteConcern <class.mongodb-driver-writeconcern>` object. A :php:`MongoDB\\Driver\\WriteConcern <class.mongodb-driver-writeconcern>`
object.
Example Example
------- -------
...@@ -37,14 +34,24 @@ Example ...@@ -37,14 +34,24 @@ Example
<?php <?php
$client = new MongoDB\Client('mongodb://127.0.0.1', ['w' => 1, 'wTimeoutMS' => 100, 'journal' => true]); $client = new MongoDB\Client('mongodb://127.0.0.1/', [
$writeConcern = $client->getWriteConcern(); 'journal' => true,
1 === $writeConcern->getW(); // true ]);
100 === $writeConcern->getWtimeout(); // true
$writeConcern->getJournal(); // true var_dump($client->getWriteConcern());
The output would then resemble::
object(MongoDB\Driver\WriteConcern)#4 (1) {
["j"]=>
bool(true)
}
See Also See Also
-------- --------
- :manual:`Write Concern </reference/read-concern>` in the MongoDB manual
- :php:`MongoDB\\Driver\\WriteConcern::isDefault() <mongodb-driver-writeconcern.isdefault>`
- :phpmethod:`MongoDB\\Collection::getWriteConcern()` - :phpmethod:`MongoDB\\Collection::getWriteConcern()`
- :phpmethod:`MongoDB\\Database::getWriteConcern()` - :phpmethod:`MongoDB\\Database::getWriteConcern()`
- :phpmethod:`MongoDB\\GridFS\\Bucket::getWriteConcern()`
======================================== =====================================
MongoDB\\Collection::getReadConcern() MongoDB\\Collection::getReadConcern()
======================================== =====================================
.. default-domain:: mongodb .. default-domain:: mongodb
...@@ -15,11 +15,7 @@ Definition ...@@ -15,11 +15,7 @@ Definition
.. phpmethod:: MongoDB\\Collection::getReadConcern() .. phpmethod:: MongoDB\\Collection::getReadConcern()
Accessor for the Returns the read concern for this collection.
:php:`MongoDB\\Driver\\ReadConcern <class.mongodb-driver-readconcern>` used by this
:phpclass:`Collection <MongoDB\\Collection>`.
Returns the default read concern of this collection.
.. code-block:: php .. code-block:: php
...@@ -37,14 +33,24 @@ Example ...@@ -37,14 +33,24 @@ Example
<?php <?php
$readConcern = new MongoDB\Driver\ReadConcern(MongoDB\Driver\ReadConcern::MAJORITY); $collection = (new MongoDB\Client)->selectCollection('test', 'users', [
$collection = (new MongoDB\Client)->test->selectCollection('test', ['readConcern' => $readConcern]); 'readConcern' => new MongoDB\Driver\ReadConcern(MongoDB\Driver\ReadConcern::MAJORITY),
]);
var_dump($collection->getReadConcern());
The output would then resemble::
$collection->getReadConcern() === $readConcern; // true object(MongoDB\Driver\ReadConcern)#5 (1) {
["level"]=>
string(8) "majority"
}
See Also See Also
-------- --------
- :manual:`Read Concern </reference/read-concern>` in the MongoDB manual
- :php:`MongoDB\\Driver\\ReadConcern::isDefault() <mongodb-driver-readconcern.isdefault>`
- :phpmethod:`MongoDB\\Client::getReadConcern()` - :phpmethod:`MongoDB\\Client::getReadConcern()`
- :phpmethod:`MongoDB\\Database::getReadConcern()` - :phpmethod:`MongoDB\\Database::getReadConcern()`
- :phpmethod:`MongoDB\\GridFS\Bucket::getReadConcern()` - :phpmethod:`MongoDB\\GridFS\\Bucket::getReadConcern()`
...@@ -15,11 +15,7 @@ Definition ...@@ -15,11 +15,7 @@ Definition
.. phpmethod:: MongoDB\\Collection::getReadPreference() .. phpmethod:: MongoDB\\Collection::getReadPreference()
Accessor for the Returns the read preference for this collection.
:php:`MongoDB\\Driver\\ReadPreference <class.mongodb-driver-readpreference>` used by this
:phpclass:`Collection <MongoDB\\Collection>`.
Returns the default read preference of this collection.
.. code-block:: php .. code-block:: php
...@@ -28,7 +24,8 @@ Definition ...@@ -28,7 +24,8 @@ Definition
Return Values Return Values
------------- -------------
A :php:`MongoDB\\Driver\\ReadPreference <class.mongodb-driver-readpreference>` object. A :php:`MongoDB\\Driver\\ReadPreference <class.mongodb-driver-readpreference>`
object.
Example Example
------- -------
...@@ -37,17 +34,23 @@ Example ...@@ -37,17 +34,23 @@ Example
<?php <?php
$readPreference = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::RP_PRIMARY); $collection = (new MongoDB\Client)->selectCollection('test', 'users', [
$collection = (new MongoDB\Client)->test->selectCollection( 'readPreference' => new MongoDB\Driver\ReadPreference('primaryPreferred'),
'test', ]);
['readPreference' => $readPreference]
); var_dump($collection->getReadPreference());
The output would then resemble::
$collection->getReadPreference() === $readPreference; // true object(MongoDB\Driver\ReadPreference)#5 (1) {
["mode"]=>
string(16) "primaryPreferred"
}
See Also See Also
-------- --------
- :manual:`Read Preference </reference/read-preference>` in the MongoDB manual
- :phpmethod:`MongoDB\\Client::getReadPreference()` - :phpmethod:`MongoDB\\Client::getReadPreference()`
- :phpmethod:`MongoDB\\Database::getReadPreference()` - :phpmethod:`MongoDB\\Database::getReadPreference()`
- :phpmethod:`MongoDB\\GridFS\\Bucket::getReadPreference()` - :phpmethod:`MongoDB\\GridFS\\Bucket::getReadPreference()`
======================================== =================================
MongoDB\\Collection::getTypeMap() MongoDB\\Collection::getTypeMap()
======================================== =================================
.. default-domain:: mongodb .. default-domain:: mongodb
...@@ -15,7 +15,7 @@ Definition ...@@ -15,7 +15,7 @@ Definition
.. phpmethod:: MongoDB\\Collection::getTypeMap() .. phpmethod:: MongoDB\\Collection::getTypeMap()
Accessor for the type map used by this :phpclass:`Collection <MongoDB\\Collection>`. Returns the type map for this collection.
.. code-block:: php .. code-block:: php
...@@ -24,7 +24,7 @@ Definition ...@@ -24,7 +24,7 @@ Definition
Return Values Return Values
------------- -------------
A type map array. A :ref:`type map <php-type-map>` array.
Example Example
------- -------
...@@ -33,13 +33,17 @@ Example ...@@ -33,13 +33,17 @@ Example
<?php <?php
$typeMap = ['root' => 'array', 'document' => 'array', 'array' => 'array']; $collection = (new MongoDB\Client)->selectCollection('test', 'users', [
$collection = (new MongoDB\Client)->test->selectCollection('test', ['typeMap' => $typeMap]); 'typeMap' => [
'root' => 'array',
'document' => 'array',
'array' => 'array',
],
]);
$collection->getTypeMap() === $typeMap; //true
var_dump($collection->getTypeMap()); var_dump($collection->getTypeMap());
The output will be as follows: The output would then resemble::
array(3) { array(3) {
["root"]=> ["root"]=>
...@@ -53,6 +57,7 @@ The output will be as follows: ...@@ -53,6 +57,7 @@ The output will be as follows:
See Also See Also
-------- --------
- :doc:`/reference/bson`
- :phpmethod:`MongoDB\\Client::getTypeMap()` - :phpmethod:`MongoDB\\Client::getTypeMap()`
- :phpmethod:`MongoDB\\Database::getTypeMap()` - :phpmethod:`MongoDB\\Database::getTypeMap()`
- :phpmethod:`MongoDB\\GridFS\\Bucket::getTypeMap()` - :phpmethod:`MongoDB\\GridFS\\Bucket::getTypeMap()`
======================================== ======================================
MongoDB\\Collection::getWriteConcern() MongoDB\\Collection::getWriteConcern()
======================================== ======================================
.. default-domain:: mongodb .. default-domain:: mongodb
...@@ -15,11 +15,7 @@ Definition ...@@ -15,11 +15,7 @@ Definition
.. phpmethod:: MongoDB\\Collection::getWriteConcern() .. phpmethod:: MongoDB\\Collection::getWriteConcern()
Accessor for the Returns the write concern for this collection.
:php:`MongoDB\\Driver\\WriteConcern <class.mongodb-driver-writeconcern>` used by this
:phpclass:`Collection <MongoDB\\Collection>`.
Returns the default write concern of this collection.
.. code-block:: php .. code-block:: php
...@@ -28,7 +24,8 @@ Definition ...@@ -28,7 +24,8 @@ Definition
Return Values Return Values
------------- -------------
A :php:`MongoDB\\Driver\\WriteConcern <class.mongodb-driver-writeconcern>` object. A :php:`MongoDB\\Driver\\WriteConcern <class.mongodb-driver-writeconcern>`
object.
Example Example
------- -------
...@@ -37,14 +34,26 @@ Example ...@@ -37,14 +34,26 @@ Example
<?php <?php
$writeConcern = new MongoDB\Driver\WriteConcern(2); $collection = (new MongoDB\Client)->selectCollection('test', 'users', [
$collection = (new MongoDB\Client)->test->selectCollection('test', ['writeConcern' => $writeConcern]); 'writeConcern' => new MongoDB\Driver\WriteConcern(1, 0, true),
]);
var_dump($collection->getWriteConcern());
The output would then resemble::
$collection->getWriteConcern() === $writeConcern; // true object(MongoDB\Driver\WriteConcern)#5 (2) {
["w"]=>
int(1)
["j"]=>
bool(true)
}
See Also See Also
-------- --------
- :manual:`Write Concern </reference/read-concern>` in the MongoDB manual
- :php:`MongoDB\\Driver\\WriteConcern::isDefault() <mongodb-driver-writeconcern.isdefault>`
- :phpmethod:`MongoDB\\Client::getWriteConcern()` - :phpmethod:`MongoDB\\Client::getWriteConcern()`
- :phpmethod:`MongoDB\\Database::getWriteConcern()` - :phpmethod:`MongoDB\\Database::getWriteConcern()`
- :phpmethod:`MongoDB\\GridFS\\Bucket::getWriteConcern()` - :phpmethod:`MongoDB\\GridFS\\Bucket::getWriteConcern()`
======================================== ===================================
MongoDB\\Database::getReadConcern() MongoDB\\Database::getReadConcern()
======================================== ===================================
.. default-domain:: mongodb .. default-domain:: mongodb
...@@ -15,11 +15,7 @@ Definition ...@@ -15,11 +15,7 @@ Definition
.. phpmethod:: MongoDB\\Database::getReadConcern() .. phpmethod:: MongoDB\\Database::getReadConcern()
Accessor for the Returns the read concern for this database.
:php:`MongoDB\\Driver\\ReadConcern <class.mongodb-driver-readconcern>` used by this
:phpclass:`Database <MongoDB\\Database>`.
Returns the default read concern of this database.
.. code-block:: php .. code-block:: php
...@@ -37,14 +33,24 @@ Example ...@@ -37,14 +33,24 @@ Example
<?php <?php
$readConcern = new MongoDB\Driver\ReadConcern(MongoDB\Driver\ReadConcern::MAJORITY); $database = (new MongoDB\Client)->selectDatabase('test', [
$database = (new MongoDB\Client)->selectDatabase('test', ['readConcern' => $readConcern]); 'readConcern' => new MongoDB\Driver\ReadConcern(MongoDB\Driver\ReadConcern::MAJORITY),
]);
var_dump($database->getReadConcern());
The output would then resemble::
$database->getReadConcern() === $readConcern; // true object(MongoDB\Driver\ReadConcern)#5 (1) {
["level"]=>
string(8) "majority"
}
See Also See Also
-------- --------
- :manual:`Read Concern </reference/read-concern>` in the MongoDB manual
- :php:`MongoDB\\Driver\\ReadConcern::isDefault() <mongodb-driver-readconcern.isdefault>`
- :phpmethod:`MongoDB\\Client::getReadConcern()` - :phpmethod:`MongoDB\\Client::getReadConcern()`
- :phpmethod:`MongoDB\\Collection::getReadConcern()` - :phpmethod:`MongoDB\\Collection::getReadConcern()`
- :phpmethod:`MongoDB\\GridFS\Bucket::getReadConcern()` - :phpmethod:`MongoDB\\GridFS\\Bucket::getReadConcern()`
======================================== ======================================
MongoDB\\Database::getReadPreference() MongoDB\\Database::getReadPreference()
======================================== ======================================
.. default-domain:: mongodb .. default-domain:: mongodb
...@@ -15,11 +15,7 @@ Definition ...@@ -15,11 +15,7 @@ Definition
.. phpmethod:: MongoDB\\Database::getReadPreference() .. phpmethod:: MongoDB\\Database::getReadPreference()
Accessor for the Returns the read preference for this database.
:php:`MongoDB\\Driver\\ReadPreference <class.mongodb-driver-readpreference>` used by this
:phpclass:`Database <MongoDB\\Database>`.
Returns the default read preference of this database.
.. code-block:: php .. code-block:: php
...@@ -28,7 +24,8 @@ Definition ...@@ -28,7 +24,8 @@ Definition
Return Values Return Values
------------- -------------
A :php:`MongoDB\\Driver\\ReadPreference <class.mongodb-driver-readpreference>` object. A :php:`MongoDB\\Driver\\ReadPreference <class.mongodb-driver-readpreference>`
object.
Example Example
------- -------
...@@ -37,17 +34,23 @@ Example ...@@ -37,17 +34,23 @@ Example
<?php <?php
$readPreference = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::RP_PRIMARY); $database = (new MongoDB\Client)->selectDatabase('test', [
$database = (new MongoDB\Client)->selectDatabase( 'readPreference' => new MongoDB\Driver\ReadPreference('primaryPreferred'),
'test', ]);
['readPreference' => $readPreference]
); var_dump($database->getReadPreference());
The output would then resemble::
$database->getReadPreference() === $readPreference; // true object(MongoDB\Driver\ReadPreference)#5 (1) {
["mode"]=>
string(16) "primaryPreferred"
}
See Also See Also
-------- --------
- :manual:`Read Preference </reference/read-preference>` in the MongoDB manual
- :phpmethod:`MongoDB\\Client::getReadPreference()` - :phpmethod:`MongoDB\\Client::getReadPreference()`
- :phpmethod:`MongoDB\\Collection::getReadPreference()` - :phpmethod:`MongoDB\\Collection::getReadPreference()`
- :phpmethod:`MongoDB\\GridFS\\Bucket::getReadPreference()` - :phpmethod:`MongoDB\\GridFS\\Bucket::getReadPreference()`
======================================== ===============================
MongoDB\\Database::getTypeMap() MongoDB\\Database::getTypeMap()
======================================== ===============================
.. default-domain:: mongodb .. default-domain:: mongodb
...@@ -15,7 +15,7 @@ Definition ...@@ -15,7 +15,7 @@ Definition
.. phpmethod:: MongoDB\\Database::getTypeMap() .. phpmethod:: MongoDB\\Database::getTypeMap()
Accessor for the type map used by this :phpclass:`Database <MongoDB\\Database>`. Returns the type map for this database.
.. code-block:: php .. code-block:: php
...@@ -24,7 +24,7 @@ Definition ...@@ -24,7 +24,7 @@ Definition
Return Values Return Values
------------- -------------
A type map array. A :ref:`type map <php-type-map>` array.
Example Example
------- -------
...@@ -33,13 +33,17 @@ Example ...@@ -33,13 +33,17 @@ Example
<?php <?php
$typeMap = ['root' => 'array', 'document' => 'array', 'array' => 'array']; $database = (new MongoDB\Client)->selectDatabase('test', [
$database = (new MongoDB\Client)->selectDatabase('test', ['typeMap' => $typeMap]); 'typeMap' => [
'root' => 'array',
'document' => 'array',
'array' => 'array',
],
]);
$database->getTypeMap() === $typeMap; //true
var_dump($database->getTypeMap()); var_dump($database->getTypeMap());
The output will be as follows: The output would then resemble::
array(3) { array(3) {
["root"]=> ["root"]=>
...@@ -53,6 +57,7 @@ The output will be as follows: ...@@ -53,6 +57,7 @@ The output will be as follows:
See Also See Also
-------- --------
- :doc:`/reference/bson`
- :phpmethod:`MongoDB\\Client::getTypeMap()` - :phpmethod:`MongoDB\\Client::getTypeMap()`
- :phpmethod:`MongoDB\\Collection::getTypeMap()` - :phpmethod:`MongoDB\\Collection::getTypeMap()`
- :phpmethod:`MongoDB\\GridFS\\Bucket::getTypeMap()` - :phpmethod:`MongoDB\\GridFS\\Bucket::getTypeMap()`
======================================== ====================================
MongoDB\\Database::getWriteConcern() MongoDB\\Database::getWriteConcern()
======================================== ====================================
.. default-domain:: mongodb .. default-domain:: mongodb
...@@ -15,11 +15,7 @@ Definition ...@@ -15,11 +15,7 @@ Definition
.. phpmethod:: MongoDB\\Database::getWriteConcern() .. phpmethod:: MongoDB\\Database::getWriteConcern()
Accessor for the Returns the write concern for this database.
:php:`MongoDB\\Driver\\WriteConcern <class.mongodb-driver-writeconcern>` used by this
:phpclass:`Database <MongoDB\\Database>`.
Returns the default write concern of this database.
.. code-block:: php .. code-block:: php
...@@ -28,7 +24,8 @@ Definition ...@@ -28,7 +24,8 @@ Definition
Return Values Return Values
------------- -------------
A :php:`MongoDB\\Driver\\WriteConcern <class.mongodb-driver-writeconcern>` object. A :php:`MongoDB\\Driver\\WriteConcern <class.mongodb-driver-writeconcern>`
object.
Example Example
------- -------
...@@ -37,14 +34,26 @@ Example ...@@ -37,14 +34,26 @@ Example
<?php <?php
$writeConcern = new MongoDB\Driver\WriteConcern(2); $database = (new MongoDB\Client)->selectDatabase('test', [
$database = (new MongoDB\Client)->selectDatabase('test', ['writeConcern' => $writeConcern]); 'writeConcern' => new MongoDB\Driver\WriteConcern(1, 0, true),
]);
var_dump($database->getWriteConcern());
The output would then resemble::
$database->getWriteConcern() === $writeConcern; // true object(MongoDB\Driver\WriteConcern)#5 (2) {
["w"]=>
int(1)
["j"]=>
bool(true)
}
See Also See Also
-------- --------
- :manual:`Write Concern </reference/read-concern>` in the MongoDB manual
- :php:`MongoDB\\Driver\\WriteConcern::isDefault() <mongodb-driver-writeconcern.isdefault>`
- :phpmethod:`MongoDB\\Client::getWriteConcern()` - :phpmethod:`MongoDB\\Client::getWriteConcern()`
- :phpmethod:`MongoDB\\Collection::getWriteConcern()` - :phpmethod:`MongoDB\\Collection::getWriteConcern()`
- :phpmethod:`MongoDB\\GridFS\\Bucket::getWriteConcern()` - :phpmethod:`MongoDB\\GridFS\\Bucket::getWriteConcern()`
======================================== =========================================
MongoDB\\GridFS\Bucket::getReadConcern() MongoDB\\GridFS\\Bucket::getReadConcern()
======================================== =========================================
.. default-domain:: mongodb .. default-domain:: mongodb
...@@ -13,13 +13,9 @@ MongoDB\\GridFS\Bucket::getReadConcern() ...@@ -13,13 +13,9 @@ MongoDB\\GridFS\Bucket::getReadConcern()
Definition Definition
---------- ----------
.. phpmethod:: MongoDB\\GridFS\Bucket::getReadConcern() .. phpmethod:: MongoDB\\GridFS\\Bucket::getReadConcern()
Accessor for the Returns the read concern for this GridFS bucket.
:php:`MongoDB\\Driver\\ReadConcern <class.mongodb-driver-readconcern>` used by this
:phpclass:`Bucket <MongoDB\\GridFS\Bucket>`.
Returns the default read concern of this bucket.
.. code-block:: php .. code-block:: php
...@@ -37,14 +33,25 @@ Example ...@@ -37,14 +33,25 @@ Example
<?php <?php
$readConcern = new MongoDB\Driver\ReadConcern(MongoDB\Driver\ReadConcern::MAJORITY); $database = (new MongoDB\Client)->selectDatabase('test');
$bucket = (new MongoDB\Client)->test->selectGridFSBucket(['readConcern' => $readConcern]); $bucket = $database->selectGridFSBucket([
'readConcern' => new MongoDB\Driver\ReadConcern(MongoDB\Driver\ReadConcern::MAJORITY),
]);
var_dump($bucket->getReadConcern());
The output would then resemble::
$bucket->getReadConcern() === $readConcern; // true object(MongoDB\Driver\ReadConcern)#3 (1) {
["level"]=>
string(8) "majority"
}
See Also See Also
-------- --------
- :manual:`Read Concern </reference/read-concern>` in the MongoDB manual
- :php:`MongoDB\\Driver\\ReadConcern::isDefault() <mongodb-driver-readconcern.isdefault>`
- :phpmethod:`MongoDB\\Client::getReadConcern()` - :phpmethod:`MongoDB\\Client::getReadConcern()`
- :phpmethod:`MongoDB\\Collection::getReadConcern()` - :phpmethod:`MongoDB\\Collection::getReadConcern()`
- :phpmethod:`MongoDB\\Database::getReadConcern()` - :phpmethod:`MongoDB\\Database::getReadConcern()`
======================================== ============================================
MongoDB\\GridFS\Bucket::getReadPreference() MongoDB\\GridFS\\Bucket::getReadPreference()
======================================== ============================================
.. default-domain:: mongodb .. default-domain:: mongodb
...@@ -13,13 +13,9 @@ MongoDB\\GridFS\Bucket::getReadPreference() ...@@ -13,13 +13,9 @@ MongoDB\\GridFS\Bucket::getReadPreference()
Definition Definition
---------- ----------
.. phpmethod:: MongoDB\\GridFS\Bucket::getReadPreference() .. phpmethod:: MongoDB\\GridFS\\Bucket::getReadPreference()
Accessor for the Returns the read preference for this GridFS bucket.
:php:`MongoDB\\Driver\\ReadPreference <class.mongodb-driver-readpreference>` used by this
:phpclass:`Bucket <MongoDB\\GridFS\Bucket>`.
Returns the default read preference of this bucket.
.. code-block:: php .. code-block:: php
...@@ -28,7 +24,8 @@ Definition ...@@ -28,7 +24,8 @@ Definition
Return Values Return Values
------------- -------------
A :php:`MongoDB\\Driver\\ReadPreference <class.mongodb-driver-readpreference>` object. A :php:`MongoDB\\Driver\\ReadPreference <class.mongodb-driver-readpreference>`
object.
Example Example
------- -------
...@@ -37,14 +34,24 @@ Example ...@@ -37,14 +34,24 @@ Example
<?php <?php
$readPreference = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::RP_PRIMARY); $database = (new MongoDB\Client)->selectDatabase('test');
$bucket = (new MongoDB\Client)->test->selectGridFSBucket(['readPreference' => $readPreference]); $bucket = $database->selectGridFSBucket([
'readPreference' => new MongoDB\Driver\ReadPreference('primaryPreferred'),
]);
var_dump($bucket->getReadPreference());
The output would then resemble::
$bucket->getReadPreference() === $readPreference; // true object(MongoDB\Driver\ReadPreference)#3 (1) {
["mode"]=>
string(16) "primaryPreferred"
}
See Also See Also
-------- --------
- :manual:`Read Preference </reference/read-preference>` in the MongoDB manual
- :phpmethod:`MongoDB\\Client::getReadPreference()` - :phpmethod:`MongoDB\\Client::getReadPreference()`
- :phpmethod:`MongoDB\\Collection::getReadPreference()` - :phpmethod:`MongoDB\\Collection::getReadPreference()`
- :phpmethod:`MongoDB\\Database::getReadPreference()` - :phpmethod:`MongoDB\\Database::getReadPreference()`
======================================== =====================================
MongoDB\\GridFS\Bucket::getTypeMap() MongoDB\\GridFS\\Bucket::getTypeMap()
======================================== =====================================
.. default-domain:: mongodb .. default-domain:: mongodb
...@@ -13,9 +13,9 @@ MongoDB\\GridFS\Bucket::getTypeMap() ...@@ -13,9 +13,9 @@ MongoDB\\GridFS\Bucket::getTypeMap()
Definition Definition
---------- ----------
.. phpmethod:: MongoDB\\GridFS\Bucket::getTypeMap() .. phpmethod:: MongoDB\\GridFS\\Bucket::getTypeMap()
Accessor for the type map used by this :phpclass:`Bucket <MongoDB\\GridFS\Bucket>`. Returns the type map for this GridFS bucket.
.. code-block:: php .. code-block:: php
...@@ -24,7 +24,7 @@ Definition ...@@ -24,7 +24,7 @@ Definition
Return Values Return Values
------------- -------------
A type map array. A :ref:`type map <php-type-map>` array.
Example Example
------- -------
...@@ -33,13 +33,18 @@ Example ...@@ -33,13 +33,18 @@ Example
<?php <?php
$typeMap = ['root' => 'array', 'document' => 'array', 'array' => 'array']; $database = (new MongoDB\Client)->selectDatabase('test');
$bucket = (new MongoDB\Client)->test->selectGridFSBucket(['typeMap' => $typeMap]); $bucket = $database->selectGridFSBucket([
'typeMap' => [
'root' => 'array',
'document' => 'array',
'array' => 'array',
],
]);
$bucket->getTypeMap() === $typeMap; //true
var_dump($bucket->getTypeMap()); var_dump($bucket->getTypeMap());
The output will be as follows: The output would then resemble::
array(3) { array(3) {
["root"]=> ["root"]=>
...@@ -53,6 +58,7 @@ The output will be as follows: ...@@ -53,6 +58,7 @@ The output will be as follows:
See Also See Also
-------- --------
- :doc:`/reference/bson`
- :phpmethod:`MongoDB\\Client::getTypeMap()` - :phpmethod:`MongoDB\\Client::getTypeMap()`
- :phpmethod:`MongoDB\\Collection::getTypeMap()` - :phpmethod:`MongoDB\\Collection::getTypeMap()`
- :phpmethod:`MongoDB\\Database::getTypeMap()` - :phpmethod:`MongoDB\\Database::getTypeMap()`
======================================== =========================================
MongoDB\\GridFS\Bucket::getWriteConcern() MongoDB\\GridFS\Bucket::getWriteConcern()
======================================== =========================================
.. default-domain:: mongodb .. default-domain:: mongodb
...@@ -13,13 +13,9 @@ MongoDB\\GridFS\Bucket::getWriteConcern() ...@@ -13,13 +13,9 @@ MongoDB\\GridFS\Bucket::getWriteConcern()
Definition Definition
---------- ----------
.. phpmethod:: MongoDB\\GridFS\Bucket::getWriteConcern() .. phpmethod:: MongoDB\\GridFS\\Bucket::getWriteConcern()
Accessor for the Returns the write concern for this GridFS bucket.
:php:`MongoDB\\Driver\\WriteConcern <class.mongodb-driver-writeconcern>` used by this
:phpclass:`Bucket <MongoDB\\GridFS\Bucket>`.
Returns the default write concern of this bucket.
.. code-block:: php .. code-block:: php
...@@ -28,7 +24,8 @@ Definition ...@@ -28,7 +24,8 @@ Definition
Return Values Return Values
------------- -------------
A :php:`MongoDB\\Driver\\WriteConcern <class.mongodb-driver-writeconcern>` object. A :php:`MongoDB\\Driver\\WriteConcern <class.mongodb-driver-writeconcern>`
object.
Example Example
------- -------
...@@ -37,14 +34,27 @@ Example ...@@ -37,14 +34,27 @@ Example
<?php <?php
$writeConcern = new MongoDB\Driver\WriteConcern(2); $database = (new MongoDB\Client)->selectDatabase('test');
$bucket = (new MongoDB\Client)->test->selectGridFSBucket(['writeConcern' => $writeConcern]); $bucket = $database->selectGridFSBucket([
'writeConcern' => new MongoDB\Driver\WriteConcern(1, 0, true),
]);
var_dump($bucket->getWriteConcern());
The output would then resemble::
$bucket->getWriteConcern() === $writeConcern; // true object(MongoDB\Driver\WriteConcern)#3 (2) {
["w"]=>
int(1)
["j"]=>
bool(true)
}
See Also See Also
-------- --------
- :manual:`Write Concern </reference/read-concern>` in the MongoDB manual
- :php:`MongoDB\\Driver\\WriteConcern::isDefault() <mongodb-driver-writeconcern.isdefault>`
- :phpmethod:`MongoDB\\Client::getWriteConcern()` - :phpmethod:`MongoDB\\Client::getWriteConcern()`
- :phpmethod:`MongoDB\\Collection::getWriteConcern()` - :phpmethod:`MongoDB\\Collection::getWriteConcern()`
- :phpmethod:`MongoDB\\Database::getWriteConcern()` - :phpmethod:`MongoDB\\Database::getWriteConcern()`
...@@ -18,7 +18,9 @@ ...@@ -18,7 +18,9 @@
namespace MongoDB; namespace MongoDB;
use MongoDB\Driver\Manager; use MongoDB\Driver\Manager;
use MongoDB\Driver\ReadConcern;
use MongoDB\Driver\ReadPreference; use MongoDB\Driver\ReadPreference;
use MongoDB\Driver\WriteConcern;
use MongoDB\Driver\Exception\RuntimeException as DriverRuntimeException; use MongoDB\Driver\Exception\RuntimeException as DriverRuntimeException;
use MongoDB\Driver\Exception\InvalidArgumentException as DriverInvalidArgumentException; use MongoDB\Driver\Exception\InvalidArgumentException as DriverInvalidArgumentException;
use MongoDB\Exception\InvalidArgumentException; use MongoDB\Exception\InvalidArgumentException;
...@@ -164,9 +166,10 @@ class Client ...@@ -164,9 +166,10 @@ class Client
} }
/** /**
* Return the client default ReadConcern * Return the read concern for this client.
* *
* @return \MongoDB\Driver\ReadConcern * @see http://php.net/manual/en/mongodb-driver-readconcern.isdefault.php
* @return ReadConcern
*/ */
public function getReadConcern() public function getReadConcern()
{ {
...@@ -174,7 +177,7 @@ class Client ...@@ -174,7 +177,7 @@ class Client
} }
/** /**
* Return the client default ReadPreference * Return the read preference for this client.
* *
* @return ReadPreference * @return ReadPreference
*/ */
...@@ -184,7 +187,7 @@ class Client ...@@ -184,7 +187,7 @@ class Client
} }
/** /**
* Return the client default type map * Return the type map for this client.
* *
* @return array * @return array
*/ */
...@@ -194,9 +197,10 @@ class Client ...@@ -194,9 +197,10 @@ class Client
} }
/** /**
* Return the client default WriteConcern * Return the write concern for this client.
* *
* @return \MongoDB\Driver\WriteConcern * @see http://php.net/manual/en/mongodb-driver-writeconcern.isdefault.php
* @return WriteConcern
*/ */
public function getWriteConcern() public function getWriteConcern()
{ {
......
...@@ -706,8 +706,9 @@ class Collection ...@@ -706,8 +706,9 @@ class Collection
} }
/** /**
* Return the collection default ReadConcern * Return the read concern for this collection.
* *
* @see http://php.net/manual/en/mongodb-driver-readconcern.isdefault.php
* @return ReadConcern * @return ReadConcern
*/ */
public function getReadConcern() public function getReadConcern()
...@@ -716,7 +717,7 @@ class Collection ...@@ -716,7 +717,7 @@ class Collection
} }
/** /**
* Return the collection default ReadPreference * Return the read preference for this collection.
* *
* @return ReadPreference * @return ReadPreference
*/ */
...@@ -726,7 +727,7 @@ class Collection ...@@ -726,7 +727,7 @@ class Collection
} }
/** /**
* Return the collection default type map * Return the type map for this collection.
* *
* @return array * @return array
*/ */
...@@ -736,8 +737,9 @@ class Collection ...@@ -736,8 +737,9 @@ class Collection
} }
/** /**
* Return the collection default WriteConcern * Return the write concern for this collection.
* *
* @see http://php.net/manual/en/mongodb-driver-writeconcern.isdefault.php
* @return WriteConcern * @return WriteConcern
*/ */
public function getWriteConcern() public function getWriteConcern()
......
...@@ -282,8 +282,9 @@ class Database ...@@ -282,8 +282,9 @@ class Database
} }
/** /**
* Return the database default ReadConcern * Return the read concern for this database.
* *
* @see http://php.net/manual/en/mongodb-driver-readconcern.isdefault.php
* @return ReadConcern * @return ReadConcern
*/ */
public function getReadConcern() public function getReadConcern()
...@@ -292,7 +293,7 @@ class Database ...@@ -292,7 +293,7 @@ class Database
} }
/** /**
* Return the database default ReadPreference * Return the read preference for this database.
* *
* @return ReadPreference * @return ReadPreference
*/ */
...@@ -302,7 +303,7 @@ class Database ...@@ -302,7 +303,7 @@ class Database
} }
/** /**
* Return the database default type map * Return the type map for this database.
* *
* @return array * @return array
*/ */
...@@ -312,8 +313,9 @@ class Database ...@@ -312,8 +313,9 @@ class Database
} }
/** /**
* Return the database default WriteConcern * Return the write concern for this database.
* *
* @see http://php.net/manual/en/mongodb-driver-writeconcern.isdefault.php
* @return WriteConcern * @return WriteConcern
*/ */
public function getWriteConcern() public function getWriteConcern()
......
...@@ -331,8 +331,9 @@ class Bucket ...@@ -331,8 +331,9 @@ class Bucket
} }
/** /**
* Return the bucket default ReadConcern * Return the read concern for this GridFS bucket.
* *
* @see http://php.net/manual/en/mongodb-driver-readconcern.isdefault.php
* @return ReadConcern * @return ReadConcern
*/ */
public function getReadConcern() public function getReadConcern()
...@@ -341,7 +342,7 @@ class Bucket ...@@ -341,7 +342,7 @@ class Bucket
} }
/** /**
* Return the bucket default ReadPreference * Return the read preference for this GridFS bucket.
* *
* @return ReadPreference * @return ReadPreference
*/ */
...@@ -351,7 +352,7 @@ class Bucket ...@@ -351,7 +352,7 @@ class Bucket
} }
/** /**
* Return the bucket default type map * Return the type map for this GridFS bucket.
* *
* @return array * @return array
*/ */
...@@ -361,8 +362,9 @@ class Bucket ...@@ -361,8 +362,9 @@ class Bucket
} }
/** /**
* Return the bucket default WriteConcern * Return the write concern for this GridFS bucket.
* *
* @see http://php.net/manual/en/mongodb-driver-writeconcern.isdefault.php
* @return WriteConcern * @return WriteConcern
*/ */
public function getWriteConcern() public function getWriteConcern()
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment