diff --git a/docs/includes/extracts-option-requires.yaml b/docs/includes/extracts-option-requires.yaml index edc1c0d37..485ea8996 100644 --- a/docs/includes/extracts-option-requires.yaml +++ b/docs/includes/extracts-option-requires.yaml @@ -45,3 +45,4 @@ source: replacement: version: "7.0" ... + diff --git a/docs/reference/method/MongoDBClient-addSubscriber.txt b/docs/reference/method/MongoDBClient-addSubscriber.txt index b85d8d992..9a3344b03 100644 --- a/docs/reference/method/MongoDBClient-addSubscriber.txt +++ b/docs/reference/method/MongoDBClient-addSubscriber.txt @@ -17,8 +17,8 @@ Definition .. phpmethod:: MongoDB\Client::addSubscriber() - Registers a monitoring event subscriber with this Client. The subscriber - will be notified of all events for this Client. + Registers a monitoring event subscriber with this Client. The subscriber + will be notified of all events for this Client. .. code-block:: php @@ -50,8 +50,8 @@ notified once of each event for this Client. Example ------- -Create a :phpclass:`MongoDB\Driver\Monitoring\CommandSubscriber` that -logs all events: +Create a :php:`MongoDB\Driver\Monitoring\CommandSubscriber ` +that logs all events: .. code-block:: php diff --git a/docs/reference/method/MongoDBClient-removeSubscriber.txt b/docs/reference/method/MongoDBClient-removeSubscriber.txt index 9270689d8..e95f74e73 100644 --- a/docs/reference/method/MongoDBClient-removeSubscriber.txt +++ b/docs/reference/method/MongoDBClient-removeSubscriber.txt @@ -17,7 +17,7 @@ Definition .. phpmethod:: MongoDB\Client::removeSubscriber() - Unregisters a monitoring event subscriber with this Client. + Unregisters a monitoring event subscriber with this Client. .. code-block:: php diff --git a/docs/reference/method/MongoDBCollection-dropIndexes.txt b/docs/reference/method/MongoDBCollection-dropIndexes.txt index 6e052cb27..32c1c1345 100644 --- a/docs/reference/method/MongoDBCollection-dropIndexes.txt +++ b/docs/reference/method/MongoDBCollection-dropIndexes.txt @@ -27,8 +27,7 @@ Parameters ``$indexName`` : string| :phpclass:`MongoDB\Model\IndexInfo` The name or model object of the index to drop. View the existing indexes on - the collection using the :phpmethod:`listIndexes() - ` method. + the collection by using the :phpmethod:`MongoDB\Collection::listIndexes()` method. ``$options`` : array An array specifying the desired options. diff --git a/docs/reference/method/MongoDBCollection-updateMany.txt b/docs/reference/method/MongoDBCollection-updateMany.txt index 9d567ec34..0ada743b6 100644 --- a/docs/reference/method/MongoDBCollection-updateMany.txt +++ b/docs/reference/method/MongoDBCollection-updateMany.txt @@ -33,9 +33,9 @@ Parameters ``$update`` : array|object Specifies the field and value combinations to update and any relevant update - operators. ``$update`` uses MongoDB's :manual:`update operators - `. Starting with MongoDB 4.2, an `aggregation - pipeline `_ + operators. ``$update`` uses MongoDB's :manual:`update operators `. + Starting with MongoDB 4.2, an `aggregation pipeline + `_ can be passed as this parameter. ``$options`` : array diff --git a/docs/reference/method/MongoDBGridFSBucket-registerGlobalStreamWrapperAlias.txt b/docs/reference/method/MongoDBGridFSBucket-registerGlobalStreamWrapperAlias.txt index 2d8fe60d0..405b0d3ee 100644 --- a/docs/reference/method/MongoDBGridFSBucket-registerGlobalStreamWrapperAlias.txt +++ b/docs/reference/method/MongoDBGridFSBucket-registerGlobalStreamWrapperAlias.txt @@ -19,7 +19,7 @@ Definition Registers an alias for the bucket, which enables files within the bucket to be accessed using a basic filename string (e.g. - `gridfs:///`). + ``gridfs:///``). .. code-block:: php @@ -58,7 +58,7 @@ revision is read (revision ``-1``). In write mode, the stream context can contain the option ``gridfs['chunkSizeBytes']``. If omitted, the defaults are inherited from the ``Bucket`` instance option. -The functions `rename` and `unlink` will rename or remove all revisions of a +The functions ``rename`` and ``unlink`` will rename or remove all revisions of a filename. If the filename does not exist, these functions throw a ``FileNotFoundException``. Example diff --git a/docs/tutorial/encryption.txt b/docs/tutorial/encryption.txt index 3a9121658..375662f4b 100644 --- a/docs/tutorial/encryption.txt +++ b/docs/tutorial/encryption.txt @@ -19,45 +19,43 @@ To get started using in-use encryption in your project, the to be compiled with `libmongocrypt `_ (enabled by default). -Additionally, either `crypt_shared`_ or `mongocryptd`_ are required in order to +Additionally, either ``crypt_shared`` or ``mongocryptd`` are required in order to use *automatic* client-side encryption. Neither is required for *explicit* encryption. - -crypt_shared -~~~~~~~~~~~~ +``crypt_shared`` +~~~~~~~~~~~~~~~~ The :manual:`Automatic Encryption Shared Library ` -(crypt_shared) provides the same functionality as mongocryptd_, but does not +(``crypt_shared``) provides the same functionality as ``mongocryptd``, but does not require you to spawn another process to perform automatic encryption. -By default, the PHP driver attempts to load crypt_shared from the system path(s) -and uses it automatically if found. To load crypt_shared from another location, +By default, the PHP driver attempts to load ``crypt_shared`` from the system path(s) +and uses it automatically if found. To load ``crypt_shared`` from another location, use the ``cryptSharedLibPath`` auto encryption :php:`driver option ` -when constructing a client. If the driver cannot load crypt_shared it will -attempt to fallback to using mongocryptd by default. The -``cryptSharedLibRequired`` option may be used to always require crypt_shared and +when constructing a client. If the driver cannot load ``crypt_shared`` it will +attempt to fallback to using ``mongocryptd`` by default. The +``cryptSharedLibRequired`` option may be used to always require ``crypt_shared`` and fail if it cannot be loaded. For detailed installation instructions see the MongoDB documentation for the :manual:`Automatic Encryption Shared Library `. +``mongocryptd`` +~~~~~~~~~~~~~~~ -mongocryptd -~~~~~~~~~~~ - -The mongocryptd binary is an alternative requirement for automatic client-side +The ``mongocryptd`` binary is an alternative requirement for automatic client-side encryption and is included as a component in the :manual:`MongoDB Enterprise Server package `. For detailed installation instructions see the :manual:`MongoDB documentation on mongocryptd `. -mongocryptd performs the following: +``mongocryptd`` performs the following: - Parses the automatic encryption rules specified in the client configuration. If the ``schemaMap`` auto encryption driver option contains invalid syntax, - mongocryptd returns an error. + ``mongocryptd`` returns an error. - Uses the specified automatic encryption rules to mark fields in read and write operations for encryption. @@ -67,14 +65,13 @@ mongocryptd performs the following: see :manual:`Supported Operations for Automatic Encryption `. A client configured with auto encryption will automatically spawn the -mongocryptd process from the application's ``PATH``. Applications can control +``mongocryptd`` process from the application's ``PATH``. Applications can control the spawning behavior via various auto encryption :php:`driver options `. -mongocryptd is only responsible for supporting automatic client-side encryption +``mongocryptd`` is only responsible for supporting automatic client-side encryption and does not itself perform any encryption or decryption. - Managing Encryption Keys ------------------------ @@ -105,7 +102,6 @@ encryption key (e.g. user-specific encryption keys) or create them dynamically. .. literalinclude:: /examples/encryption/create_data_key.php :language: php - .. _alt_name: Referencing Encryption Keys by an Alternative Name @@ -208,7 +204,7 @@ Explicit Encryption ~~~~~~~~~~~~~~~~~~~ Explicit encryption is a MongoDB community feature and does not use -crypt_shared_ or mongocryptd_. Explicit encryption is provided by the +``crypt_shared`` or ``mongocryptd``. Explicit encryption is provided by the :php:`MongoDB\Driver\ClientEncryption ` class. .. literalinclude:: /examples/encryption/csfle-explicit_encryption.php