Skip to content

Commit de1f5fb

Browse files
jmikolajmikola
committed
Merge pull request #401 
2 parents 9666479 + 994e331 commit de1f5fb

25 files changed

+1139
-0
lines changed

‎docs/reference/bson.txt

Lines changed: 15 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

@@ -72,6 +74,19 @@ default:
7274
'root' => 'MongoDB\Model\BSONDocument',
7375
]
7476

77+
The type map above will convert BSON documents and arrays to
78+
:phpclass:`MongoDB\\Model\\BSONDocument` and
79+
:phpclass:`MongoDB\\Model\\BSONArray` objects, respectively. The ``root`` and
80+
``document`` keys are used to distinguish the top-level BSON document from
81+
embedded documents, respectively.
82+
83+
A type map may specify any class that implements
84+
:php:`MongoDB\\BSON\\Unserializable <mongodb-bson-unserializable>` as well as
85+
``"array"``, ``"stdClass``", and ``"object"`` (``"stdClass``" and ``"object"``
86+
are aliases of one another).
87+
88+
.. seealso:: :php:`Deserialization from BSON <manual/en/mongodb.persistence.deserialization.php>` in the PHP manual
89+
7590
``Persistable`` Classes
7691
-----------------------
7792

‎docs/reference/class/MongoDBClient.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,10 @@ Methods
3232
/reference/method/MongoDBClient__get
3333
/reference/method/MongoDBClient-dropDatabase
3434
/reference/method/MongoDBClient-getManager
35+
/reference/method/MongoDBClient-getReadConcern
36+
/reference/method/MongoDBClient-getReadPreference
37+
/reference/method/MongoDBClient-getTypeMap
38+
/reference/method/MongoDBClient-getWriteConcern
3539
/reference/method/MongoDBClient-listDatabases
3640
/reference/method/MongoDBClient-selectCollection
3741
/reference/method/MongoDBClient-selectDatabase

‎docs/reference/class/MongoDBCollection.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,10 @@ Methods
8080
/reference/method/MongoDBCollection-getDatabaseName
8181
/reference/method/MongoDBCollection-getManager
8282
/reference/method/MongoDBCollection-getNamespace
83+
/reference/method/MongoDBCollection-getReadConcern
84+
/reference/method/MongoDBCollection-getReadPreference
85+
/reference/method/MongoDBCollection-getTypeMap
86+
/reference/method/MongoDBCollection-getWriteConcern
8387
/reference/method/MongoDBCollection-insertMany
8488
/reference/method/MongoDBCollection-insertOne
8589
/reference/method/MongoDBCollection-listIndexes

‎docs/reference/class/MongoDBDatabase.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,10 @@ Methods
5151
/reference/method/MongoDBDatabase-dropCollection
5252
/reference/method/MongoDBDatabase-getDatabaseName
5353
/reference/method/MongoDBDatabase-getManager
54+
/reference/method/MongoDBDatabase-getReadConcern
55+
/reference/method/MongoDBDatabase-getReadPreference
56+
/reference/method/MongoDBDatabase-getTypeMap
57+
/reference/method/MongoDBDatabase-getWriteConcern
5458
/reference/method/MongoDBDatabase-listCollections
5559
/reference/method/MongoDBDatabase-selectCollection
5660
/reference/method/MongoDBDatabase-selectGridFSBucket

