Skip to content

Commit c332ee6

Browse files
committed
docs: add changelog and upgrading guide
1 parent a127d71 commit c332ee6

File tree

2 files changed

+35
-0
lines changed

2 files changed

+35
-0
lines changed

user_guide_src/source/changelogs/v4.3.0.rst

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,35 @@ For example, the Exit code has been changed like the following:
3737
- If an uncaught ``CastException`` occurs, the Exit code is ``EXIT_CONFIG`` (= ``3``) instead of ``9``.
3838
- If an uncaught ``DatabaseException`` occurs, the Exit code is ``EXIT_DATABASE`` (= ``8``) instead of ``17``.
3939

40+
Method Signature Changes
41+
========================
42+
43+
.. _v430_validation_changes:
44+
45+
Validation Changes
46+
------------------
47+
48+
ValidationInterface
49+
^^^^^^^^^^^^^^^^^^^
50+
51+
``ValidationInterface`` has been changed to eliminate the mismatch between ``ValidationInterface`` and the ``Validation`` class.
52+
53+
- The third parameter ``$dbGroup`` for ``ValidationInterface::run()`` has been added.
54+
- The following methods are added to the interface:
55+
- ``ValidationInterface::setRule()``
56+
- ``ValidationInterface::getRules()``
57+
- ``ValidationInterface::getRuleGroup()``
58+
- ``ValidationInterface::setRuleGroup()``
59+
- ``ValidationInterface::loadRuleGroup()``
60+
- ``ValidationInterface::hasError()``
61+
- ``ValidationInterface::listErrors()``
62+
- ``ValidationInterface::showError()``
63+
64+
Validation
65+
^^^^^^^^^^
66+
67+
The return value of ``Validation::loadRuleGroup()`` has been changed ``null`` to ``[]`` when the ``$group`` is empty.
68+
4069
Others
4170
------
4271

user_guide_src/source/installation/upgrade_430.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,12 @@ If you have code that depends on the bug, you need to change the code.
7474
Use new Form helpers, :php:func:`validation_errors()`, :php:func:`validation_list_errors()` and :php:func:`validation_show_error()` to display Validation Errors,
7575
instead of the Validation object.
7676

77+
Validation Changes
78+
==================
79+
80+
- ``ValidationInterface`` has been changed. Implemented classes should likewise add the methods and the parameters so as not to break LSP. See :ref:`v430_validation_changes` for details.
81+
- The return value of ``Validation::loadRuleGroup()`` has been changed ``null`` to ``[]`` when the ``$group`` is empty. Update the code if you depend on the behavior.
82+
7783
.. _upgrade-430-stream-filter:
7884

7985
Capturing STDERR and STDOUT streams in tests

0 commit comments

Comments
 (0)