Skip to content

Commit

Permalink
Merge 5.0 into 5.x (#3155)
Browse files Browse the repository at this point in the history
  • Loading branch information
mongodb-php-bot authored Sep 13, 2024
2 parents ce97048 + cf9c9b1 commit dd69219
Show file tree
Hide file tree
Showing 4 changed files with 44 additions and 40 deletions.
2 changes: 1 addition & 1 deletion docs/compatibility.txt
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Compatibility
:class: singlecol

.. meta::
:keywords: laravel 9, laravel 10, laravel 11, 4.0, 4.1, 4.2
:keywords: laravel 9, laravel 10, laravel 11, 4.0, 4.1, 4.2, 5.0

Laravel Compatibility
---------------------
Expand Down
2 changes: 1 addition & 1 deletion docs/includes/framework-compatibility-laravel.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
- Laravel 10.x
- Laravel 9.x

* - 4.2 to 4.8
* - 4.2 to 5.0
- ✓
- ✓
-
Expand Down
22 changes: 13 additions & 9 deletions docs/index.txt
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,9 @@
:maxdepth: 1

/quick-start
/usage-examples
Release Notes <https://github.com/mongodb/laravel-mongodb/releases/>
/upgrade
/usage-examples
/fundamentals
/eloquent-models
/query-builder
Expand All @@ -27,7 +28,6 @@
/issues-and-help
/feature-compatibility
/compatibility
/upgrade

Introduction
------------
Expand All @@ -52,6 +52,17 @@ Learn how to add the {+odm-short+} to a Laravel web application, connect to
MongoDB hosted on MongoDB Atlas, and begin working with data in the
:ref:`laravel-quick-start` section.

Upgrade Versions
----------------

.. important::

{+odm-long+} v5.0 introduces breaking changes that might affect how you
upgrade your application from a v4.x version.

Learn what changes you must make to your application to upgrade between
major versions in the :ref:`laravel-upgrading` section.

Usage Examples
--------------

Expand Down Expand Up @@ -94,10 +105,3 @@ Compatibility

To learn more about which versions of {+odm-long+} and Laravel are
compatible, see the :ref:`laravel-compatibility` section.

Upgrade Versions
----------------

Learn what changes you must make to your application to upgrade versions in
the :ref:`laravel-upgrading` section.

58 changes: 29 additions & 29 deletions docs/upgrade.txt
Original file line number Diff line number Diff line change
Expand Up @@ -124,41 +124,41 @@ This library version introduces the following breaking changes:
older versions compared to v5.0:

.. code-block:: php
:emphasize-lines: 10-11

use MongoDB\Laravel\Eloquent\Model;

class User extends Model
{
protected $keyType = 'string';

// older versions
protected $collection = 'app_user';

// v5.0
protected $table = 'app_user';

...
}
:emphasize-lines: 10-11
use MongoDB\Laravel\Eloquent\Model;
class User extends Model
{
protected $keyType = 'string';
// older versions
protected $collection = 'app_user';
// v5.0
protected $table = 'app_user';
...
}

This release also modifies the associated ``DB`` and ``Schema`` methods for
accessing a MongoDB collection. The following code shows how to access the
``app_user`` collection in older versions compared to v5.0:

.. code-block:: php
:emphasize-lines: 9-11

use Illuminate\Support\Facades\Schema;
use Illuminate\Support\Facades\DB;
use MongoDB\Laravel\Schema\Blueprint;

// older versions
Schema::collection('app_user', function (Blueprint $collection) { ... });
DB::collection('app_user')->find($id);

// v5.0
Schema::table('app_user', function (Blueprint $table) { ... });
DB::table('app_user')->find($id);
:emphasize-lines: 9-11
use Illuminate\Support\Facades\Schema;
use Illuminate\Support\Facades\DB;
use MongoDB\Laravel\Schema\Blueprint;
// older versions
Schema::collection('app_user', function (Blueprint $collection) { ... });
DB::collection('app_user')->find($id);
// v5.0
Schema::table('app_user', function (Blueprint $table) { ... });
DB::table('app_user')->find($id);

.. _laravel-breaking-changes-v4.x:

Expand Down

0 comments on commit dd69219

Please sign in to comment.