From b0cd2ef26770372667ece28532efc9d5264ad7b1 Mon Sep 17 00:00:00 2001 From: rustagir Date: Mon, 3 Mar 2025 15:48:40 -0500 Subject: [PATCH 1/4] DOCSP-48028: v5.2 release --- docs/compatibility.txt | 2 +- docs/filesystems.txt | 4 ++-- docs/includes/framework-compatibility-laravel.rst | 2 +- docs/query-builder.txt | 2 +- docs/quick-start/download-and-install.txt | 2 +- docs/user-authentication.txt | 5 +++-- 6 files changed, 9 insertions(+), 8 deletions(-) diff --git a/docs/compatibility.txt b/docs/compatibility.txt index fd3e2da02..ad589e892 100644 --- a/docs/compatibility.txt +++ b/docs/compatibility.txt @@ -15,7 +15,7 @@ Compatibility :class: singlecol .. meta:: - :keywords: laravel 9, laravel 10, laravel 11, 4.0, 4.1, 4.2, 5.0, 5.1 + :keywords: laravel 9, laravel 10, laravel 11, 4.0, 4.1, 4.2, 5.0, 5.1, 5.2 Laravel Compatibility --------------------- diff --git a/docs/filesystems.txt b/docs/filesystems.txt index 3ec7ee41f..c62853f58 100644 --- a/docs/filesystems.txt +++ b/docs/filesystems.txt @@ -79,7 +79,7 @@ You can configure the following settings in ``config/filesystems.php``: * - ``throw`` - If ``true``, exceptions are thrown when an operation cannot be performed. If ``false``, - operations return ``true`` on success and ``false`` on error. Defaults to ``false``. + operations return ``true`` on success and ``false`` on error. Defaults to ``false``. You can also use a factory or a service name to create an instance of ``MongoDB\GridFS\Bucket``. In this case, the options ``connection`` and ``database`` are ignored: @@ -133,7 +133,7 @@ metadata, including the file name and a unique ObjectId. If multiple documents share the same file name, they are considered "revisions" and further distinguished by creation timestamps. -The Laravel MongoDB integration uses the GridFS Flysystem adapter. It interacts +{+odm-long+} uses the GridFS Flysystem adapter. It interacts with file revisions in the following ways: - Reading a file reads the last revision of this file name diff --git a/docs/includes/framework-compatibility-laravel.rst b/docs/includes/framework-compatibility-laravel.rst index 16c405e21..707edcac5 100644 --- a/docs/includes/framework-compatibility-laravel.rst +++ b/docs/includes/framework-compatibility-laravel.rst @@ -7,7 +7,7 @@ - Laravel 10.x - Laravel 9.x - * - 4.2 to 5.1 + * - 4.2 to 5.2 - ✓ - ✓ - diff --git a/docs/query-builder.txt b/docs/query-builder.txt index 76a0d144a..c641323dc 100644 --- a/docs/query-builder.txt +++ b/docs/query-builder.txt @@ -227,7 +227,7 @@ value greater than ``8.5`` and a ``year`` value of less than .. tip:: - For compatibility with Laravel, Laravel MongoDB v5.1 supports both arrow + For compatibility with Laravel, {+odm-long+} v5.1 supports both arrow (``->``) and dot (``.``) notation to access nested fields in a query filter. The preceding example uses dot notation to query the ``imdb.rating`` nested field, which is the recommended syntax. diff --git a/docs/quick-start/download-and-install.txt b/docs/quick-start/download-and-install.txt index 696861a43..293425791 100644 --- a/docs/quick-start/download-and-install.txt +++ b/docs/quick-start/download-and-install.txt @@ -31,7 +31,7 @@ to a Laravel web application. .. tip:: As an alternative to the following installation steps, you can use Laravel Herd - to install MongoDB and configure a Laravel MongoDB development environment. For + to install MongoDB and configure a development environment for {+odm-long+}. For more information about using Laravel Herd with MongoDB, see the following resources: - `Installing MongoDB via Herd Pro diff --git a/docs/user-authentication.txt b/docs/user-authentication.txt index 88b0da603..63e883d13 100644 --- a/docs/user-authentication.txt +++ b/docs/user-authentication.txt @@ -224,7 +224,7 @@ to the ``guards`` array: ], ], -Use Laravel Passport with Laravel MongoDB +Use Laravel Passport with {+odm-long+} ````````````````````````````````````````` After installing Laravel Passport, you must enable Passport compatibility with MongoDB by @@ -300,4 +300,5 @@ Additional Information To learn more about user authentication, see `Authentication `__ in the Laravel documentation. -To learn more about Eloquent models, see the :ref:`laravel-eloquent-model-class` guide. \ No newline at end of file +To learn more about Eloquent models, see the +:ref:`laravel-eloquent-model-class` guide. From d49b7dd92c402fb608cd1928151c0b957072c4de Mon Sep 17 00:00:00 2001 From: rustagir Date: Mon, 3 Mar 2025 16:05:07 -0500 Subject: [PATCH 2/4] wip --- docs/compatibility.txt | 5 +++++ docs/includes/framework-compatibility-laravel.rst | 12 +++++++++++- docs/quick-start.txt | 2 +- 3 files changed, 17 insertions(+), 2 deletions(-) diff --git a/docs/compatibility.txt b/docs/compatibility.txt index ad589e892..3942b1a9a 100644 --- a/docs/compatibility.txt +++ b/docs/compatibility.txt @@ -28,3 +28,8 @@ the {+odm-short+} that you can use together. To find compatibility information for unmaintained versions of the {+odm-short+}, see `Laravel Version Compatibility <{+mongodb-laravel-gh+}/blob/3.9/README.md#installation>`__ on GitHub. + +PHP Driver Compatibility +------------------------ + +To use {+odm-long+}, you must use v1.21 of the {+php-library+} and {+php-extension+}. diff --git a/docs/includes/framework-compatibility-laravel.rst b/docs/includes/framework-compatibility-laravel.rst index 707edcac5..c642a6763 100644 --- a/docs/includes/framework-compatibility-laravel.rst +++ b/docs/includes/framework-compatibility-laravel.rst @@ -3,21 +3,31 @@ :stub-columns: 1 * - {+odm-long+} Version + - Laravel 12.x - Laravel 11.x - Laravel 10.x - Laravel 9.x - * - 4.2 to 5.2 + * - 5.2 + - ✓ + - ✓ + - ✓ + - + + * - 4.2 to 5.1 + - - ✓ - ✓ - * - 4.1 + - - - ✓ - * - 4.0 + - - - ✓ - diff --git a/docs/quick-start.txt b/docs/quick-start.txt index 1d188ad84..83b0c3937 100644 --- a/docs/quick-start.txt +++ b/docs/quick-start.txt @@ -47,7 +47,7 @@ read and write operations on the data. MongoDB University Learning Byte. If you prefer to connect to MongoDB by using the {+php-library+} without - Laravel, see `Connecting to MongoDB `__ + Laravel, see `Connect to MongoDB `__ in the {+php-library+} documentation. The {+odm-short+} extends the Laravel Eloquent and Query Builder syntax to From 7825a3a6e907b1ca4e5615e77745f2a9ef7a8345 Mon Sep 17 00:00:00 2001 From: rustagir Date: Mon, 3 Mar 2025 16:16:32 -0500 Subject: [PATCH 3/4] wip --- docs/compatibility.txt | 3 ++- docs/fundamentals/aggregation-builder.txt | 22 ---------------------- 2 files changed, 2 insertions(+), 23 deletions(-) diff --git a/docs/compatibility.txt b/docs/compatibility.txt index 3942b1a9a..a1cad09fb 100644 --- a/docs/compatibility.txt +++ b/docs/compatibility.txt @@ -32,4 +32,5 @@ on GitHub. PHP Driver Compatibility ------------------------ -To use {+odm-long+}, you must use v1.21 of the {+php-library+} and {+php-extension+}. +To use {+odm-long+} v5.2 or later, you must use v1.21 of the +{+php-library+} and {+php-extension+}. diff --git a/docs/fundamentals/aggregation-builder.txt b/docs/fundamentals/aggregation-builder.txt index 3169acfeb..9ae31f0c1 100644 --- a/docs/fundamentals/aggregation-builder.txt +++ b/docs/fundamentals/aggregation-builder.txt @@ -37,7 +37,6 @@ The {+odm-long+} aggregation builder lets you build aggregation stages and aggregation pipelines. The following sections show examples of how to use the aggregation builder to create the stages of an aggregation pipeline: -- :ref:`laravel-add-aggregation-dependency` - :ref:`laravel-build-aggregation` - :ref:`laravel-aggregation-examples` - :ref:`laravel-create-custom-operator-factory` @@ -49,27 +48,6 @@ aggregation builder to create the stages of an aggregation pipeline: aggregation builder, see :ref:`laravel-query-builder-aggregations` in the Query Builder guide. -.. _laravel-add-aggregation-dependency: - -Add the Aggregation Builder Dependency --------------------------------------- - -The aggregation builder is part of the {+agg-builder-package-name+} package. -You must add this package as a dependency to your project to use it. Run the -following command to add the aggregation builder dependency to your -application: - -.. code-block:: bash - - composer require {+agg-builder-package-name+}:{+agg-builder-version+} - -When the installation completes, verify that the ``composer.json`` file -includes the following line in the ``require`` object: - -.. code-block:: json - - "{+agg-builder-package-name+}": "{+agg-builder-version+}", - .. _laravel-build-aggregation: Create Aggregation Stages From a3f215637fd04006ec11364fe996b56da7a86800 Mon Sep 17 00:00:00 2001 From: rustagir Date: Mon, 3 Mar 2025 16:43:11 -0500 Subject: [PATCH 4/4] add keyword --- docs/compatibility.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/compatibility.txt b/docs/compatibility.txt index a1cad09fb..9ee891e20 100644 --- a/docs/compatibility.txt +++ b/docs/compatibility.txt @@ -15,7 +15,7 @@ Compatibility :class: singlecol .. meta:: - :keywords: laravel 9, laravel 10, laravel 11, 4.0, 4.1, 4.2, 5.0, 5.1, 5.2 + :keywords: laravel 9, laravel 10, laravel 11, laravel 12, 4.0, 4.1, 4.2, 5.0, 5.1, 5.2 Laravel Compatibility --------------------- @@ -32,5 +32,5 @@ on GitHub. PHP Driver Compatibility ------------------------ -To use {+odm-long+} v5.2 or later, you must use v1.21 of the +To use {+odm-long+} v5.2 or later, you must install v1.21 of the {+php-library+} and {+php-extension+}.