Skip to content

Commit da8a7fb

Browse files
jmikolajmikola
committed
PHPLIB-271: Revise docs for option accessors
1 parent bea897b commit da8a7fb

21 files changed

+308
-205
lines changed

‎docs/reference/bson.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,8 @@ BSON Classes
5050
serialize as a document type (:php:`object casting
5151
<types.type-juggling#language.types.typecasting>` is used internally).
5252

53+
.. _php-type-map:
54+
5355
Type Maps
5456
---------
5557

‎docs/reference/method/MongoDBClient-getReadConcern.txt

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
========================================
1+
=================================
22
MongoDB\\Client::getReadConcern()
3-
========================================
3+
=================================
44

55
.. default-domain:: mongodb
66

@@ -15,11 +15,7 @@ Definition
1515

1616
.. phpmethod:: MongoDB\\Client::getReadConcern()
1717

18-
Accessor for the
19-
:php:`MongoDB\\Driver\\ReadConcern <class.mongodb-driver-readconcern>` used by this
20-
:phpclass:`Client <MongoDB\\Client>`.
21-
22-
Returns the default read concern of this client.
18+
Returns the read concern for this client.
2319

2420
.. code-block:: php
2521

@@ -37,16 +33,24 @@ Example
3733

3834
<?php
3935

40-
$readConcern = new MongoDB\Driver\ReadConcern(MongoDB\Driver\ReadConcern::MAJORITY);
41-
$client = new MongoDB\Client(
42-
'mongodb://127.0.0.1/',
43-
['readConcernLevel' => MongoDB\Driver\ReadConcern::MAJORITY]
44-
);
36+
$client = new MongoDB\Client('mongodb://127.0.0.1/', [
37+
'readConcernLevel' => 'majority',
38+
]);
39+
40+
var_dump($client->getReadConcern());
41+
42+
The output would then resemble::
4543

46-
MongoDB\Driver\ReadConcern::MAJORITY === $client->getReadConcern()->getLevel(); // true
44+
object(MongoDB\Driver\ReadConcern)#5 (1) {
45+
["level"]=>
46+
string(8) "majority"
47+
}
4748

4849
See Also
4950
--------
5051

52+
- :manual:`Read Concern </reference/read-concern>` in the MongoDB manual
53+
- :php:`MongoDB\\Driver\\ReadConcern::isDefault() <mongodb-driver-readconcern.isdefault>`
5154
- :phpmethod:`MongoDB\\Collection::getReadConcern()`
5255
- :phpmethod:`MongoDB\\Database::getReadConcern()`
56+
- :phpmethod:`MongoDB\\GridFS\\Bucket::getReadConcern()`

‎docs/reference/method/MongoDBClient-getReadPreference.txt

Lines changed: 17 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
========================================
1+
====================================
22
MongoDB\\Client::getReadPreference()
3-
========================================
3+
====================================
44

55
.. default-domain:: mongodb
66

@@ -15,11 +15,7 @@ Definition
1515

1616
.. phpmethod:: MongoDB\\Client::getReadPreference()
1717

18-
Accessor for the
19-
:php:`MongoDB\\Driver\\ReadPreference <class.mongodb-driver-readpreference>` used by this
20-
:phpclass:`Client <MongoDB\\Client>`.
21-
22-
Returns the default read preference of this client.
18+
Returns the read preference for this client.
2319

2420
.. code-block:: php
2521

@@ -28,7 +24,8 @@ Definition
2824
Return Values
2925
-------------
3026

31-
A :php:`MongoDB\\Driver\\ReadPreference <class.mongodb-driver-readpreference>` object.
27+
A :php:`MongoDB\\Driver\\ReadPreference <class.mongodb-driver-readpreference>`
28+
object.
3229

3330
Example
3431
-------
@@ -37,23 +34,23 @@ Example
3734

3835
<?php
3936

40-
$client = new MongoDB\Client(
41-
'test',
42-
[
43-
'readPreference' => MongoDB\Driver\ReadPreference::RP_PRIMARY,
44-
'readPreferenceTags' => ['foo' => 'bar', 'spam' => 'egg'],
45-
'maxStalenessSeconds' => 150,
46-
]
47-
);
37+
$client = new MongoDB\Client('mongodb://127.0.0.1/', [
38+
'readPreference' => 'primaryPreferred',
39+
]);
40+
41+
var_dump($client->getReadPreference());
4842

49-
$readPreference = $client->getReadPreference();
43+
The output would then resemble::
5044

