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-48028: v5.2 release #3297

Merged
merged 4 commits into from
Mar 4, 2025
Merged
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
8 changes: 7 additions & 1 deletion docs/compatibility.txt
Original file line number Diff line number Diff line change
@@ -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, laravel 12, 4.0, 4.1, 4.2, 5.0, 5.1, 5.2

Laravel Compatibility
---------------------
@@ -28,3 +28,9 @@ 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+} v5.2 or later, you must install v1.21 of the
{+php-library+} and {+php-extension+}.
4 changes: 2 additions & 2 deletions docs/filesystems.txt
Original file line number Diff line number Diff line change
@@ -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
22 changes: 0 additions & 22 deletions docs/fundamentals/aggregation-builder.txt
Original file line number Diff line number Diff line change
@@ -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
10 changes: 10 additions & 0 deletions docs/includes/framework-compatibility-laravel.rst
Original file line number Diff line number Diff line change
@@ -3,21 +3,31 @@
:stub-columns: 1

* - {+odm-long+} Version
- Laravel 12.x
- Laravel 11.x
- Laravel 10.x
- Laravel 9.x

* - 5.2
- ✓
- ✓
- ✓
-

* - 4.2 to 5.1
-
- ✓
- ✓
-

* - 4.1
-
-
- ✓
-

* - 4.0
-
-
- ✓
-
2 changes: 1 addition & 1 deletion docs/query-builder.txt
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 1 addition & 1 deletion docs/quick-start.txt
Original file line number Diff line number Diff line change
@@ -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 <https://www.mongodb.com/docs/php-library/current/tutorial/connecting/>`__
Laravel, see `Connect to MongoDB <https://www.mongodb.com/docs/php-library/current/connect/>`__
in the {+php-library+} documentation.

The {+odm-short+} extends the Laravel Eloquent and Query Builder syntax to
2 changes: 1 addition & 1 deletion docs/quick-start/download-and-install.txt
Original file line number Diff line number Diff line change
@@ -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
5 changes: 3 additions & 2 deletions docs/user-authentication.txt
Original file line number Diff line number Diff line change
@@ -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 <https://laravel.com/docs/{+laravel-docs-version+}/authentication>`__
in the Laravel documentation.

To learn more about Eloquent models, see the :ref:`laravel-eloquent-model-class` guide.
To learn more about Eloquent models, see the
:ref:`laravel-eloquent-model-class` guide.