Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOCSP-36627: Additional double backslash fixes for master #1246

Merged
merged 3 commits into from
Mar 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/faq.txt
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ The following are all examples of
[TLS handshake failed: certificate verify failed (64): IP address mismatch calling hello on 'b.example.com:27017']

These errors typically manifest as a
:php:`MongoDB\\Driver\\Exception\\ConnectionTimeoutException <mongodb-driver-exception-connectiontimeoutexception>`
:php:`MongoDB\Driver\Exception\ConnectionTimeoutException <mongodb-driver-exception-connectiontimeoutexception>`
exception from the driver. The actual exception messages originate from
libmongoc, which is the underlying library used by the PHP driver. Since these
messages can take many forms, it's helpful to break down the structure of the
Expand Down
4 changes: 2 additions & 2 deletions docs/includes/extracts-bulkwriteexception.yaml
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
ref: bulkwriteexception-result
content: |
If a :php:`MongoDB\\Driver\\Exception\\BulkWriteException
If a :php:`MongoDB\Driver\Exception\BulkWriteException
<mongodb-driver-exception-bulkwriteexception>` is thrown, users should call
:php:`getWriteResult() <mongodb-driver-writeexception.getwriteresult>` and
inspect the returned :php:`MongoDB\\Driver\\WriteResult
inspect the returned :php:`MongoDB\Driver\WriteResult
<mongodb-driver-writeresult>` object to determine the nature of the error.

For example, a write operation may have been successfully applied to the
Expand Down
18 changes: 9 additions & 9 deletions docs/includes/extracts-error.yaml
Original file line number Diff line number Diff line change
@@ -1,52 +1,52 @@
ref: error-driver-bulkwriteexception
content: |
:php:`MongoDB\\Driver\\Exception\\BulkWriteException
:php:`MongoDB\Driver\Exception\BulkWriteException
<mongodb-driver-exception-bulkwriteexception>` for errors related to the write
operation. Users should inspect the value returned by :php:`getWriteResult()
<mongodb-driver-writeexception.getwriteresult>` to determine the nature of the
error.
---
ref: error-driver-invalidargumentexception
content: |
:php:`MongoDB\\Driver\\Exception\\InvalidArgumentException
:php:`MongoDB\Driver\Exception\InvalidArgumentException
<mongodb-driver-exception-invalidargumentexception>` for errors related to the
parsing of parameters or options at the driver level.
---
ref: error-driver-runtimeexception
content: |
:php:`MongoDB\\Driver\\Exception\\RuntimeException
:php:`MongoDB\Driver\Exception\RuntimeException
<mongodb-driver-exception-runtimeexception>` for other errors at the driver
level (e.g. connection errors).
---
ref: error-badmethodcallexception-write-result
content: |
:phpclass:`MongoDB\\Exception\\BadMethodCallException` if this method is
:phpclass:`MongoDB\Exception\BadMethodCallException` if this method is
called and the write operation used an unacknowledged :manual:`write concern
</reference/write-concern>`.
---
ref: error-invalidargumentexception
content: |
:phpclass:`MongoDB\\Exception\\InvalidArgumentException` for errors related to
:phpclass:`MongoDB\Exception\InvalidArgumentException` for errors related to
the parsing of parameters or options.
---
ref: error-unexpectedvalueexception
content: |
:phpclass:`MongoDB\\Exception\\UnexpectedValueException` if the command
:phpclass:`MongoDB\Exception\UnexpectedValueException` if the command
response from the server was malformed.
---
ref: error-unsupportedexception
content: |
:phpclass:`MongoDB\\Exception\\UnsupportedException` if options are used and
:phpclass:`MongoDB\Exception\UnsupportedException` if options are used and
not supported by the selected server (e.g. ``collation``, ``readConcern``,
``writeConcern``).
---
ref: error-gridfs-filenotfoundexception
content: |
:phpclass:`MongoDB\\GridFS\\Exception\\FileNotFoundException` if no file was
:phpclass:`MongoDB\GridFS\Exception\FileNotFoundException` if no file was
found for the selection criteria.
---
ref: error-gridfs-corruptfileexception
content: |
:phpclass:`MongoDB\\GridFS\\Exception\\CorruptFileException` if the file's
:phpclass:`MongoDB\GridFS\Exception\CorruptFileException` if the file's
metadata or chunk documents contain unexpected or invalid data.
...
4 changes: 2 additions & 2 deletions docs/includes/extracts-note.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ content: |
<manual/en/language.types.type-juggling.php>` rules. When matching a special
BSON type the query criteria should use the respective :php:`BSON class
<manual/en/book.bson.php>` in the driver (e.g. use
:php:`MongoDB\\BSON\\ObjectId <class.mongodb-bson-objectid>` to match an
:php:`MongoDB\BSON\ObjectId <class.mongodb-bson-objectid>` to match an
:manual:`ObjectId </reference/object-id/>`).
---
ref: note-atlas-search-requirement
Expand All @@ -22,7 +22,7 @@ ref: note-atlas-search-async
content: |
Atlas Search indexes are managed asynchronously. After creating or updating an
index, you can periodically execute
:phpmethod:`MongoDB\\Collection::listSearchIndexes()` and check the
:phpmethod:`MongoDB\Collection::listSearchIndexes()` and check the
``queryable`` :manual:`output field </reference/operator/aggregation/listSearchIndexes/#output>`
to determine whether it is ready to be used.
...
2 changes: 1 addition & 1 deletion docs/index.txt
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ The ``mongodb`` extension provides a limited API to connect to the database and
execute generic commands, queries, and write operations. In contrast, the
|php-library| provides a full-featured API and models client, database, and
collection objects. Each of those classes provide various helper methods for
performing operations in context. For example, :phpclass:`MongoDB\\Collection`
performing operations in context. For example, :phpclass:`MongoDB\Collection`
implements methods for executing CRUD operations and managing indexes on the
collection, among other things.

