Skip to content

Merge 4.8 into 5.0 #3112

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

Merged
merged 3 commits into from
Aug 23, 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/cache.txt
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ adds 5, and removes 2.

.. note::

{+odm-short+} supports incrementing and decrementing with integer and float values.
The {+odm-short+} supports incrementing and decrementing with integer and float values.

For more information about using the cache, see the `Laravel Cache documentation
<https://laravel.com/docs/{+laravel-docs-version+}/cache#cache-usage>`__.
Expand Down
4 changes: 2 additions & 2 deletions docs/compatibility.txt
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@ Laravel Compatibility
---------------------

The following compatibility table specifies the versions of Laravel and
{+odm-short+} that you can use together.
the {+odm-short+} that you can use together.

.. include:: /includes/framework-compatibility-laravel.rst

To find compatibility information for unmaintained versions of {+odm-short+},
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.
4 changes: 2 additions & 2 deletions docs/eloquent-models.txt
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,12 @@ Eloquent Models

Eloquent models are part of the Laravel Eloquent object-relational
mapping (ORM) framework, which lets you to work with data in a relational
database by using model classes and Eloquent syntax. {+odm-short+} extends
database by using model classes and Eloquent syntax. The {+odm-short+} extends
this framework so that you can use Eloquent syntax to work with data in a
MongoDB database.

This section contains guidance on how to use Eloquent models in
{+odm-short+} to work with MongoDB in the following ways:
the {+odm-short+} to work with MongoDB in the following ways:

- :ref:`laravel-eloquent-model-class` shows how to define models and customize
their behavior
Expand Down
24 changes: 12 additions & 12 deletions docs/eloquent-models/model-class.txt
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,12 @@ Eloquent Model Class
Overview
--------

This guide shows you how to use the {+odm-long+} to define and
This guide shows you how to use {+odm-long+} to define and
customize Laravel Eloquent models. You can use these models to work with
MongoDB data by using the Laravel Eloquent object-relational mapper (ORM).

The following sections explain how to add Laravel Eloquent ORM behaviors
to {+odm-short+} models:
to {+odm-long+} models:

- :ref:`laravel-model-define` demonstrates how to create a model class.
- :ref:`laravel-authenticatable-model` shows how to set MongoDB as the
Expand All @@ -47,7 +47,7 @@ Define an Eloquent Model Class
Eloquent models are classes that represent your data. They include methods
that perform database operations such as inserts, updates, and deletes.

To declare a {+odm-short+} model, create a class in the ``app/Models``
To declare a {+odm-long+} model, create a class in the ``app/Models``
directory of your Laravel application that extends
``MongoDB\Laravel\Eloquent\Model`` as shown in the following code example:

Expand Down Expand Up @@ -78,8 +78,8 @@ Extend the Authenticatable Model
--------------------------------

To configure MongoDB as the Laravel user provider, you can extend the
{+odm-short+} ``MongoDB\Laravel\Auth\User`` class. The following code example
shows how to extend this class:
{+odm-short+} ``MongoDB\Laravel\Auth\User`` class. The following code
example shows how to extend this class:

.. literalinclude:: /includes/eloquent-models/AuthenticatableUser.php
:language: php
Expand Down Expand Up @@ -155,7 +155,7 @@ To learn more about primary key behavior and customization options, see
in the Laravel docs.

To learn more about the ``_id`` field, ObjectIDs, and the MongoDB document
structure, see :manual:`Documents </core/document>` in the MongoDB server docs.
structure, see :manual:`Documents </core/document>` in the Server manual.

.. _laravel-model-soft-delete:

Expand Down Expand Up @@ -227,7 +227,7 @@ less than three years ago:
Planet::where( 'discovery_dt', '>', new DateTime('-3 years'))->get();

To learn more about MongoDB's data types, see :manual:`BSON Types </reference/bson-types/>`
in the MongoDB server docs.
in the Server manual.

To learn more about the Laravel casting helper and supported types, see `Attribute Casting <https://laravel.com/docs/{+laravel-docs-version+}/eloquent-mutators#attribute-casting>`__
in the Laravel docs.
Expand Down Expand Up @@ -289,7 +289,7 @@ in the Laravel docs.
Extend Third-Party Model Classes
--------------------------------

