Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Contribute to GitLab
Sign in
Toggle navigation
M
mongo-php-library
Project
Project
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
sinan
mongo-php-library
Commits
de1f5fb2
Commit
de1f5fb2
authored
Sep 13, 2017
by
Jeremy Mikola
Browse files
Options
Browse Files
Download
Plain Diff
Merge pull request #401
parents
9666479a
994e3311
Show whitespace changes
Inline
Side-by-side
Showing
25 changed files
with
1139 additions
and
0 deletions
+1139
-0
bson.txt
docs/reference/bson.txt
+15
-0
MongoDBClient.txt
docs/reference/class/MongoDBClient.txt
+4
-0
MongoDBCollection.txt
docs/reference/class/MongoDBCollection.txt
+4
-0
MongoDBDatabase.txt
docs/reference/class/MongoDBDatabase.txt
+4
-0
MongoDBGridFSBucket.txt
docs/reference/class/MongoDBGridFSBucket.txt
+4
-0
MongoDBClient-getReadConcern.txt
docs/reference/method/MongoDBClient-getReadConcern.txt
+56
-0
MongoDBClient-getReadPreference.txt
docs/reference/method/MongoDBClient-getReadPreference.txt
+56
-0
MongoDBClient-getTypeMap.txt
docs/reference/method/MongoDBClient-getTypeMap.txt
+63
-0
MongoDBClient-getWriteConcern.txt
docs/reference/method/MongoDBClient-getWriteConcern.txt
+57
-0
MongoDBCollection-getReadConcern.txt
docs/reference/method/MongoDBCollection-getReadConcern.txt
+56
-0
MongoDBCollection-getReadPreference.txt
.../reference/method/MongoDBCollection-getReadPreference.txt
+56
-0
MongoDBCollection-getTypeMap.txt
docs/reference/method/MongoDBCollection-getTypeMap.txt
+63
-0
MongoDBCollection-getWriteConcern.txt
docs/reference/method/MongoDBCollection-getWriteConcern.txt
+59
-0
MongoDBDatabase-getReadConcern.txt
docs/reference/method/MongoDBDatabase-getReadConcern.txt
+56
-0
MongoDBDatabase-getReadPreference.txt
docs/reference/method/MongoDBDatabase-getReadPreference.txt
+56
-0
MongoDBDatabase-getTypeMap.txt
docs/reference/method/MongoDBDatabase-getTypeMap.txt
+63
-0
MongoDBDatabase-getWriteConcern.txt
docs/reference/method/MongoDBDatabase-getWriteConcern.txt
+59
-0
MongoDBGridFSBucket-getReadConcern.txt
docs/reference/method/MongoDBGridFSBucket-getReadConcern.txt
+57
-0
MongoDBGridFSBucket-getReadPreference.txt
...eference/method/MongoDBGridFSBucket-getReadPreference.txt
+57
-0
MongoDBGridFSBucket-getTypeMap.txt
docs/reference/method/MongoDBGridFSBucket-getTypeMap.txt
+64
-0
MongoDBGridFSBucket-getWriteConcern.txt
.../reference/method/MongoDBGridFSBucket-getWriteConcern.txt
+60
-0
Client.php
src/Client.php
+44
-0
Collection.php
src/Collection.php
+42
-0
Database.php
src/Database.php
+42
-0
Bucket.php
src/GridFS/Bucket.php
+42
-0
No files found.
docs/reference/bson.txt
View file @
de1f5fb2
...
@@ -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
---------
---------
...
@@ -72,6 +74,19 @@ default:
...
@@ -72,6 +74,19 @@ default:
'root' => 'MongoDB\Model\BSONDocument',
'root' => 'MongoDB\Model\BSONDocument',
]
]
The type map above will convert BSON documents and arrays to
:phpclass:`MongoDB\\Model\\BSONDocument` and
:phpclass:`MongoDB\\Model\\BSONArray` objects, respectively. The ``root`` and
``document`` keys are used to distinguish the top-level BSON document from
embedded documents, respectively.
A type map may specify any class that implements
:php:`MongoDB\\BSON\\Unserializable <mongodb-bson-unserializable>` as well as
``"array"``, ``"stdClass``", and ``"object"`` (``"stdClass``" and ``"object"``
are aliases of one another).
.. seealso:: :php:`Deserialization from BSON <manual/en/mongodb.persistence.deserialization.php>` in the PHP manual
``Persistable`` Classes
``Persistable`` Classes
-----------------------
-----------------------
...
...
docs/reference/class/MongoDBClient.txt
View file @
de1f5fb2
...
@@ -32,6 +32,10 @@ Methods
...
@@ -32,6 +32,10 @@ Methods
/reference/method/MongoDBClient__get
/reference/method/MongoDBClient__get
/reference/method/MongoDBClient-dropDatabase
/reference/method/MongoDBClient-dropDatabase
/reference/method/MongoDBClient-getManager
/reference/method/MongoDBClient-getManager
/reference/method/MongoDBClient-getReadConcern
/reference/method/MongoDBClient-getReadPreference
/reference/method/MongoDBClient-getTypeMap
/reference/method/MongoDBClient-getWriteConcern
/reference/method/MongoDBClient-listDatabases
/reference/method/MongoDBClient-listDatabases
/reference/method/MongoDBClient-selectCollection
/reference/method/MongoDBClient-selectCollection
/reference/method/MongoDBClient-selectDatabase
/reference/method/MongoDBClient-selectDatabase
docs/reference/class/MongoDBCollection.txt
View file @
de1f5fb2
...
@@ -80,6 +80,10 @@ Methods
...
@@ -80,6 +80,10 @@ Methods
/reference/method/MongoDBCollection-getDatabaseName
/reference/method/MongoDBCollection-getDatabaseName
/reference/method/MongoDBCollection-getManager
/reference/method/MongoDBCollection-getManager
/reference/method/MongoDBCollection-getNamespace
/reference/method/MongoDBCollection-getNamespace
/reference/method/MongoDBCollection-getReadConcern
/reference/method/MongoDBCollection-getReadPreference
/reference/method/MongoDBCollection-getTypeMap
/reference/method/MongoDBCollection-getWriteConcern
/reference/method/MongoDBCollection-insertMany
/reference/method/MongoDBCollection-insertMany
/reference/method/MongoDBCollection-insertOne
/reference/method/MongoDBCollection-insertOne
/reference/method/MongoDBCollection-listIndexes
/reference/method/MongoDBCollection-listIndexes
...
...
docs/reference/class/MongoDBDatabase.txt
View file @
de1f5fb2
...
@@ -51,6 +51,10 @@ Methods
...
@@ -51,6 +51,10 @@ Methods
/reference/method/MongoDBDatabase-dropCollection
/reference/method/MongoDBDatabase-dropCollection
/reference/method/MongoDBDatabase-getDatabaseName
/reference/method/MongoDBDatabase-getDatabaseName
/reference/method/MongoDBDatabase-getManager
/reference/method/MongoDBDatabase-getManager
/reference/method/MongoDBDatabase-getReadConcern
/reference/method/MongoDBDatabase-getReadPreference
/reference/method/MongoDBDatabase-getTypeMap
/reference/method/MongoDBDatabase-getWriteConcern
/reference/method/MongoDBDatabase-listCollections
/reference/method/MongoDBDatabase-listCollections
/reference/method/MongoDBDatabase-selectCollection
/reference/method/MongoDBDatabase-selectCollection
/reference/method/MongoDBDatabase-selectGridFSBucket
/reference/method/MongoDBDatabase-selectGridFSBucket
...
...
docs/reference/class/MongoDBGridFSBucket.txt
View file @
de1f5fb2
...
@@ -45,6 +45,10 @@ Methods
...
@@ -45,6 +45,10 @@ Methods
/reference/method/MongoDBGridFSBucket-getDatabaseName
/reference/method/MongoDBGridFSBucket-getDatabaseName
/reference/method/MongoDBGridFSBucket-getFileDocumentForStream
/reference/method/MongoDBGridFSBucket-getFileDocumentForStream
/reference/method/MongoDBGridFSBucket-getFileIdForStream
/reference/method/MongoDBGridFSBucket-getFileIdForStream
/reference/method/MongoDBGridFSBucket-getReadConcern
/reference/method/MongoDBGridFSBucket-getReadPreference
/reference/method/MongoDBGridFSBucket-getTypeMap
/reference/method/MongoDBGridFSBucket-getWriteConcern
/reference/method/MongoDBGridFSBucket-openDownloadStream
/reference/method/MongoDBGridFSBucket-openDownloadStream
/reference/method/MongoDBGridFSBucket-openDownloadStreamByName
/reference/method/MongoDBGridFSBucket-openDownloadStreamByName
/reference/method/MongoDBGridFSBucket-openUploadStream
/reference/method/MongoDBGridFSBucket-openUploadStream
...
...
docs/reference/method/MongoDBClient-getReadConcern.txt
0 → 100644
View file @
de1f5fb2
=================================
MongoDB\\Client::getReadConcern()
=================================
.. default-domain:: mongodb
.. contents:: On this page
:local:
:backlinks: none
:depth: 1
:class: singlecol
Definition
----------
.. phpmethod:: MongoDB\\Client::getReadConcern()
Returns the read concern for this client.
.. code-block:: php
function getReadConcern(): MongoDB\Driver\ReadConcern
Return Values
-------------
A :php:`MongoDB\\Driver\\ReadConcern <class.mongodb-driver-readconcern>` object.
Example
-------
.. code-block:: php
<?php
$client = new MongoDB\Client('mongodb://127.0.0.1/', [
'readConcernLevel' => 'majority',
]);
var_dump($client->getReadConcern());
The output would then resemble::
object(MongoDB\Driver\ReadConcern)#5 (1) {
["level"]=>
string(8) "majority"
}
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\\Database::getReadConcern()`
- :phpmethod:`MongoDB\\GridFS\\Bucket::getReadConcern()`
docs/reference/method/MongoDBClient-getReadPreference.txt
0 → 100644
View file @
de1f5fb2
====================================
MongoDB\\Client::getReadPreference()
====================================
.. default-domain:: mongodb
.. contents:: On this page
:local:
:backlinks: none
:depth: 1
:class: singlecol
Definition
----------
.. phpmethod:: MongoDB\\Client::getReadPreference()
Returns the read preference for this client.
.. code-block:: php
function getReadPreference(): MongoDB\Driver\ReadPreference
Return Values
-------------
A :php:`MongoDB\\Driver\\ReadPreference <class.mongodb-driver-readpreference>`
object.
Example
-------
.. code-block:: php
<?php
$client = new MongoDB\Client('mongodb://127.0.0.1/', [
'readPreference' => 'primaryPreferred',
]);
var_dump($client->getReadPreference());
The output would then resemble::
object(MongoDB\Driver\ReadPreference)#5 (1) {
["mode"]=>
string(16) "primaryPreferred"
}
See Also
--------
- :manual:`Read Preference </reference/read-preference>` in the MongoDB manual
- :phpmethod:`MongoDB\\Collection::getReadPreference()`
- :phpmethod:`MongoDB\\Database::getReadPreference()`
- :phpmethod:`MongoDB\\GridFS\\Bucket::getReadPreference()`
docs/reference/method/MongoDBClient-getTypeMap.txt
0 → 100644
View file @
de1f5fb2
=============================
MongoDB\\Client::getTypeMap()
=============================
.. default-domain:: mongodb
.. contents:: On this page
:local:
:backlinks: none
:depth: 1
:class: singlecol
Definition
----------
.. phpmethod:: MongoDB\\Client::getTypeMap()
Returns the type map for this client.
.. code-block:: php
function getTypeMap(): array
Return Values
-------------
A :ref:`type map <php-type-map>` array.
Example
-------
.. code-block:: php
<?php
$client = new MongoDB\Client('mongodb://127.0.0.1/', [], [
'typeMap' => [
'root' => 'array',
'document' => 'array',
'array' => 'array',
],
]);
var_dump($client->getTypeMap());
The output would then resemble::
array(3) {
["root"]=>
string(5) "array"
["document"]=>
string(5) "array"
["array"]=>
string(5) "array"
}
See Also
--------
- :doc:`/reference/bson`
- :phpmethod:`MongoDB\\Collection::getTypeMap()`
- :phpmethod:`MongoDB\\Database::getTypeMap()`
- :phpmethod:`MongoDB\\GridFS\\Bucket::getTypeMap()`
docs/reference/method/MongoDBClient-getWriteConcern.txt
0 → 100644
View file @
de1f5fb2
==================================
MongoDB\\Client::getWriteConcern()
==================================
.. default-domain:: mongodb
.. contents:: On this page
:local:
:backlinks: none
:depth: 1
:class: singlecol
Definition
----------
.. phpmethod:: MongoDB\\Client::getWriteConcern()
Returns the write concern for this client.
.. code-block:: php
function getWriteConcern(): MongoDB\Driver\WriteConcern
Return Values
-------------
A :php:`MongoDB\\Driver\\WriteConcern <class.mongodb-driver-writeconcern>`
object.
Example
-------
.. code-block:: php
<?php
$client = new MongoDB\Client('mongodb://127.0.0.1/', [
'journal' => true,
]);
var_dump($client->getWriteConcern());
The output would then resemble::
object(MongoDB\Driver\WriteConcern)#4 (1) {
["j"]=>
bool(true)
}
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\\Database::getWriteConcern()`
- :phpmethod:`MongoDB\\GridFS\\Bucket::getWriteConcern()`
docs/reference/method/MongoDBCollection-getReadConcern.txt
0 → 100644
View file @
de1f5fb2
=====================================
MongoDB\\Collection::getReadConcern()
=====================================
.. default-domain:: mongodb
.. contents:: On this page
:local:
:backlinks: none
:depth: 1
:class: singlecol
Definition
----------
.. phpmethod:: MongoDB\\Collection::getReadConcern()
Returns the read concern for this collection.
.. code-block:: php
function getReadConcern(): MongoDB\Driver\ReadConcern
Return Values
-------------
A :php:`MongoDB\\Driver\\ReadConcern <class.mongodb-driver-readconcern>` object.
Example
-------
.. code-block:: php
<?php
$collection = (new MongoDB\Client)->selectCollection('test', 'users', [
'readConcern' => new MongoDB\Driver\ReadConcern(MongoDB\Driver\ReadConcern::MAJORITY),
]);
var_dump($collection->getReadConcern());
The output would then resemble::
object(MongoDB\Driver\ReadConcern)#5 (1) {
["level"]=>
string(8) "majority"
}
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\\Database::getReadConcern()`
- :phpmethod:`MongoDB\\GridFS\\Bucket::getReadConcern()`
docs/reference/method/MongoDBCollection-getReadPreference.txt
0 → 100644
View file @
de1f5fb2
========================================
MongoDB\\Collection::getReadPreference()
========================================
.. default-domain:: mongodb
.. contents:: On this page
:local:
:backlinks: none
:depth: 1
:class: singlecol
Definition
----------
.. phpmethod:: MongoDB\\Collection::getReadPreference()
Returns the read preference for this collection.
.. code-block:: php
function getReadPreference(): MongoDB\Driver\ReadPreference
Return Values
-------------
A :php:`MongoDB\\Driver\\ReadPreference <class.mongodb-driver-readpreference>`
object.
Example
-------
.. code-block:: php
<?php
$collection = (new MongoDB\Client)->selectCollection('test', 'users', [
'readPreference' => new MongoDB\Driver\ReadPreference('primaryPreferred'),
]);
var_dump($collection->getReadPreference());
The output would then resemble::
object(MongoDB\Driver\ReadPreference)#5 (1) {
["mode"]=>
string(16) "primaryPreferred"
}
See Also
--------
- :manual:`Read Preference </reference/read-preference>` in the MongoDB manual
- :phpmethod:`MongoDB\\Client::getReadPreference()`
- :phpmethod:`MongoDB\\Database::getReadPreference()`
- :phpmethod:`MongoDB\\GridFS\\Bucket::getReadPreference()`
docs/reference/method/MongoDBCollection-getTypeMap.txt
0 → 100644
View file @
de1f5fb2
=================================
MongoDB\\Collection::getTypeMap()
=================================
.. default-domain:: mongodb
.. contents:: On this page
:local:
:backlinks: none
:depth: 1
:class: singlecol
Definition
----------
.. phpmethod:: MongoDB\\Collection::getTypeMap()
Returns the type map for this collection.
.. code-block:: php
function getTypeMap(): array
Return Values
-------------
A :ref:`type map <php-type-map>` array.
Example
-------
.. code-block:: php
<?php
$collection = (new MongoDB\Client)->selectCollection('test', 'users', [
'typeMap' => [
'root' => 'array',
'document' => 'array',
'array' => 'array',
],
]);
var_dump($collection->getTypeMap());
The output would then resemble::
array(3) {
["root"]=>
string(5) "array"
["document"]=>
string(5) "array"
["array"]=>
string(5) "array"
}
See Also
--------
- :doc:`/reference/bson`
- :phpmethod:`MongoDB\\Client::getTypeMap()`
- :phpmethod:`MongoDB\\Database::getTypeMap()`
- :phpmethod:`MongoDB\\GridFS\\Bucket::getTypeMap()`
docs/reference/method/MongoDBCollection-getWriteConcern.txt
0 → 100644
View file @
de1f5fb2
======================================
MongoDB\\Collection::getWriteConcern()
======================================
.. default-domain:: mongodb
.. contents:: On this page
:local:
:backlinks: none
:depth: 1
:class: singlecol
Definition
----------
.. phpmethod:: MongoDB\\Collection::getWriteConcern()
Returns the write concern for this collection.
.. code-block:: php
function getWriteConcern(): MongoDB\Driver\WriteConcern
Return Values
-------------
A :php:`MongoDB\\Driver\\WriteConcern <class.mongodb-driver-writeconcern>`
object.
Example
-------
.. code-block:: php
<?php
$collection = (new MongoDB\Client)->selectCollection('test', 'users', [
'writeConcern' => new MongoDB\Driver\WriteConcern(1, 0, true),
]);
var_dump($collection->getWriteConcern());
The output would then resemble::
object(MongoDB\Driver\WriteConcern)#5 (2) {
["w"]=>
int(1)
["j"]=>
bool(true)
}
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\\Database::getWriteConcern()`
- :phpmethod:`MongoDB\\GridFS\\Bucket::getWriteConcern()`
docs/reference/method/MongoDBDatabase-getReadConcern.txt
0 → 100644
View file @
de1f5fb2
===================================
MongoDB\\Database::getReadConcern()
===================================
.. default-domain:: mongodb
.. contents:: On this page
:local:
:backlinks: none
:depth: 1
:class: singlecol
Definition
----------
.. phpmethod:: MongoDB\\Database::getReadConcern()
Returns the read concern for this database.
.. code-block:: php
function getReadConcern(): MongoDB\Driver\ReadConcern
Return Values
-------------
A :php:`MongoDB\\Driver\\ReadConcern <class.mongodb-driver-readconcern>` object.
Example
-------
.. code-block:: php
<?php
$database = (new MongoDB\Client)->selectDatabase('test', [
'readConcern' => new MongoDB\Driver\ReadConcern(MongoDB\Driver\ReadConcern::MAJORITY),
]);
var_dump($database->getReadConcern());
The output would then resemble::
object(MongoDB\Driver\ReadConcern)#5 (1) {
["level"]=>
string(8) "majority"
}
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\\Collection::getReadConcern()`
- :phpmethod:`MongoDB\\GridFS\\Bucket::getReadConcern()`
docs/reference/method/MongoDBDatabase-getReadPreference.txt
0 → 100644
View file @
de1f5fb2
======================================
MongoDB\\Database::getReadPreference()
======================================
.. default-domain:: mongodb
.. contents:: On this page
:local:
:backlinks: none
:depth: 1
:class: singlecol
Definition
----------
.. phpmethod:: MongoDB\\Database::getReadPreference()
Returns the read preference for this database.
.. code-block:: php
function getReadPreference(): MongoDB\Driver\ReadPreference
Return Values
-------------
A :php:`MongoDB\\Driver\\ReadPreference <class.mongodb-driver-readpreference>`
object.
Example
-------
.. code-block:: php
<?php
$database = (new MongoDB\Client)->selectDatabase('test', [
'readPreference' => new MongoDB\Driver\ReadPreference('primaryPreferred'),
]);
var_dump($database->getReadPreference());
The output would then resemble::
object(MongoDB\Driver\ReadPreference)#5 (1) {
["mode"]=>
string(16) "primaryPreferred"
}
See Also
--------
- :manual:`Read Preference </reference/read-preference>` in the MongoDB manual
- :phpmethod:`MongoDB\\Client::getReadPreference()`
- :phpmethod:`MongoDB\\Collection::getReadPreference()`
- :phpmethod:`MongoDB\\GridFS\\Bucket::getReadPreference()`
docs/reference/method/MongoDBDatabase-getTypeMap.txt
0 → 100644
View file @
de1f5fb2
===============================
MongoDB\\Database::getTypeMap()
===============================
.. default-domain:: mongodb
.. contents:: On this page
:local:
:backlinks: none
:depth: 1
:class: singlecol
Definition
----------
.. phpmethod:: MongoDB\\Database::getTypeMap()
Returns the type map for this database.
.. code-block:: php
function getTypeMap(): array
Return Values
-------------
A :ref:`type map <php-type-map>` array.
Example
-------
.. code-block:: php
<?php
$database = (new MongoDB\Client)->selectDatabase('test', [
'typeMap' => [
'root' => 'array',
'document' => 'array',
'array' => 'array',
],
]);
var_dump($database->getTypeMap());
The output would then resemble::
array(3) {
["root"]=>
string(5) "array"
["document"]=>
string(5) "array"
["array"]=>
string(5) "array"
}
See Also
--------
- :doc:`/reference/bson`
- :phpmethod:`MongoDB\\Client::getTypeMap()`
- :phpmethod:`MongoDB\\Collection::getTypeMap()`
- :phpmethod:`MongoDB\\GridFS\\Bucket::getTypeMap()`
docs/reference/method/MongoDBDatabase-getWriteConcern.txt
0 → 100644
View file @
de1f5fb2
====================================
MongoDB\\Database::getWriteConcern()
====================================
.. default-domain:: mongodb
.. contents:: On this page
:local:
:backlinks: none
:depth: 1
:class: singlecol
Definition
----------
.. phpmethod:: MongoDB\\Database::getWriteConcern()
Returns the write concern for this database.
.. code-block:: php
function getWriteConcern(): MongoDB\Driver\WriteConcern
Return Values
-------------
A :php:`MongoDB\\Driver\\WriteConcern <class.mongodb-driver-writeconcern>`
object.
Example
-------
.. code-block:: php
<?php
$database = (new MongoDB\Client)->selectDatabase('test', [
'writeConcern' => new MongoDB\Driver\WriteConcern(1, 0, true),
]);
var_dump($database->getWriteConcern());
The output would then resemble::
object(MongoDB\Driver\WriteConcern)#5 (2) {
["w"]=>
int(1)
["j"]=>
bool(true)
}
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\\Collection::getWriteConcern()`
- :phpmethod:`MongoDB\\GridFS\\Bucket::getWriteConcern()`
docs/reference/method/MongoDBGridFSBucket-getReadConcern.txt
0 → 100644
View file @
de1f5fb2
=========================================
MongoDB\\GridFS\\Bucket::getReadConcern()
=========================================
.. default-domain:: mongodb
.. contents:: On this page
:local:
:backlinks: none
:depth: 1
:class: singlecol
Definition
----------
.. phpmethod:: MongoDB\\GridFS\\Bucket::getReadConcern()
Returns the read concern for this GridFS bucket.
.. code-block:: php
function getReadConcern(): MongoDB\Driver\ReadConcern
Return Values
-------------
A :php:`MongoDB\\Driver\\ReadConcern <class.mongodb-driver-readconcern>` object.
Example
-------
.. code-block:: php
<?php
$database = (new MongoDB\Client)->selectDatabase('test');
$bucket = $database->selectGridFSBucket([
'readConcern' => new MongoDB\Driver\ReadConcern(MongoDB\Driver\ReadConcern::MAJORITY),
]);
var_dump($bucket->getReadConcern());
The output would then resemble::
object(MongoDB\Driver\ReadConcern)#3 (1) {
["level"]=>
string(8) "majority"
}
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\\Collection::getReadConcern()`
- :phpmethod:`MongoDB\\Database::getReadConcern()`
docs/reference/method/MongoDBGridFSBucket-getReadPreference.txt
0 → 100644
View file @
de1f5fb2
============================================
MongoDB\\GridFS\\Bucket::getReadPreference()
============================================
.. default-domain:: mongodb
.. contents:: On this page
:local:
:backlinks: none
:depth: 1
:class: singlecol
Definition
----------
.. phpmethod:: MongoDB\\GridFS\\Bucket::getReadPreference()
Returns the read preference for this GridFS bucket.
.. code-block:: php
function getReadPreference(): MongoDB\Driver\ReadPreference
Return Values
-------------
A :php:`MongoDB\\Driver\\ReadPreference <class.mongodb-driver-readpreference>`
object.
Example
-------
.. code-block:: php
<?php
$database = (new MongoDB\Client)->selectDatabase('test');
$bucket = $database->selectGridFSBucket([
'readPreference' => new MongoDB\Driver\ReadPreference('primaryPreferred'),
]);
var_dump($bucket->getReadPreference());
The output would then resemble::
object(MongoDB\Driver\ReadPreference)#3 (1) {
["mode"]=>
string(16) "primaryPreferred"
}
See Also
--------
- :manual:`Read Preference </reference/read-preference>` in the MongoDB manual
- :phpmethod:`MongoDB\\Client::getReadPreference()`
- :phpmethod:`MongoDB\\Collection::getReadPreference()`
- :phpmethod:`MongoDB\\Database::getReadPreference()`
docs/reference/method/MongoDBGridFSBucket-getTypeMap.txt
0 → 100644
View file @
de1f5fb2
=====================================
MongoDB\\GridFS\\Bucket::getTypeMap()
=====================================
.. default-domain:: mongodb
.. contents:: On this page
:local:
:backlinks: none
:depth: 1
:class: singlecol
Definition
----------
.. phpmethod:: MongoDB\\GridFS\\Bucket::getTypeMap()
Returns the type map for this GridFS bucket.
.. code-block:: php
function getTypeMap(): array
Return Values
-------------
A :ref:`type map <php-type-map>` array.
Example
-------
.. code-block:: php
<?php
$database = (new MongoDB\Client)->selectDatabase('test');
$bucket = $database->selectGridFSBucket([
'typeMap' => [
'root' => 'array',
'document' => 'array',
'array' => 'array',
],
]);
var_dump($bucket->getTypeMap());
The output would then resemble::
array(3) {
["root"]=>
string(5) "array"
["document"]=>
string(5) "array"
["array"]=>
string(5) "array"
}
See Also
--------
- :doc:`/reference/bson`
- :phpmethod:`MongoDB\\Client::getTypeMap()`
- :phpmethod:`MongoDB\\Collection::getTypeMap()`
- :phpmethod:`MongoDB\\Database::getTypeMap()`
docs/reference/method/MongoDBGridFSBucket-getWriteConcern.txt
0 → 100644
View file @
de1f5fb2
=========================================
MongoDB\\GridFS\Bucket::getWriteConcern()
=========================================
.. default-domain:: mongodb
.. contents:: On this page
:local:
:backlinks: none
:depth: 1
:class: singlecol
Definition
----------
.. phpmethod:: MongoDB\\GridFS\\Bucket::getWriteConcern()
Returns the write concern for this GridFS bucket.
.. code-block:: php
function getWriteConcern(): MongoDB\Driver\WriteConcern
Return Values
-------------
A :php:`MongoDB\\Driver\\WriteConcern <class.mongodb-driver-writeconcern>`
object.
Example
-------
.. code-block:: php
<?php
$database = (new MongoDB\Client)->selectDatabase('test');
$bucket = $database->selectGridFSBucket([
'writeConcern' => new MongoDB\Driver\WriteConcern(1, 0, true),
]);
var_dump($bucket->getWriteConcern());
The output would then resemble::
object(MongoDB\Driver\WriteConcern)#3 (2) {
["w"]=>
int(1)
["j"]=>
bool(true)
}
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\\Collection::getWriteConcern()`
- :phpmethod:`MongoDB\\Database::getWriteConcern()`
src/Client.php
View file @
de1f5fb2
...
@@ -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
;
...
@@ -163,6 +165,48 @@ class Client
...
@@ -163,6 +165,48 @@ class Client
return
$this
->
manager
;
return
$this
->
manager
;
}
}
/**
* Return the read concern for this client.
*
* @see http://php.net/manual/en/mongodb-driver-readconcern.isdefault.php
* @return ReadConcern
*/
public
function
getReadConcern
()
{
return
$this
->
manager
->
getReadConcern
();
}
/**
* Return the read preference for this client.
*
* @return ReadPreference
*/
public
function
getReadPreference
()
{
return
$this
->
manager
->
getReadPreference
();
}
/**
* Return the type map for this client.
*
* @return array
*/
public
function
getTypeMap
()
{
return
$this
->
typeMap
;
}
/**
* Return the write concern for this client.
*
* @see http://php.net/manual/en/mongodb-driver-writeconcern.isdefault.php
* @return WriteConcern
*/
public
function
getWriteConcern
()
{
return
$this
->
writeConcern
;
}
/**
/**
* List databases.
* List databases.
*
*
...
...
src/Collection.php
View file @
de1f5fb2
...
@@ -705,6 +705,48 @@ class Collection
...
@@ -705,6 +705,48 @@ class Collection
return
$this
->
databaseName
.
'.'
.
$this
->
collectionName
;
return
$this
->
databaseName
.
'.'
.
$this
->
collectionName
;
}
}
/**
* Return the read concern for this collection.
*
* @see http://php.net/manual/en/mongodb-driver-readconcern.isdefault.php
* @return ReadConcern
*/
public
function
getReadConcern
()
{
return
$this
->
readConcern
;
}
/**
* Return the read preference for this collection.
*
* @return ReadPreference
*/
public
function
getReadPreference
()
{
return
$this
->
readPreference
;
}
/**
* Return the type map for this collection.
*
* @return array
*/
public
function
getTypeMap
()
{
return
$this
->
typeMap
;
}
/**
* Return the write concern for this collection.
*
* @see http://php.net/manual/en/mongodb-driver-writeconcern.isdefault.php
* @return WriteConcern
*/
public
function
getWriteConcern
()
{
return
$this
->
writeConcern
;
}
/**
/**
* Inserts multiple documents.
* Inserts multiple documents.
*
*
...
...
src/Database.php
View file @
de1f5fb2
...
@@ -281,6 +281,48 @@ class Database
...
@@ -281,6 +281,48 @@ class Database
return
$this
->
manager
;
return
$this
->
manager
;
}
}
/**
* Return the read concern for this database.
*
* @see http://php.net/manual/en/mongodb-driver-readconcern.isdefault.php
* @return ReadConcern
*/
public
function
getReadConcern
()
{
return
$this
->
readConcern
;
}
/**
* Return the read preference for this database.
*
* @return ReadPreference
*/
public
function
getReadPreference
()
{
return
$this
->
readPreference
;
}
/**
* Return the type map for this database.
*
* @return array
*/
public
function
getTypeMap
()
{
return
$this
->
typeMap
;
}
/**
* Return the write concern for this database.
*
* @see http://php.net/manual/en/mongodb-driver-writeconcern.isdefault.php
* @return WriteConcern
*/
public
function
getWriteConcern
()
{
return
$this
->
writeConcern
;
}
/**
/**
* Returns information for all collections in this database.
* Returns information for all collections in this database.
*
*
...
...
src/GridFS/Bucket.php
View file @
de1f5fb2
...
@@ -330,6 +330,48 @@ class Bucket
...
@@ -330,6 +330,48 @@ class Bucket
return
$file
->
_id
;
return
$file
->
_id
;
}
}
/**
* Return the read concern for this GridFS bucket.
*
* @see http://php.net/manual/en/mongodb-driver-readconcern.isdefault.php
* @return ReadConcern
*/
public
function
getReadConcern
()
{
return
$this
->
readConcern
;
}
/**
* Return the read preference for this GridFS bucket.
*
* @return ReadPreference
*/
public
function
getReadPreference
()
{
return
$this
->
readPreference
;
}
/**
* Return the type map for this GridFS bucket.
*
* @return array
*/
public
function
getTypeMap
()
{
return
$this
->
typeMap
;
}
/**
* Return the write concern for this GridFS bucket.
*
* @see http://php.net/manual/en/mongodb-driver-writeconcern.isdefault.php
* @return WriteConcern
*/
public
function
getWriteConcern
()
{
return
$this
->
writeConcern
;
}
/**
/**
* Opens a readable stream for reading a GridFS file.
* Opens a readable stream for reading a GridFS file.
*
*
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment