Skip to content

Commit

Permalink
docs: add instruction in upgrade note
Browse files Browse the repository at this point in the history
  • Loading branch information
kenjis committed Jun 29, 2023
1 parent 5adf1c4 commit 27503a6
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 11 deletions.
21 changes: 17 additions & 4 deletions user_guide_src/source/changelogs/v4.4.0.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,12 +45,13 @@ Interface Changes
Method Signature Changes
========================

.. _v440-parameter-type-changes:

Parameter Type Changes
----------------------

- **Services:** The first parameter of ``Services::security()`` has been
changed from ``Config\App`` to ``Config\Security``.
- **Routing:** The third parameter ``Routing $routing`` has been added to
``RouteCollection::__construct()``.
- **Validation:** The method signature of ``Validation::check()`` has been changed.
The ``string`` typehint on the ``$rule`` parameter was removed.
- **Session:** The second parameter of ``Session::__construct()`` has been
changed from ``Config\App`` to ``Config\Session``.
- **Session:** The first parameter of ``__construct()`` in ``BaseHandler``,
Expand All @@ -59,6 +60,18 @@ Method Signature Changes
- **Security:** The first parameter of ``Security::__construct()`` has been
changed from ``Config\App`` to ``Config\Security``.

Added Parameters
----------------

- **Routing:** The third parameter ``Routing $routing`` has been added to
``RouteCollection::__construct()``.

Removed Parameters
------------------

- **Validation:** The method signature of ``Validation::check()`` has been changed.
The ``string`` typehint on the ``$rule`` parameter was removed.

Enhancements
************

Expand Down
18 changes: 11 additions & 7 deletions user_guide_src/source/installation/upgrade_440.rst
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,17 @@ Interface Changes
Some interface changes have been made. Classes that implement them should update
their APIs to reflect the changes. See :ref:`v440-interface-changes` for details.

Method Signature Changes
========================

Some method signature changes have been made. Classes that extend them should
update their APIs to reflect the changes. See :ref:`v440-method-signature-changes`
for details.

Also, the parameter types of some constructors and ``Services::security()`` have changed.
If you call them with the parameters, change the parameter values.
See :ref:`v440-parameter-type-changes` for details.

RouteCollection::$routes
========================

Expand All @@ -75,13 +86,6 @@ performance.
If you extend ``RouteCollection`` and use the ``$routes``, update your code to
match the new array structure.

Method Signature Changes
========================

Some method signature changes have been made. Classes that extend them should
update their APIs to reflect the changes. See :ref:`v440-method-signature-changes`
for details.

Mandatory File Changes
**********************

Expand Down

0 comments on commit 27503a6

Please sign in to comment.