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
3cc57327
Commit
3cc57327
authored
Nov 15, 2016
by
Jeremy Mikola
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
PHPLIB-234: Use "Return Values" section headings
parent
72884721
Hide whitespace changes
Inline
Side-by-side
Showing
53 changed files
with
198 additions
and
156 deletions
+198
-156
MongoDBClient-dropDatabase.txt
docs/reference/method/MongoDBClient-dropDatabase.txt
+5
-4
MongoDBClient-getManager.txt
docs/reference/method/MongoDBClient-getManager.txt
+3
-2
MongoDBClient-listDatabases.txt
docs/reference/method/MongoDBClient-listDatabases.txt
+5
-4
MongoDBClient-selectCollection.txt
docs/reference/method/MongoDBClient-selectCollection.txt
+3
-2
MongoDBClient-selectDatabase.txt
docs/reference/method/MongoDBClient-selectDatabase.txt
+3
-2
MongoDBClient__get.txt
docs/reference/method/MongoDBClient__get.txt
+3
-2
MongoDBCollection-aggregate.txt
docs/reference/method/MongoDBCollection-aggregate.txt
+5
-4
MongoDBCollection-bulkWrite.txt
docs/reference/method/MongoDBCollection-bulkWrite.txt
+4
-4
MongoDBCollection-count.txt
docs/reference/method/MongoDBCollection-count.txt
+3
-2
MongoDBCollection-createIndex.txt
docs/reference/method/MongoDBCollection-createIndex.txt
+3
-2
MongoDBCollection-createIndexes.txt
docs/reference/method/MongoDBCollection-createIndexes.txt
+3
-2
MongoDBCollection-deleteMany.txt
docs/reference/method/MongoDBCollection-deleteMany.txt
+4
-4
MongoDBCollection-deleteOne.txt
docs/reference/method/MongoDBCollection-deleteOne.txt
+4
-4
MongoDBCollection-distinct.txt
docs/reference/method/MongoDBCollection-distinct.txt
+3
-2
MongoDBCollection-drop.txt
docs/reference/method/MongoDBCollection-drop.txt
+5
-4
MongoDBCollection-dropIndex.txt
docs/reference/method/MongoDBCollection-dropIndex.txt
+5
-4
MongoDBCollection-dropIndexes.txt
docs/reference/method/MongoDBCollection-dropIndexes.txt
+5
-4
MongoDBCollection-find.txt
docs/reference/method/MongoDBCollection-find.txt
+3
-2
MongoDBCollection-findOne.txt
docs/reference/method/MongoDBCollection-findOne.txt
+5
-4
MongoDBCollection-findOneAndDelete.txt
docs/reference/method/MongoDBCollection-findOneAndDelete.txt
+4
-3
MongoDBCollection-findOneAndReplace.txt
.../reference/method/MongoDBCollection-findOneAndReplace.txt
+5
-5
MongoDBCollection-findOneAndUpdate.txt
docs/reference/method/MongoDBCollection-findOneAndUpdate.txt
+5
-5
MongoDBCollection-getCollectionName.txt
.../reference/method/MongoDBCollection-getCollectionName.txt
+3
-2
MongoDBCollection-getDatabaseName.txt
docs/reference/method/MongoDBCollection-getDatabaseName.txt
+3
-2
MongoDBCollection-getManager.txt
docs/reference/method/MongoDBCollection-getManager.txt
+3
-2
MongoDBCollection-getNamespace.txt
docs/reference/method/MongoDBCollection-getNamespace.txt
+3
-2
MongoDBCollection-insertMany.txt
docs/reference/method/MongoDBCollection-insertMany.txt
+4
-4
MongoDBCollection-insertOne.txt
docs/reference/method/MongoDBCollection-insertOne.txt
+4
-4
MongoDBCollection-listIndexes.txt
docs/reference/method/MongoDBCollection-listIndexes.txt
+4
-4
MongoDBCollection-replaceOne.txt
docs/reference/method/MongoDBCollection-replaceOne.txt
+4
-4
MongoDBCollection-updateMany.txt
docs/reference/method/MongoDBCollection-updateMany.txt
+4
-4
MongoDBCollection-updateOne.txt
docs/reference/method/MongoDBCollection-updateOne.txt
+4
-4
MongoDBCollection-withOptions.txt
docs/reference/method/MongoDBCollection-withOptions.txt
+3
-2
MongoDBDatabase-command.txt
docs/reference/method/MongoDBDatabase-command.txt
+3
-2
MongoDBDatabase-createCollection.txt
docs/reference/method/MongoDBDatabase-createCollection.txt
+4
-3
MongoDBDatabase-drop.txt
docs/reference/method/MongoDBDatabase-drop.txt
+5
-4
MongoDBDatabase-dropCollection.txt
docs/reference/method/MongoDBDatabase-dropCollection.txt
+5
-4
MongoDBDatabase-getDatabaseName.txt
docs/reference/method/MongoDBDatabase-getDatabaseName.txt
+3
-2
MongoDBDatabase-getManager.txt
docs/reference/method/MongoDBDatabase-getManager.txt
+3
-2
MongoDBDatabase-listCollections.txt
docs/reference/method/MongoDBDatabase-listCollections.txt
+5
-4
MongoDBDatabase-selectCollection.txt
docs/reference/method/MongoDBDatabase-selectCollection.txt
+3
-2
MongoDBDatabase-selectGridFSBucket.txt
docs/reference/method/MongoDBDatabase-selectGridFSBucket.txt
+3
-2
MongoDBDatabase-withOptions.txt
docs/reference/method/MongoDBDatabase-withOptions.txt
+3
-2
MongoDBDatabase__get.txt
docs/reference/method/MongoDBDatabase__get.txt
+3
-2
MongoDBGridFSBucket-find.txt
docs/reference/method/MongoDBGridFSBucket-find.txt
+3
-2
MongoDBGridFSBucket-getBucketName.txt
docs/reference/method/MongoDBGridFSBucket-getBucketName.txt
+3
-2
MongoDBGridFSBucket-getDatabaseName.txt
.../reference/method/MongoDBGridFSBucket-getDatabaseName.txt
+3
-2
MongoDBGridFSBucket-getFileDocumentForStream.txt
...e/method/MongoDBGridFSBucket-getFileDocumentForStream.txt
+3
-2
MongoDBGridFSBucket-getFileIdForStream.txt
...ference/method/MongoDBGridFSBucket-getFileIdForStream.txt
+4
-3
MongoDBGridFSBucket-openDownloadStream.txt
...ference/method/MongoDBGridFSBucket-openDownloadStream.txt
+3
-2
MongoDBGridFSBucket-openDownloadStreamByName.txt
...e/method/MongoDBGridFSBucket-openDownloadStreamByName.txt
+3
-2
MongoDBGridFSBucket-openUploadStream.txt
...reference/method/MongoDBGridFSBucket-openUploadStream.txt
+3
-2
MongoDBGridFSBucket-uploadFromStream.txt
...reference/method/MongoDBGridFSBucket-uploadFromStream.txt
+6
-5
No files found.
docs/reference/method/MongoDBClient-dropDatabase.txt
View file @
3cc57327
...
@@ -29,11 +29,12 @@ Definition
...
@@ -29,11 +29,12 @@ Definition
.. include:: /includes/apiargs/MongoDBClient-method-dropDatabase-option.rst
.. include:: /includes/apiargs/MongoDBClient-method-dropDatabase-option.rst
:returns:
Return Values
-------------
An array or object with the result document of the :manual:`dropDatabase
An array or object with the result document of the :manual:`dropDatabase
</reference/command/dropDatabase>` command. The return type will depend on
</reference/command/dropDatabase>` command. The return type will depend on the
the
``typeMap`` option.
``typeMap`` option.
Example
Example
-------
-------
...
...
docs/reference/method/MongoDBClient-getManager.txt
View file @
3cc57327
...
@@ -23,9 +23,10 @@ Definition
...
@@ -23,9 +23,10 @@ Definition
function getManager(): MongoDB\Manager
function getManager(): MongoDB\Manager
:returns:
Return Values
-------------
A :php:`MongoDB\\Driver\\Manager <class.mongodb-driver-manager>` object.
A :php:`MongoDB\\Driver\\Manager <class.mongodb-driver-manager>` object.
See Also
See Also
--------
--------
...
...
docs/reference/method/MongoDBClient-listDatabases.txt
View file @
3cc57327
...
@@ -29,11 +29,12 @@ Definition
...
@@ -29,11 +29,12 @@ Definition
.. include:: /includes/apiargs/MongoDBClient-method-listDatabases-option.rst
.. include:: /includes/apiargs/MongoDBClient-method-listDatabases-option.rst
:returns:
Return Values
-------------
A traversable :phpclass:`MongoDB\\Model\\DatabaseInfoIterator`, which
A traversable :phpclass:`MongoDB\\Model\\DatabaseInfoIterator`, which contains
contains an :phpclass:`MongoDB\\Model\\DatabaseInfo` object for each
a :phpclass:`MongoDB\\Model\\DatabaseInfo` object for each database on the
database on the
server.
server.
Example
Example
-------
-------
...
...
docs/reference/method/MongoDBClient-selectCollection.txt
View file @
3cc57327
...
@@ -29,9 +29,10 @@ Definition
...
@@ -29,9 +29,10 @@ Definition
.. include:: /includes/apiargs/MongoDBClient-method-selectCollection-option.rst
.. include:: /includes/apiargs/MongoDBClient-method-selectCollection-option.rst
:returns:
Return Values
-------------
A :phpclass:`MongoDB\\Collection` object.
A :phpclass:`MongoDB\\Collection` object.
Behavior
Behavior
--------
--------
...
...
docs/reference/method/MongoDBClient-selectDatabase.txt
View file @
3cc57327
...
@@ -29,9 +29,10 @@ Definition
...
@@ -29,9 +29,10 @@ Definition
.. include:: /includes/apiargs/MongoDBClient-method-selectDatabase-option.rst
.. include:: /includes/apiargs/MongoDBClient-method-selectDatabase-option.rst
:returns:
Return Values
-------------
A :phpclass:`MongoDB\\Database` object.
A :phpclass:`MongoDB\\Database` object.
Behavior
Behavior
--------
--------
...
...
docs/reference/method/MongoDBClient__get.txt
View file @
3cc57327
...
@@ -27,9 +27,10 @@ Definition
...
@@ -27,9 +27,10 @@ Definition
.. include:: /includes/apiargs/MongoDBClient-method-get-param.rst
.. include:: /includes/apiargs/MongoDBClient-method-get-param.rst
:returns:
Return Values
-------------
A :phpclass:`MongoDB\\Database` object.
A :phpclass:`MongoDB\\Database` object.
Behavior
Behavior
--------
--------
...
...
docs/reference/method/MongoDBCollection-aggregate.txt
View file @
3cc57327
...
@@ -30,11 +30,12 @@ Definition
...
@@ -30,11 +30,12 @@ Definition
.. include:: /includes/apiargs/MongoDBCollection-method-aggregate-option.rst
.. include:: /includes/apiargs/MongoDBCollection-method-aggregate-option.rst
:returns:
Return Values
-------------
A :php:`MongoDB\\Driver\\Cursor <class.mongodb-driver-cursor>` or
A :php:`MongoDB\\Driver\\Cursor <class.mongodb-driver-cursor>` or
:php:`ArrayIterator <arrayiterator>` object. In both cases, the return
:php:`ArrayIterator <arrayiterator>` object. In both cases, the return value
value
will be :php:`Traversable <traversable>`.
will be :php:`Traversable <traversable>`.
.. _php-agg-method-behavior:
.. _php-agg-method-behavior:
...
...
docs/reference/method/MongoDBCollection-bulkWrite.txt
View file @
3cc57327
...
@@ -29,11 +29,11 @@ Definition
...
@@ -29,11 +29,11 @@ Definition
.. include:: /includes/apiargs/MongoDBCollection-method-bulkWrite-option.rst
.. include:: /includes/apiargs/MongoDBCollection-method-bulkWrite-option.rst
:returns:
Return Values
-------------
A :phpclass:`MongoDB\\BulkWriteResult` object, which encapsulates a
A :phpclass:`MongoDB\\BulkWriteResult` object, which encapsulates a
:php:`MongoDB\\Driver\\WriteResult <class.mongodb-driver-writeresult>`
:php:`MongoDB\\Driver\\WriteResult <class.mongodb-driver-writeresult>` object.
object.
.. todo: add output and examples
.. todo: add output and examples
...
...
docs/reference/method/MongoDBCollection-count.txt
View file @
3cc57327
...
@@ -29,9 +29,10 @@ Definition
...
@@ -29,9 +29,10 @@ Definition
.. include:: /includes/apiargs/MongoDBCollection-method-count-option.rst
.. include:: /includes/apiargs/MongoDBCollection-method-count-option.rst
:returns:
Return Values
-------------
The number of documents matching the filter criteria.
The number of documents matching the filter criteria.
.. todo: add output and examples
.. todo: add output and examples
...
...
docs/reference/method/MongoDBCollection-createIndex.txt
View file @
3cc57327
...
@@ -34,9 +34,10 @@ Definition
...
@@ -34,9 +34,10 @@ Definition
:manual:`createIndexes </reference/command/createIndexes>` command reference
:manual:`createIndexes </reference/command/createIndexes>` command reference
in the MongoDB manual.
in the MongoDB manual.
:returns:
Return Values
-------------
The name of the created index as a string.
The name of the created index as a string.
Examples
Examples
--------
--------
...
...
docs/reference/method/MongoDBCollection-createIndexes.txt
View file @
3cc57327
...
@@ -29,9 +29,10 @@ Definition
...
@@ -29,9 +29,10 @@ Definition
.. include:: /includes/apiargs/MongoDBCollection-method-createIndexes-option.rst
.. include:: /includes/apiargs/MongoDBCollection-method-createIndexes-option.rst
:returns:
Return Values
-------------
The names of the created indexes as an array of strings.
The names of the created indexes as an array of strings.
``$indexes`` parameter
``$indexes`` parameter
----------------------
----------------------
...
...
docs/reference/method/MongoDBCollection-deleteMany.txt
View file @
3cc57327
...
@@ -29,11 +29,11 @@ Definition
...
@@ -29,11 +29,11 @@ Definition
.. include:: /includes/apiargs/MongoDBCollection-method-deleteMany-option.rst
.. include:: /includes/apiargs/MongoDBCollection-method-deleteMany-option.rst
:returns:
Return Values
-------------
A :phpclass:`MongoDB\\DeleteResult` object, which encapsulates a
A :phpclass:`MongoDB\\DeleteResult` object, which encapsulates a
:php:`MongoDB\\Driver\\WriteResult <class.mongodb-driver-writeresult>`
:php:`MongoDB\\Driver\\WriteResult <class.mongodb-driver-writeresult>` object.
object.
Example
Example
-------
-------
...
...
docs/reference/method/MongoDBCollection-deleteOne.txt
View file @
3cc57327
...
@@ -31,11 +31,11 @@ Definition
...
@@ -31,11 +31,11 @@ Definition
.. include:: /includes/apiargs/MongoDBCollection-method-deleteOne-option.rst
.. include:: /includes/apiargs/MongoDBCollection-method-deleteOne-option.rst
:returns:
Return Values
-------------
A :phpclass:`MongoDB\\DeleteResult` object, which encapsulates a
A :phpclass:`MongoDB\\DeleteResult` object, which encapsulates a
:php:`MongoDB\\Driver\\WriteResult <class.mongodb-driver-writeresult>`
:php:`MongoDB\\Driver\\WriteResult <class.mongodb-driver-writeresult>` object.
object.
Example
Example
-------
-------
...
...
docs/reference/method/MongoDBCollection-distinct.txt
View file @
3cc57327
...
@@ -29,9 +29,10 @@ Definition
...
@@ -29,9 +29,10 @@ Definition
.. include:: /includes/apiargs/MongoDBCollection-method-distinct-option.rst
.. include:: /includes/apiargs/MongoDBCollection-method-distinct-option.rst
:returns:
Return Values
-------------
An array of the distinct values.
An array of the distinct values.
Examples
Examples
--------
--------
...
...
docs/reference/method/MongoDBCollection-drop.txt
View file @
3cc57327
...
@@ -29,11 +29,12 @@ Definition
...
@@ -29,11 +29,12 @@ Definition
.. include:: /includes/apiargs/MongoDBCollection-method-drop-option.rst
.. include:: /includes/apiargs/MongoDBCollection-method-drop-option.rst
:returns:
Return Values
-------------
An array or object with the result document of the :manual:`drop
An array or object with the result document of the :manual:`drop
</reference/command/drop>` command. The return type will depend on the
</reference/command/drop>` command. The return type will depend on the
``typeMap`` option.
``typeMap`` option.
Example
Example
-------
-------
...
...
docs/reference/method/MongoDBCollection-dropIndex.txt
View file @
3cc57327
...
@@ -29,11 +29,12 @@ Definition
...
@@ -29,11 +29,12 @@ Definition
.. include:: /includes/apiargs/MongoDBCollection-method-dropIndex-option.rst
.. include:: /includes/apiargs/MongoDBCollection-method-dropIndex-option.rst
:returns:
Return Values
-------------
An array or object with the result document of the :manual:`dropIndexes
An array or object with the result document of the :manual:`dropIndexes
</reference/command/dropIndexes>` command. The return type will depend on
</reference/command/dropIndexes>` command. The return type will depend on the
the
``typeMap`` option.
``typeMap`` option.
Example
Example
-------
-------
...
...
docs/reference/method/MongoDBCollection-dropIndexes.txt
View file @
3cc57327
...
@@ -30,11 +30,12 @@ Definition
...
@@ -30,11 +30,12 @@ Definition
.. include:: /includes/apiargs/MongoDBCollection-method-dropIndex-option.rst
.. include:: /includes/apiargs/MongoDBCollection-method-dropIndex-option.rst
:returns:
Return Values
-------------
An array or object with the result document of the :manual:`dropIndexes
An array or object with the result document of the :manual:`dropIndexes
</reference/command/dropIndexes>` command. The return type will depend on
</reference/command/dropIndexes>` command. The return type will depend on the
the
``typeMap`` option.
``typeMap`` option.
Example
Example
-------
-------
...
...
docs/reference/method/MongoDBCollection-find.txt
View file @
3cc57327
...
@@ -29,9 +29,10 @@ Definition
...
@@ -29,9 +29,10 @@ Definition
.. include:: /includes/apiargs/MongoDBCollection-method-find-option.rst
.. include:: /includes/apiargs/MongoDBCollection-method-find-option.rst
:returns:
Return Values
-------------
A :php:`MongoDB\\Driver\\Cursor <class.mongodb-driver-cursor>` object.
A :php:`MongoDB\\Driver\\Cursor <class.mongodb-driver-cursor>` object.
Examples
Examples
--------
--------
...
...
docs/reference/method/MongoDBCollection-findOne.txt
View file @
3cc57327
...
@@ -29,11 +29,12 @@ Definition
...
@@ -29,11 +29,12 @@ Definition
.. include:: /includes/apiargs/MongoDBCollection-method-findOne-option.rst
.. include:: /includes/apiargs/MongoDBCollection-method-findOne-option.rst
:returns:
Return Values
-------------
An array or object for the :term:`first document <natural order>` documen
t
An array or object for the :term:`first document <natural order>` document tha
t
that matched the query, or ``null`` if no document matched the query. Th
e
matched the query, or ``null`` if no document matched the query. The return typ
e
return type
will depend on the ``typeMap`` option.
will depend on the ``typeMap`` option.
Examples
Examples
--------
--------
...
...
docs/reference/method/MongoDBCollection-findOneAndDelete.txt
View file @
3cc57327
...
@@ -31,10 +31,11 @@ Definition
...
@@ -31,10 +31,11 @@ Definition
.. include:: /includes/extracts/bson-deserialization-findOneAndDelete.rst
.. include:: /includes/extracts/bson-deserialization-findOneAndDelete.rst
:returns:
Return Values
-------------
An object for the document that was deleted, or ``null`` if no document
An object for the document that was deleted, or ``null`` if no document matched
matched
the query.
the query.
Examples
Examples
--------
--------
...
...
docs/reference/method/MongoDBCollection-findOneAndReplace.txt
View file @
3cc57327
...
@@ -31,12 +31,12 @@ Definition
...
@@ -31,12 +31,12 @@ Definition
.. include:: /includes/extracts/bson-deserialization-findOneAndReplace.rst
.. include:: /includes/extracts/bson-deserialization-findOneAndReplace.rst
:returns:
Return Values
-------------
An object for either the original or the replaced document, depending on
An object for either the original or the replaced document, depending on the
the specified value of the ``returnDocument`` option. By default, the
specified value of the ``returnDocument`` option. By default, the original
original document is returned. If no document matched the query, ``null``
document is returned. If no document matched the query, ``null`` is returned.
is returned.
Examples
Examples
--------
--------
...
...
docs/reference/method/MongoDBCollection-findOneAndUpdate.txt
View file @
3cc57327
...
@@ -31,12 +31,12 @@ Definition
...
@@ -31,12 +31,12 @@ Definition
.. include:: /includes/extracts/bson-deserialization-findOneAndUpdate.rst
.. include:: /includes/extracts/bson-deserialization-findOneAndUpdate.rst
:returns:
Return Values
-------------
An object for either the original or the updated document, depending on
An object for either the original or the updated document, depending on the
the specified value of the ``returnDocument`` option. By default, the
specified value of the ``returnDocument`` option. By default, the original
original document is returned. If no document matched the query, ``null``
document is returned. If no document matched the query, ``null`` is returned.
is returned.
Examples
Examples
--------
--------
...
...
docs/reference/method/MongoDBCollection-getCollectionName.txt
View file @
3cc57327
...
@@ -21,9 +21,10 @@ Definition
...
@@ -21,9 +21,10 @@ Definition
function getCollectionName(): string
function getCollectionName(): string
:returns:
Return Values
-------------
The name of this collection as a string.
The name of this collection as a string.
Example
Example
-------
-------
...
...
docs/reference/method/MongoDBCollection-getDatabaseName.txt
View file @
3cc57327
...
@@ -21,9 +21,10 @@ Definition
...
@@ -21,9 +21,10 @@ Definition
function getDatabaseName(): string
function getDatabaseName(): string
:returns:
Return Values
-------------
The name of the database containing this collection as a string.
The name of the database containing this collection as a string.
Example
Example
-------
-------
...
...
docs/reference/method/MongoDBCollection-getManager.txt
View file @
3cc57327
...
@@ -23,9 +23,10 @@ Definition
...
@@ -23,9 +23,10 @@ Definition
function getManager(): MongoDB\Manager
function getManager(): MongoDB\Manager
:returns:
Return Values
-------------
A :php:`MongoDB\\Driver\\Manager <class.mongodb-driver-manager>` object.
A :php:`MongoDB\\Driver\\Manager <class.mongodb-driver-manager>` object.
See Also
See Also
--------
--------
...
...
docs/reference/method/MongoDBCollection-getNamespace.txt
View file @
3cc57327
...
@@ -22,9 +22,10 @@ Definition
...
@@ -22,9 +22,10 @@ Definition
function getNamespace(): string
function getNamespace(): string
:returns:
Return Values
-------------
The namespace of this collection as a string.
The namespace of this collection as a string.
Example
Example
-------
-------
...
...
docs/reference/method/MongoDBCollection-insertMany.txt
View file @
3cc57327
...
@@ -29,11 +29,11 @@ Definition
...
@@ -29,11 +29,11 @@ Definition
.. include:: /includes/apiargs/MongoDBCollection-method-insertMany-option.rst
.. include:: /includes/apiargs/MongoDBCollection-method-insertMany-option.rst
:returns:
Return Values
-------------
A :phpclass:`MongoDB\\InsertManyResult` object, which encapsulates a
A :phpclass:`MongoDB\\InsertManyResult` object, which encapsulates a
:php:`MongoDB\\Driver\\WriteResult <class.mongodb-driver-writeresult>`
:php:`MongoDB\\Driver\\WriteResult <class.mongodb-driver-writeresult>` object.
object.
Example
Example
-------
-------
...
...
docs/reference/method/MongoDBCollection-insertOne.txt
View file @
3cc57327
...
@@ -29,11 +29,11 @@ Definition
...
@@ -29,11 +29,11 @@ Definition
.. include:: /includes/apiargs/MongoDBCollection-method-insertOne-option.rst
.. include:: /includes/apiargs/MongoDBCollection-method-insertOne-option.rst
:returns:
Return Values
-------------
A :phpclass:`MongoDB\\InsertOneResult` object, which encapsulates a
A :phpclass:`MongoDB\\InsertOneResult` object, which encapsulates a
:php:`MongoDB\\Driver\\WriteResult <class.mongodb-driver-writeresult>`
:php:`MongoDB\\Driver\\WriteResult <class.mongodb-driver-writeresult>` object.
object.
Example
Example
-------
-------
...
...
docs/reference/method/MongoDBCollection-listIndexes.txt
View file @
3cc57327
...
@@ -29,11 +29,11 @@ Definition
...
@@ -29,11 +29,11 @@ Definition
.. include:: /includes/apiargs/MongoDBCollection-method-listIndexes-option.rst
.. include:: /includes/apiargs/MongoDBCollection-method-listIndexes-option.rst
:returns:
Return Values
-------------
A traversable :phpclass:`MongoDB\\Model\\IndexInfoIterator`, which
A traversable :phpclass:`MongoDB\\Model\\IndexInfoIterator`, which contains a
contains an :phpclass:`MongoDB\\Model\\IndexInfo` object for each index
:phpclass:`MongoDB\\Model\\IndexInfo` object for each index for the collection.
for the collection.
Example
Example
-------
-------
...
...
docs/reference/method/MongoDBCollection-replaceOne.txt
View file @
3cc57327
...
@@ -31,11 +31,11 @@ Definition
...
@@ -31,11 +31,11 @@ Definition
.. include:: /includes/apiargs/MongoDBCollection-method-replaceOne-option.rst
.. include:: /includes/apiargs/MongoDBCollection-method-replaceOne-option.rst
:returns:
Return Values
-------------
A :phpclass:`MongoDB\\UpdateResult` object, which encapsulates a
A :phpclass:`MongoDB\\UpdateResult` object, which encapsulates a
:php:`MongoDB\\Driver\\WriteResult <class.mongodb-driver-writeresult>`
:php:`MongoDB\\Driver\\WriteResult <class.mongodb-driver-writeresult>` object.
object.
Example
Example
-------
-------
...
...
docs/reference/method/MongoDBCollection-updateMany.txt
View file @
3cc57327
...
@@ -29,11 +29,11 @@ Definition
...
@@ -29,11 +29,11 @@ Definition
.. include:: /includes/apiargs/MongoDBCollection-method-updateMany-option.rst
.. include:: /includes/apiargs/MongoDBCollection-method-updateMany-option.rst
:returns:
Return Values
-------------
A :phpclass:`MongoDB\\UpdateResult` object, which encapsulates a
A :phpclass:`MongoDB\\UpdateResult` object, which encapsulates a
:php:`MongoDB\\Driver\\WriteResult <class.mongodb-driver-writeresult>`
:php:`MongoDB\\Driver\\WriteResult <class.mongodb-driver-writeresult>` object.
object.
Examples
Examples
--------
--------
...
...
docs/reference/method/MongoDBCollection-updateOne.txt
View file @
3cc57327
...
@@ -31,11 +31,11 @@ Definition
...
@@ -31,11 +31,11 @@ Definition
.. include:: /includes/apiargs/MongoDBCollection-method-updateOne-option.rst
.. include:: /includes/apiargs/MongoDBCollection-method-updateOne-option.rst
:returns:
Return Values
-------------
A :phpclass:`MongoDB\\UpdateResult` object, which encapsulates a
A :phpclass:`MongoDB\\UpdateResult` object, which encapsulates a
:php:`MongoDB\\Driver\\WriteResult <class.mongodb-driver-writeresult>`
:php:`MongoDB\\Driver\\WriteResult <class.mongodb-driver-writeresult>` object.
object.
Examples
Examples
--------
--------
...
...
docs/reference/method/MongoDBCollection-withOptions.txt
View file @
3cc57327
...
@@ -29,9 +29,10 @@ Definition
...
@@ -29,9 +29,10 @@ Definition
.. include:: /includes/apiargs/MongoDBCollection-method-withOptions-option.rst
.. include:: /includes/apiargs/MongoDBCollection-method-withOptions-option.rst
:returns:
Return Values
-------------
A :phpclass:`MongoDB\\Collection` object.
A :phpclass:`MongoDB\\Collection` object.
Example
Example
-------
-------
...
...
docs/reference/method/MongoDBDatabase-command.txt
View file @
3cc57327
...
@@ -29,9 +29,10 @@ Definition
...
@@ -29,9 +29,10 @@ Definition
.. include:: /includes/apiargs/MongoDBDatabase-method-command-option.rst
.. include:: /includes/apiargs/MongoDBDatabase-method-command-option.rst
:returns:
Return Values
-------------
A :php:`MongoDB\\Driver\\Cursor <class.mongodb-driver-cursor>` object.
A :php:`MongoDB\\Driver\\Cursor <class.mongodb-driver-cursor>` object.
Example
Example
-------
-------
...
...
docs/reference/method/MongoDBDatabase-createCollection.txt
View file @
3cc57327
...
@@ -47,10 +47,11 @@ Definition
...
@@ -47,10 +47,11 @@ Definition
:manual:`create </reference/command/create>` command reference in the MongoDB
:manual:`create </reference/command/create>` command reference in the MongoDB
manual for compatibility considerations.
manual for compatibility considerations.
:returns:
Return Values
-------------
An array or object with the result document of the :manual:`create
An array or object with the result document of the :manual:`create
</reference/command/create>` command.
</reference/command/create>` command.
Example
Example
-------
-------
...
...
docs/reference/method/MongoDBDatabase-drop.txt
View file @
3cc57327
...
@@ -29,11 +29,12 @@ Definition
...
@@ -29,11 +29,12 @@ Definition
.. include:: /includes/apiargs/MongoDBDatabase-method-drop-option.rst
.. include:: /includes/apiargs/MongoDBDatabase-method-drop-option.rst
:returns:
Return Values
-------------
An array or object with the result document of the :manual:`dropDatabase
An array or object with the result document of the :manual:`dropDatabase
</reference/command/dropDatabase>` command. The return type will depend on
</reference/command/dropDatabase>` command. The return type will depend on the
the
``typeMap`` option.
``typeMap`` option.
Example
Example
-------
-------
...
...
docs/reference/method/MongoDBDatabase-dropCollection.txt
View file @
3cc57327
...
@@ -29,11 +29,12 @@ Definition
...
@@ -29,11 +29,12 @@ Definition
.. include:: /includes/apiargs/MongoDBDatabase-method-dropCollection-option.rst
.. include:: /includes/apiargs/MongoDBDatabase-method-dropCollection-option.rst
:returns:
Return Values
-------------
An array or object with the result document of the :manual:`drop
An array or object with the result document of the :manual:`drop
</reference/command/drop>` command. The return type will depend on
</reference/command/drop>` command. The return type will depend on the
the
``typeMap`` option.
``typeMap`` option.
Example
Example
-------
-------
...
...
docs/reference/method/MongoDBDatabase-getDatabaseName.txt
View file @
3cc57327
...
@@ -21,9 +21,10 @@ Definition
...
@@ -21,9 +21,10 @@ Definition
function getDatabaseName(): string
function getDatabaseName(): string
:returns:
Return Values
-------------
The name of this database as a string.
The name of this database as a string.
Example
Example
-------
-------
...
...
docs/reference/method/MongoDBDatabase-getManager.txt
View file @
3cc57327
...
@@ -23,9 +23,10 @@ Definition
...
@@ -23,9 +23,10 @@ Definition
function getManager(): MongoDB\Manager
function getManager(): MongoDB\Manager
:returns:
Return Values
-------------
A :php:`MongoDB\\Driver\\Manager <class.mongodb-driver-manager>` object.
A :php:`MongoDB\\Driver\\Manager <class.mongodb-driver-manager>` object.
See Also
See Also
--------
--------
...
...
docs/reference/method/MongoDBDatabase-listCollections.txt
View file @
3cc57327
...
@@ -29,11 +29,12 @@ Definition
...
@@ -29,11 +29,12 @@ Definition
.. include:: /includes/apiargs/MongoDBDatabase-method-listCollections-option.rst
.. include:: /includes/apiargs/MongoDBDatabase-method-listCollections-option.rst
:returns:
Return Values
-------------
A traversable :phpclass:`MongoDB\\Model\\CollectionInfoIterator`, which
A traversable :phpclass:`MongoDB\\Model\\CollectionInfoIterator`, which contains
contains an :phpclass:`MongoDB\\Model\\CollectionInfo` object for each
a :phpclass:`MongoDB\\Model\\CollectionInfo` object for each collection in the
collection in the
database.
database.
Example
Example
-------
-------
...
...
docs/reference/method/MongoDBDatabase-selectCollection.txt
View file @
3cc57327
...
@@ -29,9 +29,10 @@ Definition
...
@@ -29,9 +29,10 @@ Definition
.. include:: /includes/apiargs/MongoDBDatabase-method-selectCollection-option.rst
.. include:: /includes/apiargs/MongoDBDatabase-method-selectCollection-option.rst
:returns:
Return Values
-------------
A :phpclass:`MongoDB\\Collection` object.
A :phpclass:`MongoDB\\Collection` object.
Behavior
Behavior
--------
--------
...
...
docs/reference/method/MongoDBDatabase-selectGridFSBucket.txt
View file @
3cc57327
...
@@ -29,9 +29,10 @@ Definition
...
@@ -29,9 +29,10 @@ Definition
.. include:: /includes/apiargs/MongoDBDatabase-method-selectGridFSBucket-option.rst
.. include:: /includes/apiargs/MongoDBDatabase-method-selectGridFSBucket-option.rst
:returns:
Return Values
-------------
A :phpclass:`MongoDB\\GridFS\\Bucket` object.
A :phpclass:`MongoDB\\GridFS\\Bucket` object.
Behavior
Behavior
--------
--------
...
...
docs/reference/method/MongoDBDatabase-withOptions.txt
View file @
3cc57327
...
@@ -29,9 +29,10 @@ Definition
...
@@ -29,9 +29,10 @@ Definition
.. include:: /includes/apiargs/MongoDBDatabase-method-withOptions-option.rst
.. include:: /includes/apiargs/MongoDBDatabase-method-withOptions-option.rst
:returns:
Return Values
-------------
A :phpclass:`MongoDB\\Database` object.
A :phpclass:`MongoDB\\Database` object.
Example
Example
-------
-------
...
...
docs/reference/method/MongoDBDatabase__get.txt
View file @
3cc57327
...
@@ -25,9 +25,10 @@ Definition
...
@@ -25,9 +25,10 @@ Definition
.. include:: /includes/apiargs/MongoDBDatabase-method-get-param.rst
.. include:: /includes/apiargs/MongoDBDatabase-method-get-param.rst
:returns:
Return Values
-------------
A :phpclass:`MongoDB\\Collection` object.
A :phpclass:`MongoDB\\Collection` object.
Behavior
Behavior
--------
--------
...
...
docs/reference/method/MongoDBGridFSBucket-find.txt
View file @
3cc57327
...
@@ -29,9 +29,10 @@ Definition
...
@@ -29,9 +29,10 @@ Definition
.. include:: /includes/apiargs/MongoDBGridFSBucket-method-find-option.rst
.. include:: /includes/apiargs/MongoDBGridFSBucket-method-find-option.rst
:returns:
Return Values
-------------
A :php:`MongoDB\\Driver\\Cursor <class.mongodb-driver-cursor>` object.
A :php:`MongoDB\\Driver\\Cursor <class.mongodb-driver-cursor>` object.
.. todo: add examples
.. todo: add examples
...
...
docs/reference/method/MongoDBGridFSBucket-getBucketName.txt
View file @
3cc57327
...
@@ -21,8 +21,9 @@ Definition
...
@@ -21,8 +21,9 @@ Definition
function getBucketName(): string
function getBucketName(): string
:returns:
Return Values
-------------
The name of this bucket as a string.
The name of this bucket as a string.
.. todo: add examples
.. todo: add examples
docs/reference/method/MongoDBGridFSBucket-getDatabaseName.txt
View file @
3cc57327
...
@@ -21,8 +21,9 @@ Definition
...
@@ -21,8 +21,9 @@ Definition
function getDatabaseName(): string
function getDatabaseName(): string
:returns:
Return Values
-------------
The name of the database containing this bucket as a string.
The name of the database containing this bucket as a string.
.. todo: add examples
.. todo: add examples
docs/reference/method/MongoDBGridFSBucket-getFileDocumentForStream.txt
View file @
3cc57327
...
@@ -25,9 +25,10 @@ Definition
...
@@ -25,9 +25,10 @@ Definition
.. include:: /includes/apiargs/MongoDBGridFSBucket-method-getFileDocumentForStream-param.rst
.. include:: /includes/apiargs/MongoDBGridFSBucket-method-getFileDocumentForStream-param.rst
:returns:
Return Values
-------------
The metadata document associated with the GridFS stream.
The metadata document associated with the GridFS stream.
.. todo: add examples
.. todo: add examples
...
...
docs/reference/method/MongoDBGridFSBucket-getFileIdForStream.txt
View file @
3cc57327
...
@@ -25,10 +25,11 @@ Definition
...
@@ -25,10 +25,11 @@ Definition
.. include:: /includes/apiargs/MongoDBGridFSBucket-method-getFileIdForStream-param.rst
.. include:: /includes/apiargs/MongoDBGridFSBucket-method-getFileIdForStream-param.rst
:returns:
Return Values
-------------
The ``_id`` field of the metadata document associated with the GridFS
The ``_id`` field of the metadata document associated with the GridFS
stream.
stream.
.. todo: add examples
.. todo: add examples
...
...
docs/reference/method/MongoDBGridFSBucket-openDownloadStream.txt
View file @
3cc57327
...
@@ -25,9 +25,10 @@ Definition
...
@@ -25,9 +25,10 @@ Definition
.. include:: /includes/apiargs/MongoDBGridFSBucket-method-openDownloadStream-param.rst
.. include:: /includes/apiargs/MongoDBGridFSBucket-method-openDownloadStream-param.rst
:returns:
Return Values
-------------
A readable stream resource.
A readable stream resource.
.. todo: add examples
.. todo: add examples
...
...
docs/reference/method/MongoDBGridFSBucket-openDownloadStreamByName.txt
View file @
3cc57327
...
@@ -29,9 +29,10 @@ Definition
...
@@ -29,9 +29,10 @@ Definition
.. include:: /includes/apiargs/MongoDBGridFSBucket-method-openDownloadStreamByName-option.rst
.. include:: /includes/apiargs/MongoDBGridFSBucket-method-openDownloadStreamByName-option.rst
:returns:
Return Values
-------------
A readable stream resource.
A readable stream resource.
.. todo: add examples
.. todo: add examples
...
...
docs/reference/method/MongoDBGridFSBucket-openUploadStream.txt
View file @
3cc57327
...
@@ -29,9 +29,10 @@ Definition
...
@@ -29,9 +29,10 @@ Definition
.. include:: /includes/apiargs/MongoDBGridFSBucket-method-openUploadStream-option.rst
.. include:: /includes/apiargs/MongoDBGridFSBucket-method-openUploadStream-option.rst
:returns:
Return Values
-------------
A writable stream resource.
A writable stream resource.
Behavior
Behavior
--------
--------
...
...
docs/reference/method/MongoDBGridFSBucket-uploadFromStream.txt
View file @
3cc57327
...
@@ -29,12 +29,13 @@ Definition
...
@@ -29,12 +29,13 @@ Definition
.. include:: /includes/apiargs/MongoDBGridFSBucket-method-uploadFromStream-option.rst
.. include:: /includes/apiargs/MongoDBGridFSBucket-method-uploadFromStream-option.rst
:returns:
Return Values
-------------
The ``_id`` field of the metadata document associated with the newly
The ``_id`` field of the metadata document associated with the newly created
created
GridFS file. If the ``_id`` option is not specified, a new
GridFS file. If the ``_id`` option is not specified, a new
:php:`MongoDB\\BSON\\ObjectID <class.mongodb-bson-objectid>` object will
:php:`MongoDB\\BSON\\ObjectID <class.mongodb-bson-objectid>` object will be used
be used
by default.
by default.
.. todo: add examples
.. todo: add examples
...
...
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