You can use {+odm-short+} to extend a third-party model class by
You can use the {+odm-short+} to extend a third-party model class by
including the ``DocumentModel`` trait when defining your model class. By
including this trait, you can make the third-party class compatible with
MongoDB.
Expand All @@ -299,7 +299,7 @@ declare the following properties in your class:

- ``$primaryKey = '_id'``, because the ``_id`` field uniquely
identifies MongoDB documents
- ``$keyType = 'string'``, because {+odm-short+} casts MongoDB
- ``$keyType = 'string'``, because the {+odm-short+} casts MongoDB
``ObjectId`` values to type ``string``

Extended Class Example
Expand Down Expand Up @@ -344,7 +344,7 @@ appropriate import to your model:
.. note::

When enabling soft deletes on a mass prunable model, you must import the
following {+odm-short+} packages:
following {+odm-long+} packages:

- ``MongoDB\Laravel\Eloquent\SoftDeletes``
- ``MongoDB\Laravel\Eloquent\MassPrunable``
Expand Down Expand Up @@ -437,11 +437,11 @@ You can define the new model class with the following behavior:

In the ``"WASP-39 b"`` document in the following code, the
``schema_version`` field value is less than ``2``. When you retrieve the
document, {+odm-short+} adds the ``galaxy`` field and updates the schema
document, the {+odm-short+} adds the ``galaxy`` field and updates the schema
version to the current version, ``2``.

The ``"Saturn"`` document does not contain the ``schema_version`` field,
so {+odm-short+} assigns it the current schema version upon saving.
so the {+odm-short+} assigns it the current schema version upon saving.

Finally, the code retrieves the models from the collection to
demonstrate the changes:
Expand Down
20 changes: 10 additions & 10 deletions docs/eloquent-models/relationships.txt
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ related model by using the same syntax as you use to access a property on the
model.

The following sections describe the Laravel Eloquent and MongoDB-specific
relationships available in {+odm-short+} and show examples of how to define
relationships available in the {+odm-short+} and show examples of how to define
and use them:

- :ref:`One to one relationship <laravel-eloquent-relationship-one-to-one>`,
Expand All @@ -59,7 +59,7 @@ When you add a one to one relationship, Eloquent lets you access the model by
using a dynamic property and stores the model's document ID on the related
model.

In {+odm-short+}, you can define a one to one relationship by using the
In {+odm-long+}, you can define a one to one relationship by using the
``hasOne()`` method or ``belongsTo()`` method.

When you add the inverse of the relationship by using the ``belongsTo()``
Expand Down Expand Up @@ -143,7 +143,7 @@ When you add a one to many relationship method, Eloquent lets you access the
model by using a dynamic property and stores the parent model's document ID
on each child model document.

In {+odm-short+}, you can define a one to many relationship by adding the
In {+odm-long+}, you can define a one to many relationship by adding the
``hasMany()`` method on the parent class and, optionally, the ``belongsTo()``
method on the child class.

Expand Down Expand Up @@ -234,17 +234,17 @@ A many to many relationship consists of a relationship between two different
model types in which, for each type of model, an instance of the model can
be related to multiple instances of the other type.

In {+odm-short+}, you can define a many to many relationship by adding the
In {+odm-long+}, you can define a many to many relationship by adding the
``belongsToMany()`` method to both related classes.

When you define a many to many relationship in a relational database, Laravel
creates a pivot table to track the relationships. When you use {+odm-short+},
creates a pivot table to track the relationships. When you use the {+odm-short+},
it omits the pivot table creation and adds the related document IDs to a
document field derived from the related model class name.

.. tip::

Since {+odm-short+} uses a document field instead of a pivot table, omit
Since the {+odm-short+} uses a document field instead of a pivot table, omit
the pivot table parameter from the ``belongsToMany()`` constructor or set
it to ``null``.

Expand Down Expand Up @@ -365,7 +365,7 @@ to meet one or more of the following requirements:
data
- Reducing the number of reads required to fetch the data

In {+odm-short+}, you can define embedded documents by adding one of the
In {+odm-long+}, you can define embedded documents by adding one of the
following methods:

