Skip to content

Commit 4f3187a

Browse files
authored
* DOCSP-35757 Fix :phpmethod: Build Errors (#5955) * Empty-Commit * <phpmethod.MongoDB\Collection::find() * " * * * * * * * * * * * deleteMany() * * * * * * * updateOne() * updateMany() * insertMany() * * * deleteMany() * getInsertedId() one and many * * * * * createIndex() * getDeletedCount() * * * *
1 parent 1bf5cbe commit 4f3187a

9 files changed

+39
-41
lines changed

snooty.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ sharedinclude_root = "https://raw.githubusercontent.com/10gen/docs-shared/main/"
66
intersphinx = [ "https://pymongo.readthedocs.io/en/stable/objects.inv",
77
"https://motor.readthedocs.io/en/stable/objects.inv",
88
"https://docs.atlas.mongodb.com/objects.inv",
9-
"https://docs.mongodb.com/php-library/master/objects.inv",
9+
"https://docs.mongodb.com/php-library/upcoming/objects.inv",
1010
"https://docs.mongodb.com/compass/current/objects.inv",
1111
"https://docs.mongodb.com/database-tools/objects.inv"
1212
]

source/includes/driver-examples/driver-example-delete-result.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,10 +47,10 @@
4747
- id: php
4848
content: |
4949
Upon successful execution, the
50-
:phpmethod:`deleteMany() <phpmethod.MongoDB\\Collection::deleteMany>`
50+
:phpmethod:`deleteMany() <phpmethod.MongoDB\\Collection::deleteMany()>`
5151
method returns an instance of
5252
:phpclass:`MongoDB\\DeleteResult <phpclass.MongoDB\\DeleteResult>`
53-
whose :phpmethod:`getDeletedCount()<phpmethod.MongoDB\\DeleteResult::getDeletedCount>`
53+
whose :phpmethod:`getDeletedCount()<phpmethod.MongoDB\\DeleteResult::getDeletedCount()>`
5454
method returns the number of documents that matched the filter.
5555

5656
- id: perl

source/includes/driver-examples/driver-example-query-intro-no-perl.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@
7575
content: |
7676

7777
This page provides examples of |query_operations| using the
78-
:phpmethod:`MongoDB\\Collection::find() <phpmethod.MongoDB\\Collection::find>`
78+
:phpmethod:`MongoDB\\Collection::find() <phpmethod.MongoDB\\Collection::find()>`
7979
method in the
8080
`MongoDB PHP Library <https://www.mongodb.com/docs/drivers/php-libraries/>`_.
8181

source/includes/driver-examples/driver-example-query-intro.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@
6767
- id: php
6868
content: |
6969
This page provides examples of |query_operations| using the
70-
:phpmethod:`MongoDB\\Collection::find() <phpmethod.MongoDB\\Collection::find>`
70+
:phpmethod:`MongoDB\\Collection::find() <phpmethod.MongoDB\\Collection::find()>`
7171
method in the
7272
`MongoDB PHP Library <https://www.mongodb.com/docs/drivers/php-libraries/>`_.
7373

source/tutorial/insert-documents.txt

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -206,7 +206,7 @@ Insert a Single Document
206206
.. tab::
207207
:tabid: php
208208

209-
:phpmethod:`MongoDB\\Collection::insertOne() <phpmethod.MongoDB\\Collection::insertOne>`
209+
:phpmethod:`MongoDB\\Collection::insertOne() <phpmethod.MongoDB\\Collection::insertOne()>`
210210
inserts a *single* :ref:`document<bson-document-format>` into a
211211
collection.
212212

@@ -342,11 +342,11 @@ Insert a Single Document
342342
:tabid: php
343343

344344
Upon successful insert, the
345-
:phpmethod:`insertOne() <phpmethod.MongoDB\\Collection::insertOne>`
345+
:phpmethod:`insertOne() <phpmethod.MongoDB\\Collection::insertOne()>`
346346
method returns an instance of
347347
:phpclass:`MongoDB\\InsertOneResult <phpclass.MongoDB\\InsertOneResult>`
348348
whose
349-
:phpmethod:`getInsertedId() <phpmethod.MongoDB\\InsertOneResult::getInsertedId>`
349+
:phpmethod:`getInsertedId() <phpmethod.MongoDB\\InsertOneResult::getInsertedId()>`
350350
method returns the ``_id`` of the newly inserted document.
351351

352352
.. tab::
@@ -506,9 +506,7 @@ upper-right to set the language of the examples on this page.
506506
.. tab::
507507
:tabid: php
508508

509-
.. versionadded:: 3.2
510-
511-
:phpmethod:`MongoDB\\Collection::insertMany() <phpmethod.MongoDB\\Collection::insertMany>`
509+
:phpmethod:`MongoDB\\Collection::insertMany() <phpmethod.MongoDB\\Collection::insertMany()>`
512510
can insert *multiple* :ref:`documents <bson-document-format>` into a
513511
collection. Pass an array of documents to the method.
514512

@@ -656,12 +654,12 @@ upper-right to set the language of the examples on this page.
656654
:tabid: php
657655

658656
Upon successful insert, the
659-
:phpmethod:`insertMany() <phpmethod.MongoDB\\Collection::insertMany>`
657+
:phpmethod:`insertMany() <phpmethod.MongoDB\\Collection::insertMany()>`
660658
method
661659
returns an instance of
662660
:phpclass:`MongoDB\\InsertManyResult <phpclass.MongoDB\\InsertManyResult>`
663661
whose
664-
:phpmethod:`getInsertedIds() <phpmethod.MongoDB\\InsertManyResult::getInsertedIds>`
662+
:phpmethod:`getInsertedIds() <phpmethod.MongoDB\\InsertManyResult::getInsertedIds()>`
665663
method returns the ``_id`` of each newly inserted document.
666664

667665
To retrieve the inserted documents, :ref:`query the collection
@@ -826,9 +824,9 @@ requested from MongoDB for write operations. For details, see
826824

827825
.. seealso::
828826

829-
- :phpmethod:`MongoDB\\Collection::insertOne() <phpmethod.MongoDB\\Collection::insertOne>`
827+
- :phpmethod:`MongoDB\\Collection::insertOne() <phpmethod.MongoDB\\Collection::insertOne()>`
830828

831-
- :phpmethod:`MongoDB\\Collection::insertMany() <phpmethod.MongoDB\\Collection::insertMany>`
829+
- :phpmethod:`MongoDB\\Collection::insertMany() <phpmethod.MongoDB\\Collection::insertMany()>`
832830

833831
- :ref:`additional-inserts`
834832

source/tutorial/project-fields-from-query-results.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ Return All Fields in Matching Documents
8282
- id: php
8383
content: |
8484
If you do not specify a :term:`projection` document, the
85-
:phpmethod:`find() <phpmethod.MongoDB\\Collection::find>`
85+
:phpmethod:`find() <phpmethod.MongoDB\\Collection::find()>`
8686
method returns all fields in the matching documents.
8787

8888
- id: perl

source/tutorial/query-documents.txt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ the following SQL statement:
8888
- id: php
8989
content: |
9090
For more information on the syntax of the method, see
91-
:phpmethod:`find() <phpmethod.MongoDB\\Collection::find>`.
91+
:phpmethod:`find() <phpmethod.MongoDB\\Collection::find()>`.
9292

9393
- id: perl
9494
content: |
@@ -350,7 +350,7 @@ Cursor
350350

351351
- id: php
352352
content: |
353-
The :phpmethod:`MongoDB\\Collection::find() <phpmethod.MongoDB\\Collection::find>`
353+
The :phpmethod:`MongoDB\\Collection::find() <phpmethod.MongoDB\\Collection::find()>`
354354
method returns a :doc:`cursor </tutorial/iterate-a-cursor>` to
355355
the matching documents. See the MongoDB PHP Library
356356
documentation for
@@ -531,20 +531,20 @@ Additional Methods and Options
531531

532532
The following methods can also read documents from a collection:
533533

534-
- :phpmethod:`MongoDB\\Collection::findOne() <phpmethod.MongoDB\\Collection::findOne>`
534+
- :phpmethod:`MongoDB\\Collection::findOne() <phpmethod.MongoDB\\Collection::findOne()>`
535535

536536
- In :doc:`aggregation pipeline </core/aggregation-pipeline>`, the
537537
:pipeline:`$match` pipeline stage provides access to MongoDB
538538
queries. See the MongoDB PHP Library's
539539
:ref:`aggregation example <php-aggregation>`.
540540

541541
.. note::
542-
The :phpmethod:`MongoDB\\Collection::findOne() <phpmethod.MongoDB\\Collection::findOne>`
542+
The :phpmethod:`MongoDB\\Collection::findOne() <phpmethod.MongoDB\\Collection::findOne()>`
543543
method also performs a read operation to return a single
544544
document. Internally, the
545-
:phpmethod:`MongoDB\\Collection::findOne() <phpmethod.MongoDB\\Collection::findOne>`
545+
:phpmethod:`MongoDB\\Collection::findOne() <phpmethod.MongoDB\\Collection::findOne()>`
546546
method is the
547-
:phpmethod:`MongoDB\\Collection::find() <phpmethod.MongoDB\\Collection::find>`
547+
:phpmethod:`MongoDB\\Collection::find() <phpmethod.MongoDB\\Collection::find()>`
548548
method with a limit of 1.
549549

550550
- id: perl

source/tutorial/remove-documents.txt

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -112,8 +112,8 @@ You can delete documents in MongoDB using the following methods:
112112
This page uses the
113113
following `MongoDB PHP Library <https://docs.mongodb.com/php-library/master/>`_ methods:
114114

115-
- :phpmethod:`MongoDB\\Collection::deleteMany() <phpmethod.MongoDB\\Collection::deleteMany>`
116-
- :phpmethod:`MongoDB\\Collection::deleteOne() <phpmethod.MongoDB\\Collection::deleteOne>`
115+
- :phpmethod:`MongoDB\\Collection::deleteMany() <phpmethod.MongoDB\\Collection::deleteMany()>`
116+
- :phpmethod:`MongoDB\\Collection::deleteOne() <phpmethod.MongoDB\\Collection::deleteOne()>`
117117

118118
.. include:: /includes/driver-examples/examples-intro.rst
119119

@@ -245,7 +245,7 @@ Delete All Documents
245245

246246
To delete all documents from a collection, pass an empty
247247
:ref:`filter<document-query-filter>` document ``[]`` to the
248-
:phpmethod:`MongoDB\\Collection::deleteMany() <phpmethod.MongoDB\\Collection::deleteMany>`
248+
:phpmethod:`MongoDB\\Collection::deleteMany() <phpmethod.MongoDB\\Collection::deleteMany()>`
249249
method.
250250

251251
.. include:: /includes/fact-delete-all-inventory.rst
@@ -415,7 +415,7 @@ Delete All Documents that Match a Condition
415415

416416
To delete all documents that match a deletion criteria, pass a
417417
:ref:`filter <document-query-filter>` parameter to the
418-
:phpmethod:`deleteMany() <phpmethod.MongoDB\\Collection::deleteMany>`
418+
:phpmethod:`deleteMany() <phpmethod.MongoDB\\Collection::deleteMany()>`
419419
method.
420420

421421
.. include:: /includes/fact-remove-condition-inv-example.rst
@@ -597,7 +597,7 @@ Delete Only One Document that Matches a Condition
597597
To delete at most a single document that matches a specified
598598
filter (even though multiple documents may match the specified
599599
filter) use the
600-
:phpmethod:`MongoDB\\Collection::deleteOne() <phpmethod.MongoDB\\Collection::deleteOne>`
600+
:phpmethod:`MongoDB\\Collection::deleteOne() <phpmethod.MongoDB\\Collection::deleteOne()>`
601601
method.
602602

603603
.. include:: /includes/fact-remove-one-condition-inv-example.rst
@@ -819,9 +819,9 @@ requested from MongoDB for write operations. For details, see
819819
content: |
820820
.. seealso::
821821

822-
- :phpmethod:`MongoDB\\Collection::deleteMany() <phpmethod.MongoDB\\Collection::deleteMany>`
822+
- :phpmethod:`MongoDB\\Collection::deleteMany() <phpmethod.MongoDB\\Collection::deleteMany()>`
823823

824-
- :phpmethod:`MongoDB\\Collection::deleteOne() <phpmethod.MongoDB\\Collection::deleteOne>`
824+
- :phpmethod:`MongoDB\\Collection::deleteOne() <phpmethod.MongoDB\\Collection::deleteOne()>`
825825

826826
- :ref:`additional-deletes`
827827

source/tutorial/update-documents.txt

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -147,11 +147,11 @@ upper-right to set the language of the following examples.
147147
This page uses the following `MongoDB PHP Library
148148
<https://docs.mongodb.com/php-library/master/>`_ methods:
149149

150-
- :phpmethod:`MongoDB\\Collection::updateOne() <phpmethod.MongoDB\\Collection::updateOne>`
150+
- :phpmethod:`MongoDB\\Collection::updateOne() <phpmethod.MongoDB\\Collection::updateOne()>`
151151

152-
- :phpmethod:`MongoDB\\Collection::updateMany() <phpmethod.MongoDB\\Collection::updateMany>`
152+
- :phpmethod:`MongoDB\\Collection::updateMany() <phpmethod.MongoDB\\Collection::updateMany()>`
153153

154-
- :phpmethod:`MongoDB\\Collection::replaceOne() <phpmethod.MongoDB\\Collection::replaceOne>`
154+
- :phpmethod:`MongoDB\\Collection::replaceOne() <phpmethod.MongoDB\\Collection::replaceOne()>`
155155

156156
|populate-inventory|
157157

@@ -578,7 +578,7 @@ Update a Single Document
578578
:tabid: php
579579

580580
The following example uses the :phpmethod:`updateOne()
581-
<phpmethod.MongoDB\\Collection::updateOne>` method on the
581+
<phpmethod.MongoDB\\Collection::updateOne()>` method on the
582582
``inventory`` collection to update the *first* document where
583583
``item`` equals ``"paper"``:
584584

@@ -700,7 +700,7 @@ Update Multiple Documents
700700
:tabid: php
701701

702702
The following example uses the :phpmethod:`updateMany()
703-
<phpmethod.MongoDB\\Collection::updateMany>` method on the
703+
<phpmethod.MongoDB\\Collection::updateMany()>` method on the
704704
``inventory`` collection to update all documents where ``qty`` is
705705
less than ``50``:
706706

@@ -822,7 +822,7 @@ Replace a Document
822822
To replace the entire content of a document except for the ``_id``
823823
field, pass an entirely new document as the second argument to
824824
:phpmethod:`replaceOne()
825-
<phpmethod.MongoDB\\Collection::replaceOne>`.
825+
<phpmethod.MongoDB\\Collection::replaceOne()>`.
826826

827827
.. include:: /includes/fact-update-replace-example.rst
828828

@@ -1064,11 +1064,11 @@ Upsert Option
10641064
:tabid: php
10651065

10661066
If :phpmethod:`updateOne()
1067-
<phpmethod.MongoDB\\Collection::updateOne>`,
1067+
<phpmethod.MongoDB\\Collection::updateOne()>`,
10681068
:phpmethod:`updateMany()
1069-
<phpmethod.MongoDB\\Collection::updateMany>`, or
1069+
<phpmethod.MongoDB\\Collection::updateMany()>`, or
10701070
:phpmethod:`replaceOne()
1071-
<phpmethod.MongoDB\\Collection::replaceOne>` includes ``upsert =>
1071+
<phpmethod.MongoDB\\Collection::replaceOne()>` includes ``upsert =>
10721072
true`` **and** no documents match the specified filter, then the
10731073
operation creates a new document and inserts it. If there are
10741074
matching documents, then the operation modifies or replaces the
@@ -1261,11 +1261,11 @@ requested from MongoDB for write operations. For details, see
12611261

12621262
.. seealso::
12631263

1264-
- :phpmethod:`MongoDB\\Collection::updateOne() <phpmethod.MongoDB\\Collection::updateOne>`
1264+
- :phpmethod:`MongoDB\\Collection::updateOne() <phpmethod.MongoDB\\Collection::updateOne()>`
12651265

1266-
- :phpmethod:`MongoDB\\Collection::updateMany() <phpmethod.MongoDB\\Collection::updateMany>`
1266+
- :phpmethod:`MongoDB\\Collection::updateMany() <phpmethod.MongoDB\\Collection::updateMany()>`
12671267

1268-
- :phpmethod:`MongoDB\\Collection::replaceOne() <phpmethod.MongoDB\\Collection::replaceOne>`
1268+
- :phpmethod:`MongoDB\\Collection::replaceOne() <phpmethod.MongoDB\\Collection::replaceOne()>`
12691269

12701270
- :ref:`additional-updates`
12711271

0 commit comments

Comments
 (0)