From 24e9cad7b7956dd7e2a3e5570eb6c65131d8bfa7 Mon Sep 17 00:00:00 2001 From: kenjis Date: Thu, 29 Jun 2023 19:37:15 +0900 Subject: [PATCH] docs: add instruction in upgrade note --- user_guide_src/source/changelogs/v4.4.0.rst | 17 +++++++++++++---- .../source/installation/upgrade_440.rst | 18 +++++++++++------- 2 files changed, 24 insertions(+), 11 deletions(-) diff --git a/user_guide_src/source/changelogs/v4.4.0.rst b/user_guide_src/source/changelogs/v4.4.0.rst index 403e2ecb2829..fd9fd2740a1c 100644 --- a/user_guide_src/source/changelogs/v4.4.0.rst +++ b/user_guide_src/source/changelogs/v4.4.0.rst @@ -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``, @@ -58,6 +59,14 @@ Method Signature Changes has been changed from ``Config\App`` to ``Config\Session``. - **Security:** The first parameter of ``Security::__construct()`` has been changed from ``Config\App`` to ``Config\Security``. +- **Validation:** The method signature of ``Validation::check()`` has been changed. + The ``string`` typehint on the ``$rule`` parameter was removed. + +Added Parameters +---------------- + +- **Routing:** The third parameter ``Routing $routing`` has been added to + ``RouteCollection::__construct()``. Enhancements ************ diff --git a/user_guide_src/source/installation/upgrade_440.rst b/user_guide_src/source/installation/upgrade_440.rst index 0080a767bdc0..f2018c9684dd 100644 --- a/user_guide_src/source/installation/upgrade_440.rst +++ b/user_guide_src/source/installation/upgrade_440.rst @@ -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 ======================== @@ -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 **********************