- ``embedsOne()`` to embed a single document
Expand All @@ -377,7 +377,7 @@ following methods:
objects.

To learn more about the MongoDB embedded document pattern, see the following
MongoDB server tutorials:
MongoDB Server tutorials:

- :manual:`Model One-to-One Relationships with Embedded Documents </tutorial/model-embedded-one-to-one-relationships-between-documents/>`
- :manual:`Model One-to-Many Relationships with Embedded Documents </tutorial/model-embedded-one-to-many-relationships-between-documents/>`
Expand Down Expand Up @@ -446,13 +446,13 @@ running the code:
Cross-Database Relationships
----------------------------

A cross-database relationship in {+odm-short+} is a relationship between models
A cross-database relationship in {+odm-long+} is a relationship between models
stored in a relational database and models stored in a MongoDB database.

When you add a cross-database relationship, Eloquent lets you access the
related models by using a dynamic property.

{+odm-short+} supports the following cross-database relationship methods:
The {+odm-short+} supports the following cross-database relationship methods:

- ``hasOne()``
- ``hasMany()``
Expand Down
10 changes: 5 additions & 5 deletions docs/eloquent-models/schema-builder.txt
Original file line number Diff line number Diff line change
Expand Up @@ -24,22 +24,22 @@ Laravel provides a **facade** to access the schema builder class ``Schema``,
which lets you create and modify tables. Facades are static interfaces to
classes that make the syntax more concise and improve testability.

{+odm-short+} supports a subset of the index and collection management methods
The {+odm-short+} supports a subset of the index and collection management methods
in the Laravel ``Schema`` facade.

To learn more about facades, see `Facades <https://laravel.com/docs/{+laravel-docs-version+}/facades>`__
in the Laravel documentation.

The following sections describe the Laravel schema builder features available
in {+odm-short+} and show examples of how to use them:
in the {+odm-short+} and show examples of how to use them:

- :ref:`<laravel-eloquent-migrations>`
- :ref:`<laravel-eloquent-collection-exists>`
- :ref:`<laravel-eloquent-indexes>`

.. note::

{+odm-short+} supports managing indexes and collections, but
The {+odm-short+} supports managing indexes and collections, but
excludes support for MongoDB JSON schemas for data validation. To learn
more about JSON schema validation, see :manual:`Schema Validation </core/schema-validation/>`
in the {+server-docs-name+}.
Expand Down Expand Up @@ -67,7 +67,7 @@ following changes to perform the schema changes on your MongoDB database:

- Replace the ``Illuminate\Database\Schema\Blueprint`` import with
``MongoDB\Laravel\Schema\Blueprint`` if it is referenced in your migration
- Use only commands and syntax supported by {+odm-short+}
- Use only commands and syntax supported by the {+odm-short+}

.. tip::

Expand Down Expand Up @@ -251,7 +251,7 @@ in the {+server-docs-name+}.
Create Sparse, TTL, and Unique Indexes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

You can use {+odm-short+} helper methods to create the following types of
You can use {+odm-long+} helper methods to create the following types of
indexes:

- Sparse indexes, which allow index entries only for documents that contain the
Expand Down
18 changes: 9 additions & 9 deletions docs/feature-compatibility.txt
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,11 @@ Overview
--------

This guide describes the Laravel features that are supported by
the {+odm-long+}. This page discusses Laravel version 11.x feature
availability in {+odm-short+}.
{+odm-long+}. This page discusses Laravel version 11.x feature
availability in the {+odm-short+}.

The following sections contain tables that describe whether individual
features are available in {+odm-short+}.
features are available in the {+odm-short+}.

Database Features
-----------------
Expand Down Expand Up @@ -66,7 +66,7 @@ Database Features
Query Features
--------------

The following Eloquent methods are not supported in {+odm-short+}:
The following Eloquent methods are not supported in the {+odm-short+}:

- ``toSql()``
- ``toRawSql()``
Expand Down Expand Up @@ -168,19 +168,19 @@ The following Eloquent methods are not supported in {+odm-short+}:
Pagination Features
-------------------

{+odm-short+} supports all Laravel pagination features.
The {+odm-short+} supports all Laravel pagination features.