51-
MongoDB\Driver\ReadPreference::RP_PRIMARY === $readPreference->getMode(); // true
52-
['foo' => 'bar', 'spam' => 'egg'] === $readPreference->getTags(); // true
53-
150 = $readPreference->getMaxStalenessSeconds(); // true
45+
object(MongoDB\Driver\ReadPreference)#5 (1) {
46+
["mode"]=>
47+
string(16) "primaryPreferred"
48+
}
5449

5550
See Also
5651
--------
5752

53+
- :manual:`Read Preference </reference/read-preference>` in the MongoDB manual
5854
- :phpmethod:`MongoDB\\Collection::getReadPreference()`
5955
- :phpmethod:`MongoDB\\Database::getReadPreference()`
56+
- :phpmethod:`MongoDB\\GridFS\\Bucket::getReadPreference()`

‎docs/reference/method/MongoDBClient-getTypeMap.txt

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
========================================
1+
=============================
22
MongoDB\\Client::getTypeMap()
3-
========================================
3+
=============================
44

55
.. default-domain:: mongodb
66

@@ -15,7 +15,7 @@ Definition
1515

1616
.. phpmethod:: MongoDB\\Client::getTypeMap()
1717

18-
Accessor for the type map used by this :phpclass:`Client <MongoDB\\Client>`.
18+
Returns the type map for this client.
1919

2020
.. code-block:: php
2121

@@ -24,7 +24,7 @@ Definition
2424
Return Values
2525
-------------
2626

27-
A type map array.
27+
A :ref:`type map <php-type-map>` array.
2828

2929
Example
3030
-------
@@ -33,12 +33,17 @@ Example
3333

3434
<?php
3535

36-
$typeMap = ['root' => 'array', 'document' => 'array', 'array' => 'array'];
37-
$client = new MongoDB\Client('mongodb://127.0.0.1/', [], ['typeMap' => $typeMap]);
38-
$client->getTypeMap() === $typeMap; //true
36+
$client = new MongoDB\Client('mongodb://127.0.0.1/', [], [
37+
'typeMap' => [
38+
'root' => 'array',
39+
'document' => 'array',
40+
'array' => 'array',
41+
],
42+
]);
43+
3944
var_dump($client->getTypeMap());
4045

41-
The output will be as follows:
46+
The output would then resemble::
4247

4348
array(3) {
4449
["root"]=>
@@ -52,5 +57,7 @@ The output will be as follows:
5257
See Also
5358
--------
5459

60+
- :doc:`/reference/bson`
5561
- :phpmethod:`MongoDB\\Collection::getTypeMap()`
5662
- :phpmethod:`MongoDB\\Database::getTypeMap()`
63+
- :phpmethod:`MongoDB\\GridFS\\Bucket::getTypeMap()`

‎docs/reference/method/MongoDBClient-getWriteConcern.txt

Lines changed: 20 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
========================================
1+
==================================
22
MongoDB\\Client::getWriteConcern()
3-
========================================
3+
==================================
44

55
.. default-domain:: mongodb
66

@@ -15,11 +15,7 @@ Definition
1515

1616
.. phpmethod:: MongoDB\\Client::getWriteConcern()
1717

18-
Accessor for the
19-
:php:`MongoDB\\Driver\\WriteConcern <class.mongodb-driver-writeconcern>` used by this
20-
:phpclass:`Client <MongoDB\\Client>`.
21-
22-
Returns the default write concern of this client.
18+
Returns the write concern for this client.
2319

2420
.. code-block:: php
2521

@@ -28,7 +24,8 @@ Definition
2824
Return Values
2925
-------------
3026

31-
A :php:`MongoDB\\Driver\\WriteConcern <class.mongodb-driver-writeconcern>` object.
27+
A :php:`MongoDB\\Driver\\WriteConcern <class.mongodb-driver-writeconcern>`
28+
object.
3229

3330
Example
3431
-------
@@ -37,14 +34,24 @@ Example
3734

3835
<?php
3936

40-
$client = new MongoDB\Client('mongodb://127.0.0.1', ['w' => 1, 'wTimeoutMS' => 100, 'journal' => true]);
41-
$writeConcern = $client->getWriteConcern();
42-
1 === $writeConcern->getW(); // true
43-
100 === $writeConcern->getWtimeout(); // true
44-
$writeConcern->getJournal(); // true
37+
$client = new MongoDB\Client('mongodb://127.0.0.1/', [
38+
'journal' => true,
39+
]);
40+
41+
var_dump($client->getWriteConcern());
42+
43+
The output would then resemble::
44+
45+
object(MongoDB\Driver\WriteConcern)#4 (1) {
46+
["j"]=>
47+
bool(true)
48+
}
4549

4650
See Also
4751
--------
4852