Expand Down
16 changes: 8 additions & 8 deletions docs/reference/bson.txt
Original file line number Diff line number Diff line change
Expand Up @@ -18,31 +18,31 @@ of JSON documents, though it contains more data types than JSON. For the BSON
spec, see `bsonspec.org <https://bsonspec.org/>`_.

By default, the |php-library| returns BSON documents as
:phpclass:`MongoDB\\Model\\BSONDocument` objects and BSON arrays as
:phpclass:`MongoDB\\Model\\BSONArray` objects, respectively.
:phpclass:`MongoDB\Model\BSONDocument` objects and BSON arrays as
:phpclass:`MongoDB\Model\BSONArray` objects, respectively.

Classes
-------

.. phpclass:: MongoDB\\Model\\BSONArray
.. phpclass:: MongoDB\Model\BSONArray

This class extends PHP's :php:`ArrayObject <arrayobject>` class. It also
implements PHP's :php:`JsonSerializable <jsonserializable>` interface and the
driver's :php:`MongoDB\\BSON\\Serializable <mongodb-bson-serializable>` and
:php:`MongoDB\\BSON\\Unserializable <mongodb-bson-unserializable>`
driver's :php:`MongoDB\BSON\Serializable <mongodb-bson-serializable>` and
:php:`MongoDB\BSON\Unserializable <mongodb-bson-unserializable>`
interfaces.

By default, the library will deserialize BSON arrays as instances of this
class. During BSON and JSON serialization, instances of this class will
serialize as an array type (:php:`array_values() <array_values>` is used
internally to numerically reindex the array).

.. phpclass:: MongoDB\\Model\\BSONDocument
.. phpclass:: MongoDB\Model\BSONDocument

This class extends PHP's :php:`ArrayObject <arrayobject>` class. It also
implements PHP's :php:`JsonSerializable <jsonserializable>` interface and the
driver's :php:`MongoDB\\BSON\\Serializable <mongodb-bson-serializable>` and
:php:`MongoDB\\BSON\\Unserializable <mongodb-bson-unserializable>`
driver's :php:`MongoDB\BSON\Serializable <mongodb-bson-serializable>` and
:php:`MongoDB\BSON\Unserializable <mongodb-bson-unserializable>`
interfaces.

