Skip to content

Commit 470a904

Browse files
committed
PHPLIB-186: Document getManager() methods
1 parent ec1ae3a commit 470a904

File tree

6 files changed

+103
-1
lines changed

6 files changed

+103
-1
lines changed

docs/reference/class/MongoDBClient.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ Methods
3131
/reference/method/MongoDBClient__construct
3232
/reference/method/MongoDBClient__get
3333
/reference/method/MongoDBClient-dropDatabase
34+
/reference/method/MongoDBClient-getManager
3435
/reference/method/MongoDBClient-listDatabases
3536
/reference/method/MongoDBClient-selectCollection
3637
/reference/method/MongoDBClient-selectDatabase

docs/reference/class/MongoDBCollection.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,7 @@ Methods
7575
/reference/method/MongoDBCollection-findOneAndUpdate
7676
/reference/method/MongoDBCollection-getCollectionName
7777
/reference/method/MongoDBCollection-getDatabaseName
78+
/reference/method/MongoDBCollection-getManager
7879
/reference/method/MongoDBCollection-getNamespace
7980
/reference/method/MongoDBCollection-insertMany
8081
/reference/method/MongoDBCollection-insertOne

docs/reference/class/MongoDBDatabase.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,8 @@ Methods
5050
/reference/method/MongoDBDatabase-createCollection
5151
/reference/method/MongoDBDatabase-drop
5252
/reference/method/MongoDBDatabase-dropCollection
53-
/reference/method/MongoDBDatabase-getDatabaseName
53+
/reference/method/MongoDBDatabase-getDatabaseName
54+
/reference/method/MongoDBDatabase-getManager
5455
/reference/method/MongoDBDatabase-listCollections
5556
/reference/method/MongoDBDatabase-selectCollection
5657
/reference/method/MongoDBDatabase-withOptions
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
=============================
2+
MongoDB\\Client::getManager()
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::getManager()
17+
18+
Accessor for the
19+
:php:`MongoDB\\Driver\\Manager <class.mongodb-driver-manager>` used by this
20+
:phpclass:`Client <MongoDB\\Client>`.
21+
22+
.. code-block:: php
23+
24+
function getManager(): MongoDB\Manager
25+
26+
:returns:
27+
28+
A :php:`MongoDB\\Driver\\Manager <class.mongodb-driver-manager>` object.
29+
30+
.. seealso::
31+
32+
- :phpmethod:`MongoDB\\Collection::getManager()`
33+
- :phpmethod:`MongoDB\\Database::getManager()`
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
=================================
2+
MongoDB\\Collection::getManager()
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::getManager()
17+
18+
Accessor for the
19+
:php:`MongoDB\\Driver\\Manager <class.mongodb-driver-manager>` used by this
20+
:phpclass:`Client <MongoDB\\Collection>`.
21+
22+
.. code-block:: php
23+
24+
function getManager(): MongoDB\Manager
25+
26+
:returns:
27+
28+
A :php:`MongoDB\\Driver\\Manager <class.mongodb-driver-manager>` object.
29+
30+
.. seealso::
31+
32+
- :phpmethod:`MongoDB\\Client::getManager()`
33+
- :phpmethod:`MongoDB\\Database::getManager()`
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
===============================
2+
MongoDB\\Database::getManager()
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\\Database::getManager()
17+
18+
Accessor for the
19+
:php:`MongoDB\\Driver\\Manager <class.mongodb-driver-manager>` used by this
20+
:phpclass:`Client <MongoDB\\Database>`.
21+
22+
.. code-block:: php
23+
24+
function getManager(): MongoDB\Manager
25+
26+
:returns:
27+
28+
A :php:`MongoDB\\Driver\\Manager <class.mongodb-driver-manager>` object.
29+
30+
.. seealso::
31+
32+
- :phpmethod:`MongoDB\\Client::getManager()`
33+
- :phpmethod:`MongoDB\\Collection::getManager()`

0 commit comments

Comments
 (0)