Migration Features
------------------

{+odm-short+} supports all Laravel migration features, but the
The {+odm-short+} supports all Laravel migration features, but the
implementation is specific to MongoDB's schemaless model.

Seeding Features
----------------

{+odm-short+} supports all Laravel seeding features.
The {+odm-short+} supports all Laravel seeding features.

Eloquent Features
-----------------
Expand Down Expand Up @@ -268,7 +268,7 @@ Eloquent Relationship Features
Eloquent Collection Features
----------------------------

{+odm-short+} supports all Eloquent collection features.
The {+odm-short+} supports all Eloquent collection features.

Eloquent Mutator Features
-------------------------
Expand Down Expand Up @@ -304,4 +304,4 @@ Eloquent Mutator Features
Eloquent Model Factory Features
-------------------------------

{+odm-short+} supports all Eloquent factory features.
The {+odm-short+} supports all Eloquent factory features.
2 changes: 1 addition & 1 deletion docs/fundamentals.txt
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Fundamentals
/fundamentals/write-operations
/fundamentals/aggregation-builder

Learn more about the following concepts related to the {+odm-long+}:
Learn more about the following concepts related to {+odm-long+}:

- :ref:`laravel-fundamentals-connection`
- :ref:`laravel-db-coll`
Expand Down
6 changes: 3 additions & 3 deletions docs/fundamentals/aggregation-builder.txt
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ An aggregation pipeline is composed of **aggregation stages**. Aggregation
stages use operators to process input data and produce data that the next
stage uses as its input.

The {+odm-short+} aggregation builder lets you build aggregation stages and
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:

Expand All @@ -43,7 +43,7 @@ aggregation builder to create the stages of an aggregation pipeline:

.. tip::

The aggregation builder feature is available only in {+odm-short+} versions
The aggregation builder feature is available only in {+odm-long+} versions
4.3 and later. To learn more about running aggregations without using the
aggregation builder, see :ref:`laravel-query-builder-aggregations` in the
Query Builder guide.
Expand Down Expand Up @@ -136,7 +136,7 @@ available indexes and reduce the amount of data the subsequent stages process.
aggregation stages.

This example constructs a query filter for a **match** aggregation stage by
using the ``MongoDB\Builder\Query`` builder. The match stage includes the the
using the ``MongoDB\Builder\Query`` builder. The match stage includes the
following criteria:

- Returns results that match either of the query filters by using the
Expand Down
2 changes: 1 addition & 1 deletion docs/fundamentals/connection.txt
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Connections
Overview
--------

Learn how to use {+odm-short+} to set up a connection to a MongoDB deployment
Learn how to use {+odm-long+} to set up a connection to a MongoDB deployment
and specify connection behavior in the following sections:

- :ref:`laravel-connect-to-mongodb`
Expand Down
8 changes: 4 additions & 4 deletions docs/fundamentals/connection/connect-to-mongodb.txt
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Overview
--------

In this guide, you can learn how to connect your Laravel application to a
MongoDB instance or replica set deployment by using {+odm-short+}.
MongoDB instance or replica set deployment by using {+odm-long+}.

This guide includes the following sections:

Expand All @@ -41,7 +41,7 @@ Connection URI
--------------

A **connection URI**, also known as a connection string, specifies how
{+odm-short+} connects to MongoDB and how to behave while connected.
the {+odm-short+} connects to MongoDB and how to behave while connected.

Parts of a Connection URI
~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -86,7 +86,7 @@ To learn more about connection options, see
Laravel Database Connection Configuration
------------------------------------------

{+odm-short+} lets you configure your MongoDB database connection in the
The {+odm-short+} lets you configure your MongoDB database connection in the
``config/database.php`` Laravel application file. You can specify the following
connection details in this file:

Expand Down Expand Up @@ -308,7 +308,7 @@ following sample values:

DB_URI="mongodb://myUser:myPass123@host1:27017,host2:27017,host3:27017/?replicaSet=myRS"

When connecting to a replica set, the library that {+odm-short+} uses to manage
When connecting to a replica set, the library that the {+odm-short+} uses to manage
connections with MongoDB performs the following actions unless otherwise
specified:

Expand Down
Loading
Loading