By default, the library will deserialize BSON documents as instances of this
Expand Down
23 changes: 11 additions & 12 deletions docs/reference/class/MongoDBBulkWriteResult.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,11 @@ MongoDB\\BulkWriteResult Class
Definition
----------

.. phpclass:: MongoDB\\BulkWriteResult
.. phpclass:: MongoDB\BulkWriteResult

This class contains information about an executed bulk write operation. It
encapsulates a :php:`MongoDB\\Driver\\WriteResult
<class.mongodb-driver-writeresult>` object and is returned from
:phpmethod:`MongoDB\\Collection::bulkWrite()`.
encapsulates a :php:`MongoDB\Driver\WriteResult <class.mongodb-driver-writeresult>`
object and is returned from :phpmethod:`MongoDB\Collection::bulkWrite()`.

Methods
-------
Expand All @@ -27,11 +26,11 @@ Methods
getUpsertedIds() </reference/method/MongoDBBulkWriteResult-getUpsertedIds>
isAcknowledged() </reference/method/MongoDBBulkWriteResult-isAcknowledged>

- :phpmethod:`MongoDB\\BulkWriteResult::getDeletedCount()`
- :phpmethod:`MongoDB\\BulkWriteResult::getInsertedCount()`
- :phpmethod:`MongoDB\\BulkWriteResult::getInsertedIds()`
- :phpmethod:`MongoDB\\BulkWriteResult::getMatchedCount()`
- :phpmethod:`MongoDB\\BulkWriteResult::getModifiedCount()`
- :phpmethod:`MongoDB\\BulkWriteResult::getUpsertedCount()`
- :phpmethod:`MongoDB\\BulkWriteResult::getUpsertedIds()`
- :phpmethod:`MongoDB\\BulkWriteResult::isAcknowledged()`
- :phpmethod:`MongoDB\BulkWriteResult::getDeletedCount()`
- :phpmethod:`MongoDB\BulkWriteResult::getInsertedCount()`
- :phpmethod:`MongoDB\BulkWriteResult::getInsertedIds()`
- :phpmethod:`MongoDB\BulkWriteResult::getMatchedCount()`
- :phpmethod:`MongoDB\BulkWriteResult::getModifiedCount()`
- :phpmethod:`MongoDB\BulkWriteResult::getUpsertedCount()`
- :phpmethod:`MongoDB\BulkWriteResult::getUpsertedIds()`
- :phpmethod:`MongoDB\BulkWriteResult::isAcknowledged()`
22 changes: 11 additions & 11 deletions docs/reference/class/MongoDBChangeStream.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ MongoDB\\ChangeStream Class
Definition
----------

.. phpclass:: MongoDB\\ChangeStream
.. phpclass:: MongoDB\ChangeStream

This class extends PHP's :php:`Iterator <manual/en/class.iterator.php>`
interface. An instance of this class is returned by
:phpmethod:`MongoDB\\Client::watch()`,
:phpmethod:`MongoDB\\Database::watch()`, and
:phpmethod:`MongoDB\\Collection::watch()`.
:phpmethod:`MongoDB\Client::watch()`,
:phpmethod:`MongoDB\Database::watch()`, and
:phpmethod:`MongoDB\Collection::watch()`.

This class allows for iteration of events in a change stream. It also allows
iteration to automatically resume after certain errors, such as a replica set
Expand All @@ -33,10 +33,10 @@ Methods
rewind() </reference/method/MongoDBChangeStream-rewind>
valid() </reference/method/MongoDBChangeStream-valid>