‎docs/reference/class/MongoDBGridFSBucket.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,10 @@ Methods
4545
/reference/method/MongoDBGridFSBucket-getDatabaseName
4646
/reference/method/MongoDBGridFSBucket-getFileDocumentForStream
4747
/reference/method/MongoDBGridFSBucket-getFileIdForStream
48+
/reference/method/MongoDBGridFSBucket-getReadConcern
49+
/reference/method/MongoDBGridFSBucket-getReadPreference
50+
/reference/method/MongoDBGridFSBucket-getTypeMap
51+
/reference/method/MongoDBGridFSBucket-getWriteConcern
4852
/reference/method/MongoDBGridFSBucket-openDownloadStream
4953
/reference/method/MongoDBGridFSBucket-openDownloadStreamByName
5054
/reference/method/MongoDBGridFSBucket-openUploadStream

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

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
=================================
2+
MongoDB\\Client::getReadConcern()
3+
=================================
4+
5+
.. default-domain:: mongodb
6+
7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 1
11+
:class: singlecol
12+
13+
Definition
14+
----------
15+
16+
.. phpmethod:: MongoDB\\Client::getReadConcern()
17+
18+
Returns the read concern for this client.
19+
20+
.. code-block:: php
21+
22+
function getReadConcern(): MongoDB\Driver\ReadConcern
23+
24+
Return Values
25+
-------------
26+
27+
A :php:`MongoDB\\Driver\\ReadConcern <class.mongodb-driver-readconcern>` object.
28+
29+
Example
30+
-------
31+
32+
.. code-block:: php
33+
34+
<?php
35+
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::
43+
44+
object(MongoDB\Driver\ReadConcern)#5 (1) {
45+
["level"]=>
46+
string(8) "majority"
47+
}
48+
49+
See Also
50+
--------
51+
52+
- :manual:`Read Concern </reference/read-concern>` in the MongoDB manual
53+
- :php:`MongoDB\\Driver\\ReadConcern::isDefault() <mongodb-driver-readconcern.isdefault>`
54+
- :phpmethod:`MongoDB\\Collection::getReadConcern()`
55+
- :phpmethod:`MongoDB\\Database::getReadConcern()`
56+
- :phpmethod:`MongoDB\\GridFS\\Bucket::getReadConcern()`

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

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
====================================
2+
MongoDB\\Client::getReadPreference()
3+
====================================
4+
5+
.. default-domain:: mongodb
6+
7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 1
11+
:class: singlecol
12+
13+
Definition
14+
----------
15+
16+
.. phpmethod:: MongoDB\\Client::getReadPreference()
17+
18+
Returns the read preference for this client.
19+
20+
.. code-block:: php
21+
22+
function getReadPreference(): MongoDB\Driver\ReadPreference
23+
24+
Return Values
25+
-------------
26+
27+
A :php:`MongoDB\\Driver\\ReadPreference <class.mongodb-driver-readpreference>`
28+
object.
29+
30+
Example
31+
-------
32+
33+
.. code-block:: php
34+
35+
<?php
36+
37+
$client = new MongoDB\Client('mongodb://127.0.0.1/', [
38+
'readPreference' => 'primaryPreferred',
39+
]);
40+
41+
var_dump($client->getReadPreference());
42+
43+
The output would then resemble::
44+
45+
object(MongoDB\Driver\ReadPreference)#5 (1) {
46+
["mode"]=>
47+
string(16) "primaryPreferred"
48+
}
49+
50+
See Also
51+
--------
52+
53+
- :manual:`Read Preference </reference/read-preference>` in the MongoDB manual
54+
- :phpmethod:`MongoDB\\Collection::getReadPreference()`
55+
- :phpmethod:`MongoDB\\Database::getReadPreference()`
56+
- :phpmethod:`MongoDB\\GridFS\\Bucket::getReadPreference()`

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

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
=============================
2+
MongoDB\\Client::getTypeMap()
3+
=============================
4+
5+
.. default-domain:: mongodb
6+
7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 1
11+
:class: singlecol
12+
13+
Definition
14+
----------
15+
16+
.. phpmethod:: MongoDB\\Client::getTypeMap()
17+
18+
Returns the type map for this client.
19+
20+
.. code-block:: php
21+
22+
function getTypeMap(): array
23+
24+
Return Values
25+
-------------
26+
27+
A :ref:`type map <php-type-map>` array.
28+
29+
Example
30+
-------
31+
32+
.. code-block:: php
33+
34+
<?php
35+
36+
$client = new MongoDB\Client('mongodb://127.0.0.1/', [], [
37+
'typeMap' => [
38+
'root' => 'array',
39+
'document' => 'array',
40+
'array' => 'array',
41+
],
42+
]);
43+
44+
var_dump($client->getTypeMap());
45+
46+
The output would then resemble::
47+
48+
array(3) {
49+
["root"]=>
50+
string(5) "array"
51+
["document"]=>
52+
string(5) "array"
53+
["array"]=>
54+
string(5) "array"
55+
}
56+
57+
See Also
58+
--------
59+
60+
- :doc:`/reference/bson`
61+
- :phpmethod:`MongoDB\\Collection::getTypeMap()`
62+
- :phpmethod:`MongoDB\\Database::getTypeMap()`
63+
- :phpmethod:`MongoDB\\GridFS\\Bucket::getTypeMap()`

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

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
==================================
2+
MongoDB\\Client::getWriteConcern()
3+
==================================
4+
5+
.. default-domain:: mongodb
6+
7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 1
11+
:class: singlecol
12+
13+
Definition
14+
----------
15+
16+
.. phpmethod:: MongoDB\\Client::getWriteConcern()
17+
18+
Returns the write concern for this client.
19+
20+
.. code-block:: php
21+
22+
function getWriteConcern(): MongoDB\Driver\WriteConcern
23+
24+
Return Values
25+
-------------
26+
27+
A :php:`MongoDB\\Driver\\WriteConcern <class.mongodb-driver-writeconcern>`
28+
object.
29+
30+
Example
31+
-------
32+
33+
.. code-block:: php
34+
35+
<?php
36+
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+
}
49+
50+
See Also
51+
--------
52+
53+
- :manual:`Write Concern </reference/read-concern>` in the MongoDB manual
54+
- :php:`MongoDB\\Driver\\WriteConcern::isDefault() <mongodb-driver-writeconcern.isdefault>`
55+
- :phpmethod:`MongoDB\\Collection::getWriteConcern()`
56+
- :phpmethod:`MongoDB\\Database::getWriteConcern()`
57+
- :phpmethod:`MongoDB\\GridFS\\Bucket::getWriteConcern()`

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

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
=====================================
2+
MongoDB\\Collection::getReadConcern()
3+
=====================================
4+
5+
.. default-domain:: mongodb
6+
7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 1
11+
:class: singlecol
12+
13+
Definition
14+
----------
15+
16+
.. phpmethod:: MongoDB\\Collection::getReadConcern()
17+
18+
Returns the read concern for this collection.
19+
20+
.. code-block:: php
21+
22+
function getReadConcern(): MongoDB\Driver\ReadConcern
23+
24+
Return Values
25+
-------------
26+
27+
A :php:`MongoDB\\Driver\\ReadConcern <class.mongodb-driver-readconcern>` object.
28+
29+
Example
30+
-------
31+
32+
.. code-block:: php
33+
34+
<?php
35+
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::
43+
44+
object(MongoDB\Driver\ReadConcern)#5 (1) {
45+
["level"]=>
46+
string(8) "majority"
47+
}
48+
49+
See Also
50+
--------
51+
52+
- :manual:`Read Concern </reference/read-concern>` in the MongoDB manual
53+
- :php:`MongoDB\\Driver\\ReadConcern::isDefault() <mongodb-driver-readconcern.isdefault>`
54+
- :phpmethod:`MongoDB\\Client::getReadConcern()`
55+
- :phpmethod:`MongoDB\\Database::getReadConcern()`
56+
- :phpmethod:`MongoDB\\GridFS\\Bucket::getReadConcern()`

0 commit comments

Comments
 (0)