From 265476f8512c7c4da568f590e8231b149cbafa0a Mon Sep 17 00:00:00 2001 From: Lindsey Moore Date: Thu, 19 Sep 2024 16:03:28 -0400 Subject: [PATCH 1/9] DOCSP-41991 What's New --- source/whats-new.txt | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/source/whats-new.txt b/source/whats-new.txt index 420fd640..7cb4f9a9 100644 --- a/source/whats-new.txt +++ b/source/whats-new.txt @@ -32,4 +32,15 @@ What's New in 1.20 Support for MongoDB Server v3.6 is removed in this release of the library. -- Adds support for MongoDB Server v8.0. \ No newline at end of file +- Adds support for MongoDB Server v8.0. + +What's New in 1.18 +------------------ + +- Adds a new GridFS API to make it more convenient to work with files using PHP's + existing filesystem functions. The :ref:`MongoDB\GridFS\Bucket::registerGlobalStreamWrapperAlias() ` + method may be used to register a global alias for a GridFS bucket. After doing so, files within that bucket + can be accessed using only a file URI (e.g. "gridfs://mybucket/hello.txt"). A demonstration of this + API can be found in the `gridfs_stream_wrapper.php `_ + example script. + From 13ff9620f37fd3891bd208aa1927cdb473040861 Mon Sep 17 00:00:00 2001 From: Lindsey Moore Date: Fri, 20 Sep 2024 17:35:35 -0400 Subject: [PATCH 2/9] add rest of versions --- .../method/MongoDBClient-addSubscriber.txt | 2 + .../method/MongoDBClient-removeSubscriber.txt | 2 + ...ucket-registerGlobalStreamWrapperAlias.txt | 2 + source/whats-new.txt | 90 ++++++++++++++++++- 4 files changed, 92 insertions(+), 4 deletions(-) diff --git a/source/reference/method/MongoDBClient-addSubscriber.txt b/source/reference/method/MongoDBClient-addSubscriber.txt index 9a3344b0..5feb3b6e 100644 --- a/source/reference/method/MongoDBClient-addSubscriber.txt +++ b/source/reference/method/MongoDBClient-addSubscriber.txt @@ -1,3 +1,5 @@ +.. _api-client-add-subscriber: + ================================ MongoDB\\Client::addSubscriber() ================================ diff --git a/source/reference/method/MongoDBClient-removeSubscriber.txt b/source/reference/method/MongoDBClient-removeSubscriber.txt index e95f74e7..7fde784f 100644 --- a/source/reference/method/MongoDBClient-removeSubscriber.txt +++ b/source/reference/method/MongoDBClient-removeSubscriber.txt @@ -1,3 +1,5 @@ +.. _api-client-remove-subscriber: + =================================== MongoDB\\Client::removeSubscriber() =================================== diff --git a/source/reference/method/MongoDBGridFSBucket-registerGlobalStreamWrapperAlias.txt b/source/reference/method/MongoDBGridFSBucket-registerGlobalStreamWrapperAlias.txt index 405b0d3e..1bdaa409 100644 --- a/source/reference/method/MongoDBGridFSBucket-registerGlobalStreamWrapperAlias.txt +++ b/source/reference/method/MongoDBGridFSBucket-registerGlobalStreamWrapperAlias.txt @@ -1,3 +1,5 @@ +.. _api-gridfs-bucket-register-global: + =========================================================== MongoDB\\GridFS\\Bucket::registerGlobalStreamWrapperAlias() =========================================================== diff --git a/source/whats-new.txt b/source/whats-new.txt index 7cb4f9a9..77bf2d74 100644 --- a/source/whats-new.txt +++ b/source/whats-new.txt @@ -22,6 +22,14 @@ following versions of the {+php-library+}: * :ref:`Version 1.20 ` +* :ref:`Version 1.18 ` + +* :ref:`Version 1.17 ` + +* :ref:`Version 1.16 ` + +* :ref:`Version 1.15 ` + .. _php-lib-version-1.20: What's New in 1.20 @@ -34,13 +42,87 @@ What's New in 1.20 - Adds support for MongoDB Server v8.0. +.. _php-lib-version-1.18: + What's New in 1.18 ------------------ - Adds a new GridFS API to make it more convenient to work with files using PHP's - existing filesystem functions. The :ref:`MongoDB\GridFS\Bucket::registerGlobalStreamWrapperAlias() ` - method may be used to register a global alias for a GridFS bucket. After doing so, files within that bucket - can be accessed using only a file URI (e.g. "gridfs://mybucket/hello.txt"). A demonstration of this - API can be found in the `gridfs_stream_wrapper.php `_ + existing filesystem functions. The :ref:`MongoDB\GridFS\Bucket::registerGlobalStreamWrapperAlias() ` + method may be used to register a global alias for a GridFS bucket. After + doing so, files within that bucket can be accessed using only a file URI + (e.g. "gridfs://mybucket/hello.txt"). A demonstration of this API can be found + in the `gridfs_stream_wrapper.php `_ example script. +- The ``MongoDB\Client`` class now has :ref:`addSubscriber() ` + and :ref:`removeSubscriber()` methods to make it + easier to register monitoring classes on the underlying ``MongoDB\Driver\Manager`` + object. + +To learn more about this release, see the `v1.18 Release Notes +`__ on GitHub. + +.. _php-lib-version-1.17: + +What's New in 1.17 +------------------ + +- Introduces a new "codec" API for converting BSON to and from PHP objects. + More information on this feature may be found in the + :ref:`Codecs tutorial `. + +- Adds :ref:`MongoDB\add_logger() ` and + :ref:`MongoDB\remove_logger() ` functions to the library. + These functions allow applications to register a `PSR-3 Logger `__ + to receive log messages emitted by the driver. Previously, logs were only + accessible via the extension's `mongodb.debug `__ + INI setting. + +- Introduces new :ref:`MongoDB\Collection ` methods + to create and manage :atlas:`Atlas Search indexes `. Atlas + Search indexes can be queried using the :manual:`$search ` + aggregation pipeline stage, which is supported in all versions of the library. + +- Upgrades the ``mongodb`` extension requirement to 1.17.0. Support for PHP + 7.2 and 7.3 has been removed and the library now requires PHP 7.4 or newer. + +To learn more about this release, see the `v1.17 Release Notes +`__ on GitHub. + +.. _php-lib-version-1.16: + +What's New in 1.16 +------------------ + +- Introduces support for :v7.0:`MongoDB 7.0 `. + +- Introduces :ref:`MongoDB\Database::createEncryptedCollection() `. + This method automatically creates data encryption keys when creating a new + encrypted collection. + +- This release upgrades the ``mongodb`` extension requirement to 1.16.0. + +To learn more about this release, see the `v1.16 Release Notes +`__ on GitHub. + +.. _php-lib-version-1.15: + +What's New in 1.15 +------------------ + +- Adds new ``examples/`` and ``tools/`` directories to library repository, + which contain code snippets and scripts that may prove useful when writing + or debugging applications, respectively. These directories are intended to + supplement the library's existing documentation, and will be added to over time. + +- Various backwards compatible typing improvements have been made throughout the + library. Downstream impact for these changes are discussed in + `UPGRADE-1.15.md `__. + +- Integrates `Psalm `__ for static analysis. + +- This release upgrades the ``mongodb`` extension requirement to 1.15.0. + +To learn more about this release, see the `v1.15 Release Notes +`__ on GitHub. From 99c571d432de8f9e4459c8feea246570ddd4df52 Mon Sep 17 00:00:00 2001 From: Lindsey Moore Date: Fri, 20 Sep 2024 17:54:57 -0400 Subject: [PATCH 3/9] fix links --- source/reference/function/add_logger.txt | 2 ++ source/reference/function/remove_logger.txt | 2 ++ 2 files changed, 4 insertions(+) diff --git a/source/reference/function/add_logger.txt b/source/reference/function/add_logger.txt index 69076915..b1c3046c 100644 --- a/source/reference/function/add_logger.txt +++ b/source/reference/function/add_logger.txt @@ -1,3 +1,5 @@ +.. _api-add-logger: + ===================== MongoDB\\add_logger() ===================== diff --git a/source/reference/function/remove_logger.txt b/source/reference/function/remove_logger.txt index 369c5c13..41162dde 100644 --- a/source/reference/function/remove_logger.txt +++ b/source/reference/function/remove_logger.txt @@ -1,3 +1,5 @@ +.. _api-remove-logger: + ======================== MongoDB\\remove_logger() ======================== From de61ae17c297cad270884875881788d418d11882 Mon Sep 17 00:00:00 2001 From: Lindsey Moore Date: Fri, 20 Sep 2024 17:57:52 -0400 Subject: [PATCH 4/9] fix links --- source/reference/class/MongoDBCollection.txt | 2 ++ .../MongoDBDatabase-createEncryptedCollection.txt | 2 ++ source/whats-new.txt | 10 +++++----- 3 files changed, 9 insertions(+), 5 deletions(-) diff --git a/source/reference/class/MongoDBCollection.txt b/source/reference/class/MongoDBCollection.txt index 462ac4d9..b734755e 100644 --- a/source/reference/class/MongoDBCollection.txt +++ b/source/reference/class/MongoDBCollection.txt @@ -1,3 +1,5 @@ +.. _api-mongodb-collection-class: + ========================= MongoDB\\Collection Class ========================= diff --git a/source/reference/method/MongoDBDatabase-createEncryptedCollection.txt b/source/reference/method/MongoDBDatabase-createEncryptedCollection.txt index e6a266fb..9ee39aef 100644 --- a/source/reference/method/MongoDBDatabase-createEncryptedCollection.txt +++ b/source/reference/method/MongoDBDatabase-createEncryptedCollection.txt @@ -1,3 +1,5 @@ +.. _api-database-create-encrypted: + ============================================== MongoDB\\Database::createEncryptedCollection() ============================================== diff --git a/source/whats-new.txt b/source/whats-new.txt index 77bf2d74..9b4e026d 100644 --- a/source/whats-new.txt +++ b/source/whats-new.txt @@ -52,13 +52,13 @@ What's New in 1.18 method may be used to register a global alias for a GridFS bucket. After doing so, files within that bucket can be accessed using only a file URI (e.g. "gridfs://mybucket/hello.txt"). A demonstration of this API can be found - in the `gridfs_stream_wrapper.php `_ + in the `gridfs_stream_wrapper.php `__ example script. -- The ``MongoDB\Client`` class now has :ref:`addSubscriber() ` - and :ref:`removeSubscriber()` methods to make it - easier to register monitoring classes on the underlying ``MongoDB\Driver\Manager`` - object. +- Adds :ref:`addSubscriber() ` and + :ref:`removeSubscriber()` methods to the + ``MongoDB\Client`` class to make it easier to register monitoring classes + on the underlying ``MongoDB\Driver\Manager`` object. To learn more about this release, see the `v1.18 Release Notes `__ on GitHub. From 122f58f580e6f7bf402b7a0f20ec7bf9735b3f51 Mon Sep 17 00:00:00 2001 From: Lindsey Moore Date: Mon, 23 Sep 2024 15:51:46 -0400 Subject: [PATCH 5/9] review comments --- source/reference/class/MongoDBCollection.txt | 2 - source/reference/function/add_logger.txt | 2 - source/reference/function/remove_logger.txt | 2 - .../method/MongoDBClient-addSubscriber.txt | 2 - .../method/MongoDBClient-removeSubscriber.txt | 2 - ...goDBDatabase-createEncryptedCollection.txt | 2 - ...ucket-registerGlobalStreamWrapperAlias.txt | 2 - source/whats-new.txt | 37 ++++++++++--------- 8 files changed, 20 insertions(+), 31 deletions(-) diff --git a/source/reference/class/MongoDBCollection.txt b/source/reference/class/MongoDBCollection.txt index b734755e..462ac4d9 100644 --- a/source/reference/class/MongoDBCollection.txt +++ b/source/reference/class/MongoDBCollection.txt @@ -1,5 +1,3 @@ -.. _api-mongodb-collection-class: - ========================= MongoDB\\Collection Class ========================= diff --git a/source/reference/function/add_logger.txt b/source/reference/function/add_logger.txt index b1c3046c..69076915 100644 --- a/source/reference/function/add_logger.txt +++ b/source/reference/function/add_logger.txt @@ -1,5 +1,3 @@ -.. _api-add-logger: - ===================== MongoDB\\add_logger() ===================== diff --git a/source/reference/function/remove_logger.txt b/source/reference/function/remove_logger.txt index 41162dde..369c5c13 100644 --- a/source/reference/function/remove_logger.txt +++ b/source/reference/function/remove_logger.txt @@ -1,5 +1,3 @@ -.. _api-remove-logger: - ======================== MongoDB\\remove_logger() ======================== diff --git a/source/reference/method/MongoDBClient-addSubscriber.txt b/source/reference/method/MongoDBClient-addSubscriber.txt index 5feb3b6e..9a3344b0 100644 --- a/source/reference/method/MongoDBClient-addSubscriber.txt +++ b/source/reference/method/MongoDBClient-addSubscriber.txt @@ -1,5 +1,3 @@ -.. _api-client-add-subscriber: - ================================ MongoDB\\Client::addSubscriber() ================================ diff --git a/source/reference/method/MongoDBClient-removeSubscriber.txt b/source/reference/method/MongoDBClient-removeSubscriber.txt index 7fde784f..e95f74e7 100644 --- a/source/reference/method/MongoDBClient-removeSubscriber.txt +++ b/source/reference/method/MongoDBClient-removeSubscriber.txt @@ -1,5 +1,3 @@ -.. _api-client-remove-subscriber: - =================================== MongoDB\\Client::removeSubscriber() =================================== diff --git a/source/reference/method/MongoDBDatabase-createEncryptedCollection.txt b/source/reference/method/MongoDBDatabase-createEncryptedCollection.txt index 9ee39aef..e6a266fb 100644 --- a/source/reference/method/MongoDBDatabase-createEncryptedCollection.txt +++ b/source/reference/method/MongoDBDatabase-createEncryptedCollection.txt @@ -1,5 +1,3 @@ -.. _api-database-create-encrypted: - ============================================== MongoDB\\Database::createEncryptedCollection() ============================================== diff --git a/source/reference/method/MongoDBGridFSBucket-registerGlobalStreamWrapperAlias.txt b/source/reference/method/MongoDBGridFSBucket-registerGlobalStreamWrapperAlias.txt index 1bdaa409..405b0d3e 100644 --- a/source/reference/method/MongoDBGridFSBucket-registerGlobalStreamWrapperAlias.txt +++ b/source/reference/method/MongoDBGridFSBucket-registerGlobalStreamWrapperAlias.txt @@ -1,5 +1,3 @@ -.. _api-gridfs-bucket-register-global: - =========================================================== MongoDB\\GridFS\\Bucket::registerGlobalStreamWrapperAlias() =========================================================== diff --git a/source/whats-new.txt b/source/whats-new.txt index 9b4e026d..96bb4fb5 100644 --- a/source/whats-new.txt +++ b/source/whats-new.txt @@ -35,12 +35,12 @@ following versions of the {+php-library+}: What's New in 1.20 ------------------ -.. important:: MongoDB Server v3.6 End-of-Life +.. important:: {+mdb-server+} v3.6 End-of-Life - Support for MongoDB Server v3.6 is removed in this release of the + Support for {+mdb-server+} v3.6 is removed in this release of the library. -- Adds support for MongoDB Server v8.0. +- Adds support for {+mdb-server+} v8.0. .. _php-lib-version-1.18: @@ -48,15 +48,15 @@ What's New in 1.18 ------------------ - Adds a new GridFS API to make it more convenient to work with files using PHP's - existing filesystem functions. The :ref:`MongoDB\GridFS\Bucket::registerGlobalStreamWrapperAlias() ` + existing filesystem functions. The :phpmethod:`MongoDB\GridFS\Bucket::registerGlobalStreamWrapperAlias()` method may be used to register a global alias for a GridFS bucket. After - doing so, files within that bucket can be accessed using only a file URI + doing so, files within that bucket can be accessed by using only a file URI (e.g. "gridfs://mybucket/hello.txt"). A demonstration of this API can be found in the `gridfs_stream_wrapper.php `__ example script. -- Adds :ref:`addSubscriber() ` and - :ref:`removeSubscriber()` methods to the +- Adds :phpmethod:`MongoDB\Client::addSubscriber()` and + :phpmethod:`MongoDB\Client::removeSubscriber()` methods to the ``MongoDB\Client`` class to make it easier to register monitoring classes on the underlying ``MongoDB\Driver\Manager`` object. @@ -72,17 +72,20 @@ What's New in 1.17 More information on this feature may be found in the :ref:`Codecs tutorial `. -- Adds :ref:`MongoDB\add_logger() ` and - :ref:`MongoDB\remove_logger() ` functions to the library. +- Adds :phpmethod:`MongoDB\add_logger()` and + :phpmethod:`MongoDB\remove_logger()` functions to the library. These functions allow applications to register a `PSR-3 Logger `__ to receive log messages emitted by the driver. Previously, logs were only accessible via the extension's `mongodb.debug `__ INI setting. -- Introduces new :ref:`MongoDB\Collection ` methods - to create and manage :atlas:`Atlas Search indexes `. Atlas - Search indexes can be queried using the :manual:`$search ` +- Introduces new :phpclass:`MongoDB\Collection` methods to create and manage + Atlas Search indexes. Atlas Search indexes can be queried using the ``$search`` aggregation pipeline stage, which is supported in all versions of the library. + To learn more about Atlas Search indexes and the specfics of the ``$search`` + aggregation stage, see the :atlas:`Atlas Search indexes ` + documentation and :manual:`$search `, + respectively. - Upgrades the ``mongodb`` extension requirement to 1.17.0. Support for PHP 7.2 and 7.3 has been removed and the library now requires PHP 7.4 or newer. @@ -97,7 +100,7 @@ What's New in 1.16 - Introduces support for :v7.0:`MongoDB 7.0 `. -- Introduces :ref:`MongoDB\Database::createEncryptedCollection() `. +- Introduces :phpmethod:`MongoDB\Database::createEncryptedCollection()`. This method automatically creates data encryption keys when creating a new encrypted collection. @@ -111,18 +114,18 @@ To learn more about this release, see the `v1.16 Release Notes What's New in 1.15 ------------------ -- Adds new ``examples/`` and ``tools/`` directories to library repository, +- Adds new ``examples/`` and ``tools/`` directories to the library repository, which contain code snippets and scripts that may prove useful when writing or debugging applications, respectively. These directories are intended to - supplement the library's existing documentation, and will be added to over time. + supplement the library's existing documentation and will be added to over time. -- Various backwards compatible typing improvements have been made throughout the +- Adds various backwards compatible typing improvements throughout the library. Downstream impact for these changes are discussed in `UPGRADE-1.15.md `__. - Integrates `Psalm `__ for static analysis. -- This release upgrades the ``mongodb`` extension requirement to 1.15.0. +- Upgrades the ``mongodb`` extension requirement to 1.15.0. To learn more about this release, see the `v1.15 Release Notes `__ on GitHub. From c4b9611f6d7bb0f916b7fbc41a8ff2993969c833 Mon Sep 17 00:00:00 2001 From: Lindsey Moore Date: Mon, 23 Sep 2024 15:59:20 -0400 Subject: [PATCH 6/9] typo --- source/whats-new.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/whats-new.txt b/source/whats-new.txt index 96bb4fb5..446174f7 100644 --- a/source/whats-new.txt +++ b/source/whats-new.txt @@ -82,7 +82,7 @@ What's New in 1.17 - Introduces new :phpclass:`MongoDB\Collection` methods to create and manage Atlas Search indexes. Atlas Search indexes can be queried using the ``$search`` aggregation pipeline stage, which is supported in all versions of the library. - To learn more about Atlas Search indexes and the specfics of the ``$search`` + To learn more about Atlas Search indexes and the specifics of the ``$search`` aggregation stage, see the :atlas:`Atlas Search indexes ` documentation and :manual:`$search `, respectively. From 83aa662c2ab876f96e523e5ab3acb15251ea8dcd Mon Sep 17 00:00:00 2001 From: Lindsey Moore Date: Mon, 23 Sep 2024 19:01:31 -0400 Subject: [PATCH 7/9] review comments --- source/whats-new.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/whats-new.txt b/source/whats-new.txt index 446174f7..7d39f5e7 100644 --- a/source/whats-new.txt +++ b/source/whats-new.txt @@ -58,7 +58,7 @@ What's New in 1.18 - Adds :phpmethod:`MongoDB\Client::addSubscriber()` and :phpmethod:`MongoDB\Client::removeSubscriber()` methods to the ``MongoDB\Client`` class to make it easier to register monitoring classes - on the underlying ``MongoDB\Driver\Manager`` object. + scoped to the underlying ``MongoDB\Driver\Manager`` object. To learn more about this release, see the `v1.18 Release Notes `__ on GitHub. @@ -104,7 +104,7 @@ What's New in 1.16 This method automatically creates data encryption keys when creating a new encrypted collection. -- This release upgrades the ``mongodb`` extension requirement to 1.16.0. +- Upgrades the ``mongodb`` extension requirement to 1.16.0. To learn more about this release, see the `v1.16 Release Notes `__ on GitHub. From f3de45a4974a7b68a6dd432a69e8283e49cb7db7 Mon Sep 17 00:00:00 2001 From: Lindsey Moore Date: Tue, 24 Sep 2024 13:51:45 -0400 Subject: [PATCH 8/9] vale errors --- source/whats-new.txt | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/source/whats-new.txt b/source/whats-new.txt index 7d39f5e7..d0925c32 100644 --- a/source/whats-new.txt +++ b/source/whats-new.txt @@ -76,7 +76,7 @@ What's New in 1.17 :phpmethod:`MongoDB\remove_logger()` functions to the library. These functions allow applications to register a `PSR-3 Logger `__ to receive log messages emitted by the driver. Previously, logs were only - accessible via the extension's `mongodb.debug `__ + available through the extension's `mongodb.debug `__ INI setting. - Introduces new :phpclass:`MongoDB\Collection` methods to create and manage @@ -84,8 +84,7 @@ What's New in 1.17 aggregation pipeline stage, which is supported in all versions of the library. To learn more about Atlas Search indexes and the specifics of the ``$search`` aggregation stage, see the :atlas:`Atlas Search indexes ` - documentation and :manual:`$search `, - respectively. + documentation and :manual:`$search `. - Upgrades the ``mongodb`` extension requirement to 1.17.0. Support for PHP 7.2 and 7.3 has been removed and the library now requires PHP 7.4 or newer. @@ -116,7 +115,7 @@ What's New in 1.15 - Adds new ``examples/`` and ``tools/`` directories to the library repository, which contain code snippets and scripts that may prove useful when writing - or debugging applications, respectively. These directories are intended to + or debugging applications. These directories are intended to supplement the library's existing documentation and will be added to over time. - Adds various backwards compatible typing improvements throughout the From d6803c437df61540ab2500529d03332529ff90f5 Mon Sep 17 00:00:00 2001 From: Lindsey Moore Date: Tue, 24 Sep 2024 13:55:23 -0400 Subject: [PATCH 9/9] small thing --- source/whats-new.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/whats-new.txt b/source/whats-new.txt index d0925c32..49bc54c3 100644 --- a/source/whats-new.txt +++ b/source/whats-new.txt @@ -77,7 +77,7 @@ What's New in 1.17 These functions allow applications to register a `PSR-3 Logger `__ to receive log messages emitted by the driver. Previously, logs were only available through the extension's `mongodb.debug `__ - INI setting. + ``INI`` setting. - Introduces new :phpclass:`MongoDB\Collection` methods to create and manage Atlas Search indexes. Atlas Search indexes can be queried using the ``$search``