- :phpmethod:`MongoDB\\ChangeStream::current()`
- :phpmethod:`MongoDB\\ChangeStream::getCursorId()`
- :phpmethod:`MongoDB\\ChangeStream::getResumeToken()`
- :phpmethod:`MongoDB\\ChangeStream::key()`
- :phpmethod:`MongoDB\\ChangeStream::next()`
- :phpmethod:`MongoDB\\ChangeStream::rewind()`
- :phpmethod:`MongoDB\\ChangeStream::valid()`
- :phpmethod:`MongoDB\ChangeStream::current()`
- :phpmethod:`MongoDB\ChangeStream::getCursorId()`
- :phpmethod:`MongoDB\ChangeStream::getResumeToken()`
- :phpmethod:`MongoDB\ChangeStream::key()`
- :phpmethod:`MongoDB\ChangeStream::next()`
- :phpmethod:`MongoDB\ChangeStream::rewind()`
- :phpmethod:`MongoDB\ChangeStream::valid()`
40 changes: 20 additions & 20 deletions docs/reference/class/MongoDBClient.txt
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,13 @@ MongoDB\\Client Class
Definition
----------

.. phpclass:: MongoDB\\Client
.. phpclass:: MongoDB\Client

This class serves as an entry point for the |php-library|. It is the
preferred class for connecting to a MongoDB server or cluster of servers and
acts as a gateway for accessing individual databases and collections.
:phpclass:`MongoDB\\Client` is analogous to the driver's
:php:`MongoDB\\Driver\\Manager <mongodb-driver-manager>` class, which it
:phpclass:`MongoDB\Client` is analogous to the driver's
:php:`MongoDB\Driver\Manager <mongodb-driver-manager>` class, which it
`composes <https://en.wikipedia.org/wiki/Object_composition>`_.

Methods
Expand All @@ -46,20 +46,20 @@ Methods
startSession() </reference/method/MongoDBClient-startSession>
watch() </reference/method/MongoDBClient-watch>

- :phpmethod:`MongoDB\\Client::__construct()`
- :phpmethod:`MongoDB\\Client::__get()`
- :phpmethod:`MongoDB\\Client::addSubscriber()`
- :phpmethod:`MongoDB\\Client::createClientEncryption()`
- :phpmethod:`MongoDB\\Client::dropDatabase()`
- :phpmethod:`MongoDB\\Client::getManager()`
- :phpmethod:`MongoDB\\Client::getReadConcern()`
- :phpmethod:`MongoDB\\Client::getReadPreference()`
- :phpmethod:`MongoDB\\Client::getTypeMap()`
- :phpmethod:`MongoDB\\Client::getWriteConcern()`
- :phpmethod:`MongoDB\\Client::listDatabaseNames()`
- :phpmethod:`MongoDB\\Client::listDatabases()`
- :phpmethod:`MongoDB\\Client::removeSubscriber()`
- :phpmethod:`MongoDB\\Client::selectCollection()`
- :phpmethod:`MongoDB\\Client::selectDatabase()`
- :phpmethod:`MongoDB\\Client::startSession()`
- :phpmethod:`MongoDB\\Client::watch()`
- :phpmethod:`MongoDB\Client::__construct()`
- :phpmethod:`MongoDB\Client::__get()`
- :phpmethod:`MongoDB\Client::addSubscriber()`
- :phpmethod:`MongoDB\Client::createClientEncryption()`
- :phpmethod:`MongoDB\Client::dropDatabase()`
- :phpmethod:`MongoDB\Client::getManager()`
- :phpmethod:`MongoDB\Client::getReadConcern()`
- :phpmethod:`MongoDB\Client::getReadPreference()`
- :phpmethod:`MongoDB\Client::getTypeMap()`
- :phpmethod:`MongoDB\Client::getWriteConcern()`
- :phpmethod:`MongoDB\Client::listDatabaseNames()`
- :phpmethod:`MongoDB\Client::listDatabases()`
- :phpmethod:`MongoDB\Client::removeSubscriber()`
- :phpmethod:`MongoDB\Client::selectCollection()`
- :phpmethod:`MongoDB\Client::selectDatabase()`
- :phpmethod:`MongoDB\Client::startSession()`
- :phpmethod:`MongoDB\Client::watch()`
Loading