Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: Remove deprecated EVENT_PRIORITY_* #9401

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 0 additions & 15 deletions app/Config/Constants.php
Original file line number Diff line number Diff line change
Expand Up @@ -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);
10 changes: 6 additions & 4 deletions tests/system/Events/EventsTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ final class EventsTest extends CIUnitTestCase
{
/**
* Accessible event manager instance
*
* @var MockEvents
*/
private Events $manager;

Expand Down Expand Up @@ -96,8 +98,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'));
}
Expand Down Expand Up @@ -142,14 +144,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);
Expand Down
3 changes: 2 additions & 1 deletion user_guide_src/source/changelogs/v4.6.0.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion user_guide_src/source/extending/events.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
3 changes: 2 additions & 1 deletion user_guide_src/source/installation/upgrade_460.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
- app/Config/Feature.php
- app/Config/Constants.php
7 changes: 1 addition & 6 deletions utils/phpstan-baseline/method.notFound.neon
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# total 41 errors
# total 40 errors

parameters:
ignoreErrors:
Expand Down Expand Up @@ -47,11 +47,6 @@ parameters:
count: 3
path: ../../tests/system/Debug/ExceptionHandlerTest.php

-
message: '#^Call to an undefined method CodeIgniter\\Events\\Events\:\:unInitialize\(\)\.$#'
count: 1
path: ../../tests/system/Events/EventsTest.php

-
message: '#^Call to an undefined method CodeIgniter\\HTTP\\Request\:\:getCookie\(\)\.$#'
count: 2
Expand Down
Loading