Skip to content

Commit 24e9cad

Browse files
committed
docs: add instruction in upgrade note
1 parent 713db9e commit 24e9cad

File tree

2 files changed

+24
-11
lines changed

2 files changed

+24
-11
lines changed

user_guide_src/source/changelogs/v4.4.0.rst

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,19 +45,28 @@ Interface Changes
4545
Method Signature Changes
4646
========================
4747

48+
.. _v440-parameter-type-changes:
49+
50+
Parameter Type Changes
51+
----------------------
52+
4853
- **Services:** The first parameter of ``Services::security()`` has been
4954
changed from ``Config\App`` to ``Config\Security``.
50-
- **Routing:** The third parameter ``Routing $routing`` has been added to
51-
``RouteCollection::__construct()``.
52-
- **Validation:** The method signature of ``Validation::check()`` has been changed.
53-
The ``string`` typehint on the ``$rule`` parameter was removed.
5455
- **Session:** The second parameter of ``Session::__construct()`` has been
5556
changed from ``Config\App`` to ``Config\Session``.
5657
- **Session:** The first parameter of ``__construct()`` in ``BaseHandler``,
5758
``DatabaseHandler``, ``FileHandler``, ``MemcachedHandler``, and ``RedisHandler``
5859
has been changed from ``Config\App`` to ``Config\Session``.
5960
- **Security:** The first parameter of ``Security::__construct()`` has been
6061
changed from ``Config\App`` to ``Config\Security``.
62+
- **Validation:** The method signature of ``Validation::check()`` has been changed.
63+
The ``string`` typehint on the ``$rule`` parameter was removed.
64+
65+
Added Parameters
66+
----------------
67+
68+
- **Routing:** The third parameter ``Routing $routing`` has been added to
69+
``RouteCollection::__construct()``.
6170

6271
Enhancements
6372
************

user_guide_src/source/installation/upgrade_440.rst

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,17 @@ Interface Changes
6666
Some interface changes have been made. Classes that implement them should update
6767
their APIs to reflect the changes. See :ref:`v440-interface-changes` for details.
6868

69+
Method Signature Changes
70+
========================
71+
72+
Some method signature changes have been made. Classes that extend them should
73+
update their APIs to reflect the changes. See :ref:`v440-method-signature-changes`
74+
for details.
75+
76+
Also, the parameter types of some constructors and ``Services::security()`` have changed.
77+
If you call them with the parameters, change the parameter values.
78+
See :ref:`v440-parameter-type-changes` for details.
79+
6980
RouteCollection::$routes
7081
========================
7182

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

78-
Method Signature Changes
79-
========================
80-
81-
Some method signature changes have been made. Classes that extend them should
82-
update their APIs to reflect the changes. See :ref:`v440-method-signature-changes`
83-
for details.
84-
8589
Mandatory File Changes
8690
**********************
8791

0 commit comments

Comments
 (0)