Skip to content

Commit

Permalink
docs: add changelog and ugrading
Browse files Browse the repository at this point in the history
  • Loading branch information
kenjis committed Sep 21, 2023
1 parent 4c16c8c commit b67c5bf
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 1 deletion.
6 changes: 6 additions & 0 deletions user_guide_src/source/changelogs/v4.5.0.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,12 @@ BREAKING
Behavior Changes
================

Filter Execution Order
----------------------

The order in which Controller Filters are executed has changed. See
:ref:`Upgrading Guide <upgrade-450-filter-execution-order>` for details.

Interface Changes
=================

Expand Down
5 changes: 4 additions & 1 deletion user_guide_src/source/incoming/filters.rst
Original file line number Diff line number Diff line change
Expand Up @@ -184,6 +184,8 @@ will be passed in ``$arguments`` to the ``group`` filter's ``before()`` methods.
When the URI matches ``admin/users/*'``, the array ``['users.manage']``
will be passed in ``$arguments`` to the ``permission`` filter's ``before()`` methods.

.. _filter-execution-order:

Filter Execution Order
======================

Expand All @@ -198,7 +200,8 @@ Filters are executed in the following order:

.. note:: Prior to v4.5.0, the filters that are specified to a route
(in **app/Config/Routes.php**) are executed before the filters specified in
**app/Config/Filters.php**.
**app/Config/Filters.php**. See
:ref:`Upgrading Guide <upgrade-450-filter-execution-order>` for details.

******************
Confirming Filters
Expand Down
20 changes: 20 additions & 0 deletions user_guide_src/source/installation/upgrade_450.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,26 @@ Mandatory File Changes
Breaking Changes
****************

.. _upgrade-450-filter-execution-order:

Filter Execution Order
----------------------

The order in which Controller Filters are executed has changed.

Before Filters::

Previous: route → globals → methods → filters
Now: globals → methods → filters → route

After Filters::

Previous: route → globals → filters
Now: route → filters → globals

If you wish to maintain the same execution order as in previous versions, set
``true`` to ``Config\Feature::$oldFilterOrder``. See also :ref:`filter-execution-order`.

Removed Deprecated Items
========================

Expand Down

0 comments on commit b67c5bf

Please sign in to comment.