53+
- :manual:`Write Concern </reference/read-concern>` in the MongoDB manual
54+
- :php:`MongoDB\\Driver\\WriteConcern::isDefault() <mongodb-driver-writeconcern.isdefault>`
4955
- :phpmethod:`MongoDB\\Collection::getWriteConcern()`
5056
- :phpmethod:`MongoDB\\Database::getWriteConcern()`
57+
- :phpmethod:`MongoDB\\GridFS\\Bucket::getWriteConcern()`

‎docs/reference/method/MongoDBCollection-getReadConcern.txt

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
========================================
1+
=====================================
22
MongoDB\\Collection::getReadConcern()
3-
========================================
3+
=====================================
44

55
.. default-domain:: mongodb
66

@@ -15,11 +15,7 @@ Definition
1515

1616
.. phpmethod:: MongoDB\\Collection::getReadConcern()
1717

18-
Accessor for the
19-
:php:`MongoDB\\Driver\\ReadConcern <class.mongodb-driver-readconcern>` used by this
20-
:phpclass:`Collection <MongoDB\\Collection>`.
21-
22-
Returns the default read concern of this collection.
18+
Returns the read concern for this collection.
2319

2420
.. code-block:: php
2521

@@ -37,14 +33,24 @@ Example
3733

3834
<?php
3935

40-
$readConcern = new MongoDB\Driver\ReadConcern(MongoDB\Driver\ReadConcern::MAJORITY);
41-
$collection = (new MongoDB\Client)->test->selectCollection('test', ['readConcern' => $readConcern]);
36+
$collection = (new MongoDB\Client)->selectCollection('test', 'users', [
37+
'readConcern' => new MongoDB\Driver\ReadConcern(MongoDB\Driver\ReadConcern::MAJORITY),
38+
]);
39+
40+
var_dump($collection->getReadConcern());
41+
42+
The output would then resemble::
4243

43-
$collection->getReadConcern() === $readConcern; // true
44+
object(MongoDB\Driver\ReadConcern)#5 (1) {
45+
["level"]=>
46+
string(8) "majority"
47+
}
4448

4549
See Also
4650
--------
4751

52+
- :manual:`Read Concern </reference/read-concern>` in the MongoDB manual
53+
- :php:`MongoDB\\Driver\\ReadConcern::isDefault() <mongodb-driver-readconcern.isdefault>`
4854
- :phpmethod:`MongoDB\\Client::getReadConcern()`
4955
- :phpmethod:`MongoDB\\Database::getReadConcern()`
50-
- :phpmethod:`MongoDB\\GridFS\Bucket::getReadConcern()`
56+
- :phpmethod:`MongoDB\\GridFS\\Bucket::getReadConcern()`

‎docs/reference/method/MongoDBCollection-getReadPreference.txt

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,7 @@ Definition
1515

1616
.. phpmethod:: MongoDB\\Collection::getReadPreference()
1717

18-
Accessor for the
19-
:php:`MongoDB\\Driver\\ReadPreference <class.mongodb-driver-readpreference>` used by this
20-
:phpclass:`Collection <MongoDB\\Collection>`.
21-
22-
Returns the default read preference of this collection.
18+
Returns the read preference for this collection.
2319

2420
.. code-block:: php
2521

@@ -28,7 +24,8 @@ Definition
2824
Return Values
2925
-------------
3026

31-
A :php:`MongoDB\\Driver\\ReadPreference <class.mongodb-driver-readpreference>` object.
27+
A :php:`MongoDB\\Driver\\ReadPreference <class.mongodb-driver-readpreference>`
28+
object.
3229

3330
Example
3431
-------
@@ -37,17 +34,23 @@ Example
3734

3835
<?php
3936

40-
$readPreference = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::RP_PRIMARY);
41-
$collection = (new MongoDB\Client)->test->selectCollection(
42-
'test',
43-
['readPreference' => $readPreference]
44-
);
37+
$collection = (new MongoDB\Client)->selectCollection('test', 'users', [
38+
'readPreference' => new MongoDB\Driver\ReadPreference('primaryPreferred'),
39+
]);
40+
41+
var_dump($collection->getReadPreference());
42+
43+
The output would then resemble::
4544

46-
$collection->getReadPreference() === $readPreference; // true
45+
object(MongoDB\Driver\ReadPreference)#5 (1) {
46+
["mode"]=>
47+
string(16) "primaryPreferred"
48+
}
4749

4850
See Also
4951
--------
5052

53+
- :manual:`Read Preference </reference/read-preference>` in the MongoDB manual
5154
- :phpmethod:`MongoDB\\Client::getReadPreference()`
5255
- :phpmethod:`MongoDB\\Database::getReadPreference()`
5356
- :phpmethod:`MongoDB\\GridFS\\Bucket::getReadPreference()`

0 commit comments

Comments
 (0)