From 4c163247800b47fab4761779eb782e8503ebd8df Mon Sep 17 00:00:00 2001 From: neznaika0 Date: Mon, 13 Jan 2025 06:34:13 +0300 Subject: [PATCH] refactor: Remove deprecated `EVENT_PRIORITY_*` (#9401) * refactor: Remove deprecated `EVENT_PRIORITY_*` * docs: Update changelog, userguide --- app/Config/Constants.php | 15 --------------- tests/system/Events/EventsTest.php | 8 ++++---- user_guide_src/source/changelogs/v4.6.0.rst | 3 ++- user_guide_src/source/extending/events.rst | 2 +- .../source/installation/upgrade_460.rst | 3 ++- utils/phpstan-baseline/method.notFound.neon | 2 +- 6 files changed, 10 insertions(+), 23 deletions(-) diff --git a/app/Config/Constants.php b/app/Config/Constants.php index 47b92f832935..fb56bb1c5b03 100644 --- a/app/Config/Constants.php +++ b/app/Config/Constants.php @@ -77,18 +77,3 @@ defined('EXIT_DATABASE') || define('EXIT_DATABASE', 8); // database error defined('EXIT__AUTO_MIN') || define('EXIT__AUTO_MIN', 9); // lowest automatically-assigned error code defined('EXIT__AUTO_MAX') || define('EXIT__AUTO_MAX', 125); // highest automatically-assigned error code - -/** - * @deprecated Use \CodeIgniter\Events\Events::PRIORITY_LOW instead. - */ -define('EVENT_PRIORITY_LOW', 200); - -/** - * @deprecated Use \CodeIgniter\Events\Events::PRIORITY_NORMAL instead. - */ -define('EVENT_PRIORITY_NORMAL', 100); - -/** - * @deprecated Use \CodeIgniter\Events\Events::PRIORITY_HIGH instead. - */ -define('EVENT_PRIORITY_HIGH', 10); diff --git a/tests/system/Events/EventsTest.php b/tests/system/Events/EventsTest.php index a659c3a3b460..dc22ec3cd92b 100644 --- a/tests/system/Events/EventsTest.php +++ b/tests/system/Events/EventsTest.php @@ -99,8 +99,8 @@ public function testListeners(): void $callback2 = static function (): void { }; - Events::on('foo', $callback1, EVENT_PRIORITY_HIGH); - Events::on('foo', $callback2, EVENT_PRIORITY_NORMAL); + Events::on('foo', $callback1, Events::PRIORITY_HIGH); + Events::on('foo', $callback2, Events::PRIORITY_NORMAL); $this->assertSame([$callback1, $callback2], Events::listeners('foo')); } @@ -145,14 +145,14 @@ public function testPriority(): void $result = 1; return false; - }, EVENT_PRIORITY_NORMAL); + }, Events::PRIORITY_NORMAL); // Since this has a higher priority, it will // run first. Events::on('foo', static function () use (&$result): bool { $result = 2; return false; - }, EVENT_PRIORITY_HIGH); + }, Events::PRIORITY_HIGH); $this->assertFalse(Events::trigger('foo', 'bar')); $this->assertSame(2, $result); diff --git a/user_guide_src/source/changelogs/v4.6.0.rst b/user_guide_src/source/changelogs/v4.6.0.rst index a9d78539e23c..844633fd543d 100644 --- a/user_guide_src/source/changelogs/v4.6.0.rst +++ b/user_guide_src/source/changelogs/v4.6.0.rst @@ -198,7 +198,8 @@ Removed Deprecated Items - **Logger:** The deprecated ``CodeIgniter\Log\Logger::cleanFilenames()`` and ``CodeIgniter\Test\TestLogger::cleanup()`` have been removed. Use the ``clean_path()`` function instead. - **Router:** The deprecated ``CodeIgniter\Router\Exceptions\RedirectException`` has been removed. Use ``CodeIgniter\HTTP\Exceptions\RedirectException`` instead. +- **Router:** The deprecated ``CodeIgniter\Router\Exceptions\RedirectException`` has been removed. Use ``CodeIgniter\HTTP\Exceptions\RedirectException`` instead. +- **Constants:** The deprecated constants ``EVENT_PRIORITY_*`` in has been removed. Use the class constants ``CodeIgniter\Events\Events::PRIORITY_LOW``, ``CodeIgniter\Events\Events::PRIORITY_NORMAL`` and ``CodeIgniter\Events\Events::PRIORITY_HIGH`` instead. ************ Enhancements diff --git a/user_guide_src/source/extending/events.rst b/user_guide_src/source/extending/events.rst index 966200248143..b628247e1dbe 100644 --- a/user_guide_src/source/extending/events.rst +++ b/user_guide_src/source/extending/events.rst @@ -51,7 +51,7 @@ but you might find they aid readability: .. literalinclude:: events/004.php -.. important:: The constants ``EVENT_PRIORITY_LOW``, ``EVENT_PRIORITY_NORMAL`` and ``EVENT_PRIORITY_HIGH`` are deprecated, and the definitions are moved to ``app/Config/Constants.php``. These will be removed in future releases. +.. important:: The constants ``EVENT_PRIORITY_LOW``, ``EVENT_PRIORITY_NORMAL`` and ``EVENT_PRIORITY_HIGH`` has been removed in v4.6.0. Once sorted, all subscribers are executed in order. If any subscriber returns a boolean false value, then execution of the subscribers will stop. diff --git a/user_guide_src/source/installation/upgrade_460.rst b/user_guide_src/source/installation/upgrade_460.rst index 57554c63b7bc..f1f1243392d6 100644 --- a/user_guide_src/source/installation/upgrade_460.rst +++ b/user_guide_src/source/installation/upgrade_460.rst @@ -221,4 +221,5 @@ All Changes This is a list of all files in the **project space** that received changes; many will be simple comments or formatting that have no effect on the runtime: -- app/Config/Feature.php \ No newline at end of file +- app/Config/Feature.php +- app/Config/Constants.php \ No newline at end of file diff --git a/utils/phpstan-baseline/method.notFound.neon b/utils/phpstan-baseline/method.notFound.neon index a44951f8cc6a..4d94dfbba7e4 100644 --- a/utils/phpstan-baseline/method.notFound.neon +++ b/utils/phpstan-baseline/method.notFound.neon @@ -1,4 +1,4 @@ -# total 41 errors +# total 40 errors parameters: ignoreErrors: