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
bea897bf
Commit
bea897bf
authored
Jul 07, 2017
by
Petr Buchin
Committed by
Jeremy Mikola
Sep 13, 2017
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
PHPLIB-271: Implement accessors for options on core classes
parent
9666479a
Hide whitespace changes
Inline
Side-by-side
Showing
24 changed files
with
1023 additions
and
0 deletions
+1023
-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
+52
-0
MongoDBClient-getReadPreference.txt
docs/reference/method/MongoDBClient-getReadPreference.txt
+59
-0
MongoDBClient-getTypeMap.txt
docs/reference/method/MongoDBClient-getTypeMap.txt
+56
-0
MongoDBClient-getWriteConcern.txt
docs/reference/method/MongoDBClient-getWriteConcern.txt
+50
-0
MongoDBCollection-getReadConcern.txt
docs/reference/method/MongoDBCollection-getReadConcern.txt
+50
-0
MongoDBCollection-getReadPreference.txt
.../reference/method/MongoDBCollection-getReadPreference.txt
+53
-0
MongoDBCollection-getTypeMap.txt
docs/reference/method/MongoDBCollection-getTypeMap.txt
+58
-0
MongoDBCollection-getWriteConcern.txt
docs/reference/method/MongoDBCollection-getWriteConcern.txt
+50
-0
MongoDBDatabase-getReadConcern.txt
docs/reference/method/MongoDBDatabase-getReadConcern.txt
+50
-0
MongoDBDatabase-getReadPreference.txt
docs/reference/method/MongoDBDatabase-getReadPreference.txt
+53
-0
MongoDBDatabase-getTypeMap.txt
docs/reference/method/MongoDBDatabase-getTypeMap.txt
+58
-0
MongoDBDatabase-getWriteConcern.txt
docs/reference/method/MongoDBDatabase-getWriteConcern.txt
+50
-0
MongoDBGridFSBucket-getReadConcern.txt
docs/reference/method/MongoDBGridFSBucket-getReadConcern.txt
+50
-0
MongoDBGridFSBucket-getReadPreference.txt
...eference/method/MongoDBGridFSBucket-getReadPreference.txt
+50
-0
MongoDBGridFSBucket-getTypeMap.txt
docs/reference/method/MongoDBGridFSBucket-getTypeMap.txt
+58
-0
MongoDBGridFSBucket-getWriteConcern.txt
.../reference/method/MongoDBGridFSBucket-getWriteConcern.txt
+50
-0
Client.php
src/Client.php
+40
-0
Collection.php
src/Collection.php
+40
-0
Database.php
src/Database.php
+40
-0
Bucket.php
src/GridFS/Bucket.php
+40
-0
No files found.
docs/reference/class/MongoDBClient.txt
View file @
bea897bf
...
...
@@ -32,6 +32,10 @@ Methods
/reference/method/MongoDBClient__get
/reference/method/MongoDBClient-dropDatabase
/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-selectCollection
/reference/method/MongoDBClient-selectDatabase
docs/reference/class/MongoDBCollection.txt
View file @
bea897bf
...
...
@@ -80,6 +80,10 @@ Methods
/reference/method/MongoDBCollection-getDatabaseName
/reference/method/MongoDBCollection-getManager
/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-insertOne
/reference/method/MongoDBCollection-listIndexes
...
...
docs/reference/class/MongoDBDatabase.txt
View file @
bea897bf
...
...
@@ -51,6 +51,10 @@ Methods
/reference/method/MongoDBDatabase-dropCollection
/reference/method/MongoDBDatabase-getDatabaseName
/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-selectCollection
/reference/method/MongoDBDatabase-selectGridFSBucket
...
...
docs/reference/class/MongoDBGridFSBucket.txt
View file @
bea897bf
...
...
@@ -45,6 +45,10 @@ Methods
/reference/method/MongoDBGridFSBucket-getDatabaseName
/reference/method/MongoDBGridFSBucket-getFileDocumentForStream
/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-openDownloadStreamByName
/reference/method/MongoDBGridFSBucket-openUploadStream
...
...
docs/reference/method/MongoDBClient-getReadConcern.txt
0 → 100644
View file @
bea897bf
========================================
MongoDB\\Client::getReadConcern()
========================================
.. default-domain:: mongodb
.. contents:: On this page
:local:
:backlinks: none
:depth: 1
:class: singlecol
Definition
----------
.. phpmethod:: MongoDB\\Client::getReadConcern()
Accessor for the
: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
function getReadConcern(): MongoDB\Driver\ReadConcern
Return Values
-------------
A :php:`MongoDB\\Driver\\ReadConcern <class.mongodb-driver-readconcern>` object.
Example
-------
.. code-block:: php
<?php
$readConcern = new MongoDB\Driver\ReadConcern(MongoDB\Driver\ReadConcern::MAJORITY);
$client = new MongoDB\Client(
'mongodb://127.0.0.1/',
['readConcernLevel' => MongoDB\Driver\ReadConcern::MAJORITY]
);
MongoDB\Driver\ReadConcern::MAJORITY === $client->getReadConcern()->getLevel(); // true
See Also
--------
- :phpmethod:`MongoDB\\Collection::getReadConcern()`
- :phpmethod:`MongoDB\\Database::getReadConcern()`
docs/reference/method/MongoDBClient-getReadPreference.txt
0 → 100644
View file @
bea897bf
========================================
MongoDB\\Client::getReadPreference()
========================================
.. default-domain:: mongodb
.. contents:: On this page
:local:
:backlinks: none
:depth: 1
:class: singlecol
Definition
----------
.. phpmethod:: MongoDB\\Client::getReadPreference()
Accessor for the
: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
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(
'test',
[
'readPreference' => MongoDB\Driver\ReadPreference::RP_PRIMARY,
'readPreferenceTags' => ['foo' => 'bar', 'spam' => 'egg'],
'maxStalenessSeconds' => 150,
]
);
$readPreference = $client->getReadPreference();
MongoDB\Driver\ReadPreference::RP_PRIMARY === $readPreference->getMode(); // true
['foo' => 'bar', 'spam' => 'egg'] === $readPreference->getTags(); // true
150 = $readPreference->getMaxStalenessSeconds(); // true
See Also
--------
- :phpmethod:`MongoDB\\Collection::getReadPreference()`
- :phpmethod:`MongoDB\\Database::getReadPreference()`
docs/reference/method/MongoDBClient-getTypeMap.txt
0 → 100644
View file @
bea897bf
========================================
MongoDB\\Client::getTypeMap()
========================================
.. default-domain:: mongodb
.. contents:: On this page
:local:
:backlinks: none
:depth: 1
:class: singlecol
Definition
----------
.. phpmethod:: MongoDB\\Client::getTypeMap()
Accessor for the type map used by this :phpclass:`Client <MongoDB\\Client>`.
.. code-block:: php
function getTypeMap(): array
Return Values
-------------
A type map array.
Example
-------
.. code-block:: php
<?php
$typeMap = ['root' => 'array', 'document' => 'array', 'array' => 'array'];
$client = new MongoDB\Client('mongodb://127.0.0.1/', [], ['typeMap' => $typeMap]);
$client->getTypeMap() === $typeMap; //true
var_dump($client->getTypeMap());
The output will be as follows:
array(3) {
["root"]=>
string(5) "array"
["document"]=>
string(5) "array"
["array"]=>
string(5) "array"
}
See Also
--------
- :phpmethod:`MongoDB\\Collection::getTypeMap()`
- :phpmethod:`MongoDB\\Database::getTypeMap()`
docs/reference/method/MongoDBClient-getWriteConcern.txt
0 → 100644
View file @
bea897bf
========================================
MongoDB\\Client::getWriteConcern()
========================================
.. default-domain:: mongodb
.. contents:: On this page
:local:
:backlinks: none
:depth: 1
:class: singlecol
Definition
----------
.. phpmethod:: MongoDB\\Client::getWriteConcern()
Accessor for the
: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
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', ['w' => 1, 'wTimeoutMS' => 100, 'journal' => true]);
$writeConcern = $client->getWriteConcern();
1 === $writeConcern->getW(); // true
100 === $writeConcern->getWtimeout(); // true
$writeConcern->getJournal(); // true
See Also
--------
- :phpmethod:`MongoDB\\Collection::getWriteConcern()`
- :phpmethod:`MongoDB\\Database::getWriteConcern()`
docs/reference/method/MongoDBCollection-getReadConcern.txt
0 → 100644
View file @
bea897bf
========================================
MongoDB\\Collection::getReadConcern()
========================================
.. default-domain:: mongodb
.. contents:: On this page
:local:
:backlinks: none
:depth: 1
:class: singlecol
Definition
----------
.. phpmethod:: MongoDB\\Collection::getReadConcern()
Accessor for the
: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
function getReadConcern(): MongoDB\Driver\ReadConcern
Return Values
-------------
A :php:`MongoDB\\Driver\\ReadConcern <class.mongodb-driver-readconcern>` object.
Example
-------
.. code-block:: php
<?php
$readConcern = new MongoDB\Driver\ReadConcern(MongoDB\Driver\ReadConcern::MAJORITY);
$collection = (new MongoDB\Client)->test->selectCollection('test', ['readConcern' => $readConcern]);
$collection->getReadConcern() === $readConcern; // true
See Also
--------
- :phpmethod:`MongoDB\\Client::getReadConcern()`
- :phpmethod:`MongoDB\\Database::getReadConcern()`
- :phpmethod:`MongoDB\\GridFS\Bucket::getReadConcern()`
docs/reference/method/MongoDBCollection-getReadPreference.txt
0 → 100644
View file @
bea897bf
========================================
MongoDB\\Collection::getReadPreference()
========================================
.. default-domain:: mongodb
.. contents:: On this page
:local:
:backlinks: none
:depth: 1
:class: singlecol
Definition
----------
.. phpmethod:: MongoDB\\Collection::getReadPreference()
Accessor for the
: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
function getReadPreference(): MongoDB\Driver\ReadPreference
Return Values
-------------
A :php:`MongoDB\\Driver\\ReadPreference <class.mongodb-driver-readpreference>` object.
Example
-------
.. code-block:: php
<?php
$readPreference = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::RP_PRIMARY);
$collection = (new MongoDB\Client)->test->selectCollection(
'test',
['readPreference' => $readPreference]
);
$collection->getReadPreference() === $readPreference; // true
See Also
--------
- :phpmethod:`MongoDB\\Client::getReadPreference()`
- :phpmethod:`MongoDB\\Database::getReadPreference()`
- :phpmethod:`MongoDB\\GridFS\\Bucket::getReadPreference()`
docs/reference/method/MongoDBCollection-getTypeMap.txt
0 → 100644
View file @
bea897bf
========================================
MongoDB\\Collection::getTypeMap()
========================================
.. default-domain:: mongodb
.. contents:: On this page
:local:
:backlinks: none
:depth: 1
:class: singlecol
Definition
----------
.. phpmethod:: MongoDB\\Collection::getTypeMap()
Accessor for the type map used by this :phpclass:`Collection <MongoDB\\Collection>`.
.. code-block:: php
function getTypeMap(): array
Return Values
-------------
A type map array.
Example
-------
.. code-block:: php
<?php
$typeMap = ['root' => 'array', 'document' => 'array', 'array' => 'array'];
$collection = (new MongoDB\Client)->test->selectCollection('test', ['typeMap' => $typeMap]);
$collection->getTypeMap() === $typeMap; //true
var_dump($collection->getTypeMap());
The output will be as follows:
array(3) {
["root"]=>
string(5) "array"
["document"]=>
string(5) "array"
["array"]=>
string(5) "array"
}
See Also
--------
- :phpmethod:`MongoDB\\Client::getTypeMap()`
- :phpmethod:`MongoDB\\Database::getTypeMap()`
- :phpmethod:`MongoDB\\GridFS\\Bucket::getTypeMap()`
docs/reference/method/MongoDBCollection-getWriteConcern.txt
0 → 100644
View file @
bea897bf
========================================
MongoDB\\Collection::getWriteConcern()
========================================
.. default-domain:: mongodb
.. contents:: On this page
:local:
:backlinks: none
:depth: 1
:class: singlecol
Definition
----------
.. phpmethod:: MongoDB\\Collection::getWriteConcern()
Accessor for the
: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
function getWriteConcern(): MongoDB\Driver\WriteConcern
Return Values
-------------
A :php:`MongoDB\\Driver\\WriteConcern <class.mongodb-driver-writeconcern>` object.
Example
-------
.. code-block:: php
<?php
$writeConcern = new MongoDB\Driver\WriteConcern(2);
$collection = (new MongoDB\Client)->test->selectCollection('test', ['writeConcern' => $writeConcern]);
$collection->getWriteConcern() === $writeConcern; // true
See Also
--------
- :phpmethod:`MongoDB\\Client::getWriteConcern()`
- :phpmethod:`MongoDB\\Database::getWriteConcern()`
- :phpmethod:`MongoDB\\GridFS\\Bucket::getWriteConcern()`
docs/reference/method/MongoDBDatabase-getReadConcern.txt
0 → 100644
View file @
bea897bf
========================================
MongoDB\\Database::getReadConcern()
========================================
.. default-domain:: mongodb
.. contents:: On this page
:local:
:backlinks: none
:depth: 1
:class: singlecol
Definition
----------
.. phpmethod:: MongoDB\\Database::getReadConcern()
Accessor for the
: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
function getReadConcern(): MongoDB\Driver\ReadConcern
Return Values
-------------
A :php:`MongoDB\\Driver\\ReadConcern <class.mongodb-driver-readconcern>` object.
Example
-------
.. code-block:: php
<?php
$readConcern = new MongoDB\Driver\ReadConcern(MongoDB\Driver\ReadConcern::MAJORITY);
$database = (new MongoDB\Client)->selectDatabase('test', ['readConcern' => $readConcern]);
$database->getReadConcern() === $readConcern; // true
See Also
--------
- :phpmethod:`MongoDB\\Client::getReadConcern()`
- :phpmethod:`MongoDB\\Collection::getReadConcern()`
- :phpmethod:`MongoDB\\GridFS\Bucket::getReadConcern()`
docs/reference/method/MongoDBDatabase-getReadPreference.txt
0 → 100644
View file @
bea897bf
========================================
MongoDB\\Database::getReadPreference()
========================================
.. default-domain:: mongodb
.. contents:: On this page
:local:
:backlinks: none
:depth: 1
:class: singlecol
Definition
----------
.. phpmethod:: MongoDB\\Database::getReadPreference()
Accessor for the
: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
function getReadPreference(): MongoDB\Driver\ReadPreference
Return Values
-------------
A :php:`MongoDB\\Driver\\ReadPreference <class.mongodb-driver-readpreference>` object.
Example
-------
.. code-block:: php
<?php
$readPreference = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::RP_PRIMARY);
$database = (new MongoDB\Client)->selectDatabase(
'test',
['readPreference' => $readPreference]
);
$database->getReadPreference() === $readPreference; // true
See Also
--------
- :phpmethod:`MongoDB\\Client::getReadPreference()`
- :phpmethod:`MongoDB\\Collection::getReadPreference()`
- :phpmethod:`MongoDB\\GridFS\\Bucket::getReadPreference()`
docs/reference/method/MongoDBDatabase-getTypeMap.txt
0 → 100644
View file @
bea897bf
========================================
MongoDB\\Database::getTypeMap()
========================================
.. default-domain:: mongodb
.. contents:: On this page
:local:
:backlinks: none
:depth: 1
:class: singlecol
Definition
----------
.. phpmethod:: MongoDB\\Database::getTypeMap()
Accessor for the type map used by this :phpclass:`Database <MongoDB\\Database>`.
.. code-block:: php
function getTypeMap(): array
Return Values
-------------
A type map array.
Example
-------
.. code-block:: php
<?php
$typeMap = ['root' => 'array', 'document' => 'array', 'array' => 'array'];
$database = (new MongoDB\Client)->selectDatabase('test', ['typeMap' => $typeMap]);
$database->getTypeMap() === $typeMap; //true
var_dump($database->getTypeMap());
The output will be as follows:
array(3) {
["root"]=>
string(5) "array"
["document"]=>
string(5) "array"
["array"]=>
string(5) "array"
}
See Also
--------
- :phpmethod:`MongoDB\\Client::getTypeMap()`
- :phpmethod:`MongoDB\\Collection::getTypeMap()`
- :phpmethod:`MongoDB\\GridFS\\Bucket::getTypeMap()`
docs/reference/method/MongoDBDatabase-getWriteConcern.txt
0 → 100644
View file @
bea897bf
========================================
MongoDB\\Database::getWriteConcern()
========================================
.. default-domain:: mongodb
.. contents:: On this page
:local:
:backlinks: none
:depth: 1
:class: singlecol
Definition
----------
.. phpmethod:: MongoDB\\Database::getWriteConcern()
Accessor for the
: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
function getWriteConcern(): MongoDB\Driver\WriteConcern
Return Values
-------------
A :php:`MongoDB\\Driver\\WriteConcern <class.mongodb-driver-writeconcern>` object.
Example
-------
.. code-block:: php
<?php
$writeConcern = new MongoDB\Driver\WriteConcern(2);
$database = (new MongoDB\Client)->selectDatabase('test', ['writeConcern' => $writeConcern]);
$database->getWriteConcern() === $writeConcern; // true
See Also
--------
- :phpmethod:`MongoDB\\Client::getWriteConcern()`
- :phpmethod:`MongoDB\\Collection::getWriteConcern()`
- :phpmethod:`MongoDB\\GridFS\\Bucket::getWriteConcern()`
docs/reference/method/MongoDBGridFSBucket-getReadConcern.txt
0 → 100644
View file @
bea897bf
========================================
MongoDB\\GridFS\Bucket::getReadConcern()
========================================
.. default-domain:: mongodb
.. contents:: On this page
:local:
:backlinks: none
:depth: 1
:class: singlecol
Definition
----------
.. phpmethod:: MongoDB\\GridFS\Bucket::getReadConcern()
Accessor for the
: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
function getReadConcern(): MongoDB\Driver\ReadConcern
Return Values
-------------
A :php:`MongoDB\\Driver\\ReadConcern <class.mongodb-driver-readconcern>` object.
Example
-------
.. code-block:: php
<?php
$readConcern = new MongoDB\Driver\ReadConcern(MongoDB\Driver\ReadConcern::MAJORITY);
$bucket = (new MongoDB\Client)->test->selectGridFSBucket(['readConcern' => $readConcern]);
$bucket->getReadConcern() === $readConcern; // true
See Also
--------
- :phpmethod:`MongoDB\\Client::getReadConcern()`
- :phpmethod:`MongoDB\\Collection::getReadConcern()`
- :phpmethod:`MongoDB\\Database::getReadConcern()`
docs/reference/method/MongoDBGridFSBucket-getReadPreference.txt
0 → 100644
View file @
bea897bf
========================================
MongoDB\\GridFS\Bucket::getReadPreference()
========================================
.. default-domain:: mongodb
.. contents:: On this page
:local:
:backlinks: none
:depth: 1
:class: singlecol
Definition
----------
.. phpmethod:: MongoDB\\GridFS\Bucket::getReadPreference()
Accessor for the
: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
function getReadPreference(): MongoDB\Driver\ReadPreference
Return Values
-------------
A :php:`MongoDB\\Driver\\ReadPreference <class.mongodb-driver-readpreference>` object.
Example
-------
.. code-block:: php
<?php
$readPreference = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::RP_PRIMARY);
$bucket = (new MongoDB\Client)->test->selectGridFSBucket(['readPreference' => $readPreference]);
$bucket->getReadPreference() === $readPreference; // true
See Also
--------
- :phpmethod:`MongoDB\\Client::getReadPreference()`
- :phpmethod:`MongoDB\\Collection::getReadPreference()`
- :phpmethod:`MongoDB\\Database::getReadPreference()`
docs/reference/method/MongoDBGridFSBucket-getTypeMap.txt
0 → 100644
View file @
bea897bf
========================================
MongoDB\\GridFS\Bucket::getTypeMap()
========================================
.. default-domain:: mongodb
.. contents:: On this page
:local:
:backlinks: none
:depth: 1
:class: singlecol
Definition
----------
.. phpmethod:: MongoDB\\GridFS\Bucket::getTypeMap()
Accessor for the type map used by this :phpclass:`Bucket <MongoDB\\GridFS\Bucket>`.
.. code-block:: php
function getTypeMap(): array
Return Values
-------------
A type map array.
Example
-------
.. code-block:: php
<?php
$typeMap = ['root' => 'array', 'document' => 'array', 'array' => 'array'];
$bucket = (new MongoDB\Client)->test->selectGridFSBucket(['typeMap' => $typeMap]);
$bucket->getTypeMap() === $typeMap; //true
var_dump($bucket->getTypeMap());
The output will be as follows:
array(3) {
["root"]=>
string(5) "array"
["document"]=>
string(5) "array"
["array"]=>
string(5) "array"
}
See Also
--------
- :phpmethod:`MongoDB\\Client::getTypeMap()`
- :phpmethod:`MongoDB\\Collection::getTypeMap()`
- :phpmethod:`MongoDB\\Database::getTypeMap()`
docs/reference/method/MongoDBGridFSBucket-getWriteConcern.txt
0 → 100644
View file @
bea897bf
========================================
MongoDB\\GridFS\Bucket::getWriteConcern()
========================================
.. default-domain:: mongodb
.. contents:: On this page
:local:
:backlinks: none
:depth: 1
:class: singlecol
Definition
----------
.. phpmethod:: MongoDB\\GridFS\Bucket::getWriteConcern()
Accessor for the
: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
function getWriteConcern(): MongoDB\Driver\WriteConcern
Return Values
-------------
A :php:`MongoDB\\Driver\\WriteConcern <class.mongodb-driver-writeconcern>` object.
Example
-------
.. code-block:: php
<?php
$writeConcern = new MongoDB\Driver\WriteConcern(2);
$bucket = (new MongoDB\Client)->test->selectGridFSBucket(['writeConcern' => $writeConcern]);
$bucket->getWriteConcern() === $writeConcern; // true
See Also
--------
- :phpmethod:`MongoDB\\Client::getWriteConcern()`
- :phpmethod:`MongoDB\\Collection::getWriteConcern()`
- :phpmethod:`MongoDB\\Database::getWriteConcern()`
src/Client.php
View file @
bea897bf
...
...
@@ -163,6 +163,46 @@ class Client
return
$this
->
manager
;
}
/**
* Return the client default ReadConcern
*
* @return \MongoDB\Driver\ReadConcern
*/
public
function
getReadConcern
()
{
return
$this
->
manager
->
getReadConcern
();
}
/**
* Return the client default ReadPreference
*
* @return ReadPreference
*/
public
function
getReadPreference
()
{
return
$this
->
manager
->
getReadPreference
();
}
/**
* Return the client default type map
*
* @return array
*/
public
function
getTypeMap
()
{
return
$this
->
typeMap
;
}
/**
* Return the client default WriteConcern
*
* @return \MongoDB\Driver\WriteConcern
*/
public
function
getWriteConcern
()
{
return
$this
->
writeConcern
;
}
/**
* List databases.
*
...
...
src/Collection.php
View file @
bea897bf
...
...
@@ -705,6 +705,46 @@ class Collection
return
$this
->
databaseName
.
'.'
.
$this
->
collectionName
;
}
/**
* Return the collection default ReadConcern
*
* @return ReadConcern
*/
public
function
getReadConcern
()
{
return
$this
->
readConcern
;
}
/**
* Return the collection default ReadPreference
*
* @return ReadPreference
*/
public
function
getReadPreference
()
{
return
$this
->
readPreference
;
}
/**
* Return the collection default type map
*
* @return array
*/
public
function
getTypeMap
()
{
return
$this
->
typeMap
;
}
/**
* Return the collection default WriteConcern
*
* @return WriteConcern
*/
public
function
getWriteConcern
()
{
return
$this
->
writeConcern
;
}
/**
* Inserts multiple documents.
*
...
...
src/Database.php
View file @
bea897bf
...
...
@@ -281,6 +281,46 @@ class Database
return
$this
->
manager
;
}
/**
* Return the database default ReadConcern
*
* @return ReadConcern
*/
public
function
getReadConcern
()
{
return
$this
->
readConcern
;
}
/**
* Return the database default ReadPreference
*
* @return ReadPreference
*/
public
function
getReadPreference
()
{
return
$this
->
readPreference
;
}
/**
* Return the database default type map
*
* @return array
*/
public
function
getTypeMap
()
{
return
$this
->
typeMap
;
}
/**
* Return the database default WriteConcern
*
* @return WriteConcern
*/
public
function
getWriteConcern
()
{
return
$this
->
writeConcern
;
}
/**
* Returns information for all collections in this database.
*
...
...
src/GridFS/Bucket.php
View file @
bea897bf
...
...
@@ -330,6 +330,46 @@ class Bucket
return
$file
->
_id
;
}
/**
* Return the bucket default ReadConcern
*
* @return ReadConcern
*/
public
function
getReadConcern
()
{
return
$this
->
readConcern
;
}
/**
* Return the bucket default ReadPreference
*
* @return ReadPreference
*/
public
function
getReadPreference
()
{
return
$this
->
readPreference
;
}
/**
* Return the bucket default type map
*
* @return array
*/
public
function
getTypeMap
()
{
return
$this
->
typeMap
;
}
/**
* Return the bucket default WriteConcern
*
* @return WriteConcern
*/
public
function
getWriteConcern
()
{
return
$this
->
writeConcern
;
}
/**
* 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