Skip to content

refactor: deprecate const EVENT_PRIORITY_*#6000

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.

Sign up for GitHub

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

Merged
kenjis merged 2 commits into from
May 18, 2022
Merged

refactor: deprecate const EVENT_PRIORITY_*#6000

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
35e178d
refactor: deprecate EVENT_PRIORITY_* and add class constants
kenjis May 17, 2022
98b3ad2
docs: update user guide
kenjis May 17, 2022
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: 15 additions & 0 deletions app/Config/Constants.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -77,3 +77,18 @@
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);
8 changes: 4 additions & 4 deletions system/Events/Events.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,15 +14,15 @@
use Config\Modules;
use Config\Services;

define('EVENT_PRIORITY_LOW', 200);
define('EVENT_PRIORITY_NORMAL', 100);
define('EVENT_PRIORITY_HIGH', 10);

/**
* Events
*/
class Events
{
public const PRIORITY_LOW = 200;
public const PRIORITY_NORMAL = 100;
public const PRIORITY_HIGH = 10;

/**
* The list of listeners.
*
Expand Down
6 changes: 3 additions & 3 deletions tests/system/Events/EventsTest.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -157,15 +157,15 @@ public function testPriorityWithMultiple()

Events::on('foo', static function () use (&$result) {
$result[] = 'a';
}, EVENT_PRIORITY_NORMAL);
}, Events::PRIORITY_NORMAL);

Events::on('foo', static function () use (&$result) {
$result[] = 'b';
}, EVENT_PRIORITY_LOW);
}, Events::PRIORITY_LOW);

Events::on('foo', static function () use (&$result) {
$result[] = 'c';
}, EVENT_PRIORITY_HIGH);
}, Events::PRIORITY_HIGH);

Events::on('foo', static function () use (&$result) {
$result[] = 'd';
Expand Down
1 change: 1 addition & 0 deletions user_guide_src/source/changelogs/v4.2.0.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -102,6 +102,7 @@ Deprecations
- ``CodeIgniter\Router\Router::setDefaultController()`` is deprecated.
- The constant ``SPARKED`` in **spark** is deprecated. Use the ``$context`` property in ``CodeIgniter\CodeIgniter`` instead.
- ``CodeIgniter\Autoloader\Autoloader::discoverComposerNamespaces()`` is deprecated, and no longer used.
- The constants ``EVENT_PRIORITY_LOW``, ``EVENT_PRIORITY_NORMAL`` and ``EVENT_PRIORITY_HIGH`` are deprecated. Use the class constants ``CodeIgniter\Events\Events::PRIORITY_LOW``, ``CodeIgniter\Events\Events::PRIORITY_NORMAL`` and ``CodeIgniter\Events\Events::PRIORITY_HIGH`` instead.

Bugs Fixed
**********
Expand Down
4 changes: 3 additions & 1 deletion user_guide_src/source/extending/events.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -46,11 +46,13 @@ are executed first, with a value of 1 having the highest priority, and there bei

Any subscribers with the same priority will be executed in the order they were defined.

Three constants are defined for your use, that set some helpful ranges on the values. You are not required to use these
Since v4.2.0, three class constants are defined for your use, that set some helpful ranges on the values. You are not required to use these
but you might find they aid readability:

.. literalinclude:: events/004.php

.. note:: The constants ``EVENT_PRIORITY_LOW``, ``EVENT_PRIORITY_NORMAL`` and ``EVENT_PRIORITY_HIGH`` are deprecated, and the definitions are moved to ``app/Config/Constants.php``.

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
8 changes: 5 additions & 3 deletions user_guide_src/source/extending/events/004.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
<?php

define('EVENT_PRIORITY_LOW', 200);
define('EVENT_PRIORITY_NORMAL', 100);
define('EVENT_PRIORITY_HIGH', 10);
use CodeIgniter\Events\Events;

Events::PRIORITY_LOW; // 200
Events::PRIORITY_NORMAL; // 100
Events::PRIORITY_HIGH; // 10
8 changes: 8 additions & 0 deletions user_guide_src/source/installation/upgrade_420.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,12 +15,20 @@ Please refer to the upgrade instructions corresponding to your installation meth
Mandatory File Changes
**********************

index.php and spark
===================

The following files received significant changes and
**you must merge the updated versions** with your application:

* ``public/index.php``
* ``spark``

Config/Constants.php
====================

The constants ``EVENT_PRIORITY_LOW``, ``EVENT_PRIORITY_NORMAL`` and ``EVENT_PRIORITY_HIGH`` are deprecated, and the definitions are moved to ``app/Config/Constants.php``. If you use these constants, define them in ``app/Config/Constants.php``. Or use new class constants ``CodeIgniter\Events\Events::PRIORITY_LOW``, ``CodeIgniter\Events\Events::PRIORITY_NORMAL`` and ``CodeIgniter\Events\Events::PRIORITY_HIGH``.

Breaking Changes
****************

Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
refactor: deprecate const `EVENT_PRIORITY_*` by kenjis · Pull Request #6000 · codeigniter4/CodeIgniter4 · GitHub
Skip to content
refactor: deprecate const EVENT_PRIORITY_*#6000

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.

 Sign up for GitHub

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

 Merged

kenjis
merged 2 commits into

from

May 18, 2022
 Merged


refactor: deprecate const EVENT_PRIORITY_*#6000
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
35e178d

refactor: deprecate EVENT_PRIORITY_* and add class constants


kenjis May 17, 2022
98b3ad2

docs: update user guide


kenjis May 17, 2022

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: 15 additions & 0 deletions
app/Config/Constants.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -77,3 +77,18 @@
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);

8 changes: 4 additions & 4 deletions
system/Events/Events.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,15 +14,15 @@
use Config\Modules;
use Config\Services;

define('EVENT_PRIORITY_LOW', 200);
define('EVENT_PRIORITY_NORMAL', 100);
define('EVENT_PRIORITY_HIGH', 10);

/**
 * Events
 */
class Events
{
 public const PRIORITY_LOW = 200;
 public const PRIORITY_NORMAL = 100;
 public const PRIORITY_HIGH = 10;

 /**
 * The list of listeners.
 *
Expand Down

6 changes: 3 additions & 3 deletions
tests/system/Events/EventsTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -157,15 +157,15 @@ public function testPriorityWithMultiple()

 Events::on('foo', static function () use (&$result) {
 $result[] = 'a';
 }, EVENT_PRIORITY_NORMAL);
 }, Events::PRIORITY_NORMAL);

 Events::on('foo', static function () use (&$result) {
 $result[] = 'b';
 }, EVENT_PRIORITY_LOW);
 }, Events::PRIORITY_LOW);

 Events::on('foo', static function () use (&$result) {
 $result[] = 'c';
 }, EVENT_PRIORITY_HIGH);
 }, Events::PRIORITY_HIGH);

 Events::on('foo', static function () use (&$result) {
 $result[] = 'd';
Expand Down

1 change: 1 addition & 0 deletions
user_guide_src/source/changelogs/v4.2.0.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -102,6 +102,7 @@ Deprecations
- ``CodeIgniter\Router\Router::setDefaultController()`` is deprecated.
- The constant ``SPARKED`` in **spark** is deprecated. Use the ``$context`` property in ``CodeIgniter\CodeIgniter`` instead.
- ``CodeIgniter\Autoloader\Autoloader::discoverComposerNamespaces()`` is deprecated, and no longer used.
- The constants ``EVENT_PRIORITY_LOW``, ``EVENT_PRIORITY_NORMAL`` and ``EVENT_PRIORITY_HIGH`` are deprecated. Use the class constants ``CodeIgniter\Events\Events::PRIORITY_LOW``, ``CodeIgniter\Events\Events::PRIORITY_NORMAL`` and ``CodeIgniter\Events\Events::PRIORITY_HIGH`` instead.

Bugs Fixed
**********
Expand Down

4 changes: 3 additions & 1 deletion
user_guide_src/source/extending/events.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,11 +46,13 @@ are executed first, with a value of 1 having the highest priority, and there bei

Any subscribers with the same priority will be executed in the order they were defined.

Three constants are defined for your use, that set some helpful ranges on the values. You are not required to use these
Since v4.2.0, three class constants are defined for your use, that set some helpful ranges on the values. You are not required to use these
but you might find they aid readability:

.. literalinclude:: events/004.php

.. note:: The constants ``EVENT_PRIORITY_LOW``, ``EVENT_PRIORITY_NORMAL`` and ``EVENT_PRIORITY_HIGH`` are deprecated, and the definitions are moved to ``app/Config/Constants.php``.

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

8 changes: 5 additions & 3 deletions
user_guide_src/source/extending/events/004.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
<?php

define('EVENT_PRIORITY_LOW', 200);
define('EVENT_PRIORITY_NORMAL', 100);
define('EVENT_PRIORITY_HIGH', 10);
use CodeIgniter\Events\Events;

Events::PRIORITY_LOW; // 200
Events::PRIORITY_NORMAL; // 100
Events::PRIORITY_HIGH; // 10

8 changes: 8 additions & 0 deletions
user_guide_src/source/installation/upgrade_420.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,12 +15,20 @@ Please refer to the upgrade instructions corresponding to your installation meth
Mandatory File Changes
**********************

index.php and spark
===================

The following files received significant changes and
**you must merge the updated versions** with your application:

* ``public/index.php``
* ``spark``

Config/Constants.php
====================

The constants ``EVENT_PRIORITY_LOW``, ``EVENT_PRIORITY_NORMAL`` and ``EVENT_PRIORITY_HIGH`` are deprecated, and the definitions are moved to ``app/Config/Constants.php``. If you use these constants, define them in ``app/Config/Constants.php``. Or use new class constants ``CodeIgniter\Events\Events::PRIORITY_LOW``, ``CodeIgniter\Events\Events::PRIORITY_NORMAL`` and ``CodeIgniter\Events\Events::PRIORITY_HIGH``.

Breaking Changes
****************

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
refactor: deprecate const `EVENT_PRIORITY_*` by kenjis · Pull Request #6000 · codeigniter4/CodeIgniter4 · GitHub
Skip to content
refactor: deprecate const EVENT_PRIORITY_*#6000

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.

 Sign up for GitHub

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

 Merged

kenjis
merged 2 commits into

from

May 18, 2022
 Merged


refactor: deprecate const EVENT_PRIORITY_*#6000
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
35e178d

refactor: deprecate EVENT_PRIORITY_* and add class constants


kenjis May 17, 2022
98b3ad2

docs: update user guide


kenjis May 17, 2022

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: 15 additions & 0 deletions
app/Config/Constants.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -77,3 +77,18 @@
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);

8 changes: 4 additions & 4 deletions
system/Events/Events.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,15 +14,15 @@
use Config\Modules;
use Config\Services;

define('EVENT_PRIORITY_LOW', 200);
define('EVENT_PRIORITY_NORMAL', 100);
define('EVENT_PRIORITY_HIGH', 10);

/**
 * Events
 */
class Events
{
 public const PRIORITY_LOW = 200;
 public const PRIORITY_NORMAL = 100;
 public const PRIORITY_HIGH = 10;

 /**
 * The list of listeners.
 *
Expand Down

6 changes: 3 additions & 3 deletions
tests/system/Events/EventsTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -157,15 +157,15 @@ public function testPriorityWithMultiple()

 Events::on('foo', static function () use (&$result) {
 $result[] = 'a';
 }, EVENT_PRIORITY_NORMAL);
 }, Events::PRIORITY_NORMAL);

 Events::on('foo', static function () use (&$result) {
 $result[] = 'b';
 }, EVENT_PRIORITY_LOW);
 }, Events::PRIORITY_LOW);

 Events::on('foo', static function () use (&$result) {
 $result[] = 'c';
 }, EVENT_PRIORITY_HIGH);
 }, Events::PRIORITY_HIGH);

 Events::on('foo', static function () use (&$result) {
 $result[] = 'd';
Expand Down

1 change: 1 addition & 0 deletions
user_guide_src/source/changelogs/v4.2.0.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -102,6 +102,7 @@ Deprecations
- ``CodeIgniter\Router\Router::setDefaultController()`` is deprecated.
- The constant ``SPARKED`` in **spark** is deprecated. Use the ``$context`` property in ``CodeIgniter\CodeIgniter`` instead.
- ``CodeIgniter\Autoloader\Autoloader::discoverComposerNamespaces()`` is deprecated, and no longer used.
- The constants ``EVENT_PRIORITY_LOW``, ``EVENT_PRIORITY_NORMAL`` and ``EVENT_PRIORITY_HIGH`` are deprecated. Use the class constants ``CodeIgniter\Events\Events::PRIORITY_LOW``, ``CodeIgniter\Events\Events::PRIORITY_NORMAL`` and ``CodeIgniter\Events\Events::PRIORITY_HIGH`` instead.

Bugs Fixed
**********
Expand Down

4 changes: 3 additions & 1 deletion
user_guide_src/source/extending/events.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,11 +46,13 @@ are executed first, with a value of 1 having the highest priority, and there bei

Any subscribers with the same priority will be executed in the order they were defined.

Three constants are defined for your use, that set some helpful ranges on the values. You are not required to use these
Since v4.2.0, three class constants are defined for your use, that set some helpful ranges on the values. You are not required to use these
but you might find they aid readability:

.. literalinclude:: events/004.php

.. note:: The constants ``EVENT_PRIORITY_LOW``, ``EVENT_PRIORITY_NORMAL`` and ``EVENT_PRIORITY_HIGH`` are deprecated, and the definitions are moved to ``app/Config/Constants.php``.

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

8 changes: 5 additions & 3 deletions
user_guide_src/source/extending/events/004.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
<?php

define('EVENT_PRIORITY_LOW', 200);
define('EVENT_PRIORITY_NORMAL', 100);
define('EVENT_PRIORITY_HIGH', 10);
use CodeIgniter\Events\Events;

Events::PRIORITY_LOW; // 200
Events::PRIORITY_NORMAL; // 100
Events::PRIORITY_HIGH; // 10

8 changes: 8 additions & 0 deletions
user_guide_src/source/installation/upgrade_420.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,12 +15,20 @@ Please refer to the upgrade instructions corresponding to your installation meth
Mandatory File Changes
**********************

index.php and spark
===================

The following files received significant changes and
**you must merge the updated versions** with your application:

* ``public/index.php``
* ``spark``

Config/Constants.php
====================

The constants ``EVENT_PRIORITY_LOW``, ``EVENT_PRIORITY_NORMAL`` and ``EVENT_PRIORITY_HIGH`` are deprecated, and the definitions are moved to ``app/Config/Constants.php``. If you use these constants, define them in ``app/Config/Constants.php``. Or use new class constants ``CodeIgniter\Events\Events::PRIORITY_LOW``, ``CodeIgniter\Events\Events::PRIORITY_NORMAL`` and ``CodeIgniter\Events\Events::PRIORITY_HIGH``.

Breaking Changes
****************

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
refactor: deprecate const `EVENT_PRIORITY_*` by kenjis · Pull Request #6000 · codeigniter4/CodeIgniter4 · GitHub
Skip to content
refactor: deprecate const EVENT_PRIORITY_*#6000

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.

 Sign up for GitHub

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

 Merged

kenjis
merged 2 commits into

from

May 18, 2022
 Merged


refactor: deprecate const EVENT_PRIORITY_*#6000
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
35e178d

refactor: deprecate EVENT_PRIORITY_* and add class constants


kenjis May 17, 2022
98b3ad2

docs: update user guide


kenjis May 17, 2022

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: 15 additions & 0 deletions
app/Config/Constants.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -77,3 +77,18 @@
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);

8 changes: 4 additions & 4 deletions
system/Events/Events.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,15 +14,15 @@
use Config\Modules;
use Config\Services;

define('EVENT_PRIORITY_LOW', 200);
define('EVENT_PRIORITY_NORMAL', 100);
define('EVENT_PRIORITY_HIGH', 10);

/**
 * Events
 */
class Events
{
 public const PRIORITY_LOW = 200;
 public const PRIORITY_NORMAL = 100;
 public const PRIORITY_HIGH = 10;

 /**
 * The list of listeners.
 *
Expand Down

6 changes: 3 additions & 3 deletions
tests/system/Events/EventsTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -157,15 +157,15 @@ public function testPriorityWithMultiple()

 Events::on('foo', static function () use (&$result) {
 $result[] = 'a';
 }, EVENT_PRIORITY_NORMAL);
 }, Events::PRIORITY_NORMAL);

 Events::on('foo', static function () use (&$result) {
 $result[] = 'b';
 }, EVENT_PRIORITY_LOW);
 }, Events::PRIORITY_LOW);

 Events::on('foo', static function () use (&$result) {
 $result[] = 'c';
 }, EVENT_PRIORITY_HIGH);
 }, Events::PRIORITY_HIGH);

 Events::on('foo', static function () use (&$result) {
 $result[] = 'd';
Expand Down

1 change: 1 addition & 0 deletions
user_guide_src/source/changelogs/v4.2.0.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -102,6 +102,7 @@ Deprecations
- ``CodeIgniter\Router\Router::setDefaultController()`` is deprecated.
- The constant ``SPARKED`` in **spark** is deprecated. Use the ``$context`` property in ``CodeIgniter\CodeIgniter`` instead.
- ``CodeIgniter\Autoloader\Autoloader::discoverComposerNamespaces()`` is deprecated, and no longer used.
- The constants ``EVENT_PRIORITY_LOW``, ``EVENT_PRIORITY_NORMAL`` and ``EVENT_PRIORITY_HIGH`` are deprecated. Use the class constants ``CodeIgniter\Events\Events::PRIORITY_LOW``, ``CodeIgniter\Events\Events::PRIORITY_NORMAL`` and ``CodeIgniter\Events\Events::PRIORITY_HIGH`` instead.

Bugs Fixed
**********
Expand Down

4 changes: 3 additions & 1 deletion
user_guide_src/source/extending/events.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,11 +46,13 @@ are executed first, with a value of 1 having the highest priority, and there bei

Any subscribers with the same priority will be executed in the order they were defined.

Three constants are defined for your use, that set some helpful ranges on the values. You are not required to use these
Since v4.2.0, three class constants are defined for your use, that set some helpful ranges on the values. You are not required to use these
but you might find they aid readability:

.. literalinclude:: events/004.php

.. note:: The constants ``EVENT_PRIORITY_LOW``, ``EVENT_PRIORITY_NORMAL`` and ``EVENT_PRIORITY_HIGH`` are deprecated, and the definitions are moved to ``app/Config/Constants.php``.

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

8 changes: 5 additions & 3 deletions
user_guide_src/source/extending/events/004.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
<?php

define('EVENT_PRIORITY_LOW', 200);
define('EVENT_PRIORITY_NORMAL', 100);
define('EVENT_PRIORITY_HIGH', 10);
use CodeIgniter\Events\Events;

Events::PRIORITY_LOW; // 200
Events::PRIORITY_NORMAL; // 100
Events::PRIORITY_HIGH; // 10

8 changes: 8 additions & 0 deletions
user_guide_src/source/installation/upgrade_420.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,12 +15,20 @@ Please refer to the upgrade instructions corresponding to your installation meth
Mandatory File Changes
**********************

index.php and spark
===================

The following files received significant changes and
**you must merge the updated versions** with your application:

* ``public/index.php``
* ``spark``

Config/Constants.php
====================

The constants ``EVENT_PRIORITY_LOW``, ``EVENT_PRIORITY_NORMAL`` and ``EVENT_PRIORITY_HIGH`` are deprecated, and the definitions are moved to ``app/Config/Constants.php``. If you use these constants, define them in ``app/Config/Constants.php``. Or use new class constants ``CodeIgniter\Events\Events::PRIORITY_LOW``, ``CodeIgniter\Events\Events::PRIORITY_NORMAL`` and ``CodeIgniter\Events\Events::PRIORITY_HIGH``.

Breaking Changes
****************

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
refactor: deprecate const `EVENT_PRIORITY_*` by kenjis · Pull Request #6000 · codeigniter4/CodeIgniter4 · GitHub
Skip to content
refactor: deprecate const EVENT_PRIORITY_*#6000

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.

 Sign up for GitHub

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

 Merged

kenjis
merged 2 commits into

from

May 18, 2022
 Merged


refactor: deprecate const EVENT_PRIORITY_*#6000
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
35e178d

refactor: deprecate EVENT_PRIORITY_* and add class constants


kenjis May 17, 2022
98b3ad2

docs: update user guide


kenjis May 17, 2022

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: 15 additions & 0 deletions
app/Config/Constants.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -77,3 +77,18 @@
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);

8 changes: 4 additions & 4 deletions
system/Events/Events.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,15 +14,15 @@
use Config\Modules;
use Config\Services;

define('EVENT_PRIORITY_LOW', 200);
define('EVENT_PRIORITY_NORMAL', 100);
define('EVENT_PRIORITY_HIGH', 10);

/**
 * Events
 */
class Events
{
 public const PRIORITY_LOW = 200;
 public const PRIORITY_NORMAL = 100;
 public const PRIORITY_HIGH = 10;

 /**
 * The list of listeners.
 *
Expand Down

6 changes: 3 additions & 3 deletions
tests/system/Events/EventsTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -157,15 +157,15 @@ public function testPriorityWithMultiple()

 Events::on('foo', static function () use (&$result) {
 $result[] = 'a';
 }, EVENT_PRIORITY_NORMAL);
 }, Events::PRIORITY_NORMAL);

 Events::on('foo', static function () use (&$result) {
 $result[] = 'b';
 }, EVENT_PRIORITY_LOW);
 }, Events::PRIORITY_LOW);

 Events::on('foo', static function () use (&$result) {
 $result[] = 'c';
 }, EVENT_PRIORITY_HIGH);
 }, Events::PRIORITY_HIGH);

 Events::on('foo', static function () use (&$result) {
 $result[] = 'd';
Expand Down

1 change: 1 addition & 0 deletions
user_guide_src/source/changelogs/v4.2.0.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -102,6 +102,7 @@ Deprecations
- ``CodeIgniter\Router\Router::setDefaultController()`` is deprecated.
- The constant ``SPARKED`` in **spark** is deprecated. Use the ``$context`` property in ``CodeIgniter\CodeIgniter`` instead.
- ``CodeIgniter\Autoloader\Autoloader::discoverComposerNamespaces()`` is deprecated, and no longer used.
- The constants ``EVENT_PRIORITY_LOW``, ``EVENT_PRIORITY_NORMAL`` and ``EVENT_PRIORITY_HIGH`` are deprecated. Use the class constants ``CodeIgniter\Events\Events::PRIORITY_LOW``, ``CodeIgniter\Events\Events::PRIORITY_NORMAL`` and ``CodeIgniter\Events\Events::PRIORITY_HIGH`` instead.

Bugs Fixed
**********
Expand Down

4 changes: 3 additions & 1 deletion
user_guide_src/source/extending/events.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,11 +46,13 @@ are executed first, with a value of 1 having the highest priority, and there bei

Any subscribers with the same priority will be executed in the order they were defined.

Three constants are defined for your use, that set some helpful ranges on the values. You are not required to use these
Since v4.2.0, three class constants are defined for your use, that set some helpful ranges on the values. You are not required to use these
but you might find they aid readability:

.. literalinclude:: events/004.php

.. note:: The constants ``EVENT_PRIORITY_LOW``, ``EVENT_PRIORITY_NORMAL`` and ``EVENT_PRIORITY_HIGH`` are deprecated, and the definitions are moved to ``app/Config/Constants.php``.

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

8 changes: 5 additions & 3 deletions
user_guide_src/source/extending/events/004.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
<?php

define('EVENT_PRIORITY_LOW', 200);
define('EVENT_PRIORITY_NORMAL', 100);
define('EVENT_PRIORITY_HIGH', 10);
use CodeIgniter\Events\Events;

Events::PRIORITY_LOW; // 200
Events::PRIORITY_NORMAL; // 100
Events::PRIORITY_HIGH; // 10

8 changes: 8 additions & 0 deletions
user_guide_src/source/installation/upgrade_420.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,12 +15,20 @@ Please refer to the upgrade instructions corresponding to your installation meth
Mandatory File Changes
**********************

index.php and spark
===================

The following files received significant changes and
**you must merge the updated versions** with your application:

* ``public/index.php``
* ``spark``

Config/Constants.php
====================

The constants ``EVENT_PRIORITY_LOW``, ``EVENT_PRIORITY_NORMAL`` and ``EVENT_PRIORITY_HIGH`` are deprecated, and the definitions are moved to ``app/Config/Constants.php``. If you use these constants, define them in ``app/Config/Constants.php``. Or use new class constants ``CodeIgniter\Events\Events::PRIORITY_LOW``, ``CodeIgniter\Events\Events::PRIORITY_NORMAL`` and ``CodeIgniter\Events\Events::PRIORITY_HIGH``.

Breaking Changes
****************

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
refactor: deprecate const `EVENT_PRIORITY_*` by kenjis · Pull Request #6000 · codeigniter4/CodeIgniter4 · GitHub
Skip to content
refactor: deprecate const EVENT_PRIORITY_*#6000

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.

 Sign up for GitHub

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

 Merged

kenjis
merged 2 commits into

from

May 18, 2022
 Merged


refactor: deprecate const EVENT_PRIORITY_*#6000
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
35e178d

refactor: deprecate EVENT_PRIORITY_* and add class constants


kenjis May 17, 2022
98b3ad2

docs: update user guide


kenjis May 17, 2022

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: 15 additions & 0 deletions
app/Config/Constants.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -77,3 +77,18 @@
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);

8 changes: 4 additions & 4 deletions
system/Events/Events.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,15 +14,15 @@
use Config\Modules;
use Config\Services;

define('EVENT_PRIORITY_LOW', 200);
define('EVENT_PRIORITY_NORMAL', 100);
define('EVENT_PRIORITY_HIGH', 10);

/**
 * Events
 */
class Events
{
 public const PRIORITY_LOW = 200;
 public const PRIORITY_NORMAL = 100;
 public const PRIORITY_HIGH = 10;

 /**
 * The list of listeners.
 *
Expand Down

6 changes: 3 additions & 3 deletions
tests/system/Events/EventsTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -157,15 +157,15 @@ public function testPriorityWithMultiple()

 Events::on('foo', static function () use (&$result) {
 $result[] = 'a';
 }, EVENT_PRIORITY_NORMAL);
 }, Events::PRIORITY_NORMAL);

 Events::on('foo', static function () use (&$result) {
 $result[] = 'b';
 }, EVENT_PRIORITY_LOW);
 }, Events::PRIORITY_LOW);

 Events::on('foo', static function () use (&$result) {
 $result[] = 'c';
 }, EVENT_PRIORITY_HIGH);
 }, Events::PRIORITY_HIGH);

 Events::on('foo', static function () use (&$result) {
 $result[] = 'd';
Expand Down

1 change: 1 addition & 0 deletions
user_guide_src/source/changelogs/v4.2.0.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -102,6 +102,7 @@ Deprecations
- ``CodeIgniter\Router\Router::setDefaultController()`` is deprecated.
- The constant ``SPARKED`` in **spark** is deprecated. Use the ``$context`` property in ``CodeIgniter\CodeIgniter`` instead.
- ``CodeIgniter\Autoloader\Autoloader::discoverComposerNamespaces()`` is deprecated, and no longer used.
- The constants ``EVENT_PRIORITY_LOW``, ``EVENT_PRIORITY_NORMAL`` and ``EVENT_PRIORITY_HIGH`` are deprecated. Use the class constants ``CodeIgniter\Events\Events::PRIORITY_LOW``, ``CodeIgniter\Events\Events::PRIORITY_NORMAL`` and ``CodeIgniter\Events\Events::PRIORITY_HIGH`` instead.

Bugs Fixed
**********
Expand Down

4 changes: 3 additions & 1 deletion
user_guide_src/source/extending/events.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,11 +46,13 @@ are executed first, with a value of 1 having the highest priority, and there bei

Any subscribers with the same priority will be executed in the order they were defined.

Three constants are defined for your use, that set some helpful ranges on the values. You are not required to use these
Since v4.2.0, three class constants are defined for your use, that set some helpful ranges on the values. You are not required to use these
but you might find they aid readability:

.. literalinclude:: events/004.php

.. note:: The constants ``EVENT_PRIORITY_LOW``, ``EVENT_PRIORITY_NORMAL`` and ``EVENT_PRIORITY_HIGH`` are deprecated, and the definitions are moved to ``app/Config/Constants.php``.

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

8 changes: 5 additions & 3 deletions
user_guide_src/source/extending/events/004.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
<?php

define('EVENT_PRIORITY_LOW', 200);
define('EVENT_PRIORITY_NORMAL', 100);
define('EVENT_PRIORITY_HIGH', 10);
use CodeIgniter\Events\Events;

Events::PRIORITY_LOW; // 200
Events::PRIORITY_NORMAL; // 100
Events::PRIORITY_HIGH; // 10

8 changes: 8 additions & 0 deletions
user_guide_src/source/installation/upgrade_420.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,12 +15,20 @@ Please refer to the upgrade instructions corresponding to your installation meth
Mandatory File Changes
**********************

index.php and spark
===================

The following files received significant changes and
**you must merge the updated versions** with your application:

* ``public/index.php``
* ``spark``

Config/Constants.php
====================

The constants ``EVENT_PRIORITY_LOW``, ``EVENT_PRIORITY_NORMAL`` and ``EVENT_PRIORITY_HIGH`` are deprecated, and the definitions are moved to ``app/Config/Constants.php``. If you use these constants, define them in ``app/Config/Constants.php``. Or use new class constants ``CodeIgniter\Events\Events::PRIORITY_LOW``, ``CodeIgniter\Events\Events::PRIORITY_NORMAL`` and ``CodeIgniter\Events\Events::PRIORITY_HIGH``.

Breaking Changes
****************

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
refactor: deprecate const `EVENT_PRIORITY_*` by kenjis · Pull Request #6000 · codeigniter4/CodeIgniter4 · GitHub
Skip to content
refactor: deprecate const EVENT_PRIORITY_*#6000

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.

 Sign up for GitHub

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

 Merged

kenjis
merged 2 commits into

from

May 18, 2022
 Merged


refactor: deprecate const EVENT_PRIORITY_*#6000
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
35e178d

refactor: deprecate EVENT_PRIORITY_* and add class constants


kenjis May 17, 2022
98b3ad2

docs: update user guide


kenjis May 17, 2022

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: 15 additions & 0 deletions
app/Config/Constants.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -77,3 +77,18 @@
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);

8 changes: 4 additions & 4 deletions
system/Events/Events.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,15 +14,15 @@
use Config\Modules;
use Config\Services;

define('EVENT_PRIORITY_LOW', 200);
define('EVENT_PRIORITY_NORMAL', 100);
define('EVENT_PRIORITY_HIGH', 10);

/**
 * Events
 */
class Events
{
 public const PRIORITY_LOW = 200;
 public const PRIORITY_NORMAL = 100;
 public const PRIORITY_HIGH = 10;

 /**
 * The list of listeners.
 *
Expand Down

6 changes: 3 additions & 3 deletions
tests/system/Events/EventsTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -157,15 +157,15 @@ public function testPriorityWithMultiple()

 Events::on('foo', static function () use (&$result) {
 $result[] = 'a';
 }, EVENT_PRIORITY_NORMAL);
 }, Events::PRIORITY_NORMAL);

 Events::on('foo', static function () use (&$result) {
 $result[] = 'b';
 }, EVENT_PRIORITY_LOW);
 }, Events::PRIORITY_LOW);

 Events::on('foo', static function () use (&$result) {
 $result[] = 'c';
 }, EVENT_PRIORITY_HIGH);
 }, Events::PRIORITY_HIGH);

 Events::on('foo', static function () use (&$result) {
 $result[] = 'd';
Expand Down

1 change: 1 addition & 0 deletions
user_guide_src/source/changelogs/v4.2.0.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -102,6 +102,7 @@ Deprecations
- ``CodeIgniter\Router\Router::setDefaultController()`` is deprecated.
- The constant ``SPARKED`` in **spark** is deprecated. Use the ``$context`` property in ``CodeIgniter\CodeIgniter`` instead.
- ``CodeIgniter\Autoloader\Autoloader::discoverComposerNamespaces()`` is deprecated, and no longer used.
- The constants ``EVENT_PRIORITY_LOW``, ``EVENT_PRIORITY_NORMAL`` and ``EVENT_PRIORITY_HIGH`` are deprecated. Use the class constants ``CodeIgniter\Events\Events::PRIORITY_LOW``, ``CodeIgniter\Events\Events::PRIORITY_NORMAL`` and ``CodeIgniter\Events\Events::PRIORITY_HIGH`` instead.

Bugs Fixed
**********
Expand Down

4 changes: 3 additions & 1 deletion
user_guide_src/source/extending/events.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,11 +46,13 @@ are executed first, with a value of 1 having the highest priority, and there bei

Any subscribers with the same priority will be executed in the order they were defined.

Three constants are defined for your use, that set some helpful ranges on the values. You are not required to use these
Since v4.2.0, three class constants are defined for your use, that set some helpful ranges on the values. You are not required to use these
but you might find they aid readability:

.. literalinclude:: events/004.php

.. note:: The constants ``EVENT_PRIORITY_LOW``, ``EVENT_PRIORITY_NORMAL`` and ``EVENT_PRIORITY_HIGH`` are deprecated, and the definitions are moved to ``app/Config/Constants.php``.

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

8 changes: 5 additions & 3 deletions
user_guide_src/source/extending/events/004.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
<?php

define('EVENT_PRIORITY_LOW', 200);
define('EVENT_PRIORITY_NORMAL', 100);
define('EVENT_PRIORITY_HIGH', 10);
use CodeIgniter\Events\Events;

Events::PRIORITY_LOW; // 200
Events::PRIORITY_NORMAL; // 100
Events::PRIORITY_HIGH; // 10

8 changes: 8 additions & 0 deletions
user_guide_src/source/installation/upgrade_420.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,12 +15,20 @@ Please refer to the upgrade instructions corresponding to your installation meth
Mandatory File Changes
**********************

index.php and spark
===================

The following files received significant changes and
**you must merge the updated versions** with your application:

* ``public/index.php``
* ``spark``

Config/Constants.php
====================

The constants ``EVENT_PRIORITY_LOW``, ``EVENT_PRIORITY_NORMAL`` and ``EVENT_PRIORITY_HIGH`` are deprecated, and the definitions are moved to ``app/Config/Constants.php``. If you use these constants, define them in ``app/Config/Constants.php``. Or use new class constants ``CodeIgniter\Events\Events::PRIORITY_LOW``, ``CodeIgniter\Events\Events::PRIORITY_NORMAL`` and ``CodeIgniter\Events\Events::PRIORITY_HIGH``.

Breaking Changes
****************

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
refactor: deprecate const `EVENT_PRIORITY_*` by kenjis · Pull Request #6000 · codeigniter4/CodeIgniter4 · GitHub
Skip to content
refactor: deprecate const EVENT_PRIORITY_*#6000

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.

 Sign up for GitHub

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

 Merged

kenjis
merged 2 commits into

from

May 18, 2022
 Merged


refactor: deprecate const EVENT_PRIORITY_*#6000
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
35e178d

refactor: deprecate EVENT_PRIORITY_* and add class constants


kenjis May 17, 2022
98b3ad2

docs: update user guide


kenjis May 17, 2022

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: 15 additions & 0 deletions
app/Config/Constants.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -77,3 +77,18 @@
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);

8 changes: 4 additions & 4 deletions
system/Events/Events.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,15 +14,15 @@
use Config\Modules;
use Config\Services;

define('EVENT_PRIORITY_LOW', 200);
define('EVENT_PRIORITY_NORMAL', 100);
define('EVENT_PRIORITY_HIGH', 10);

/**
 * Events
 */
class Events
{
 public const PRIORITY_LOW = 200;
 public const PRIORITY_NORMAL = 100;
 public const PRIORITY_HIGH = 10;

 /**
 * The list of listeners.
 *
Expand Down

6 changes: 3 additions & 3 deletions
tests/system/Events/EventsTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -157,15 +157,15 @@ public function testPriorityWithMultiple()

 Events::on('foo', static function () use (&$result) {
 $result[] = 'a';
 }, EVENT_PRIORITY_NORMAL);
 }, Events::PRIORITY_NORMAL);

 Events::on('foo', static function () use (&$result) {
 $result[] = 'b';
 }, EVENT_PRIORITY_LOW);
 }, Events::PRIORITY_LOW);

 Events::on('foo', static function () use (&$result) {
 $result[] = 'c';
 }, EVENT_PRIORITY_HIGH);
 }, Events::PRIORITY_HIGH);

 Events::on('foo', static function () use (&$result) {
 $result[] = 'd';
Expand Down

1 change: 1 addition & 0 deletions
user_guide_src/source/changelogs/v4.2.0.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -102,6 +102,7 @@ Deprecations
- ``CodeIgniter\Router\Router::setDefaultController()`` is deprecated.
- The constant ``SPARKED`` in **spark** is deprecated. Use the ``$context`` property in ``CodeIgniter\CodeIgniter`` instead.
- ``CodeIgniter\Autoloader\Autoloader::discoverComposerNamespaces()`` is deprecated, and no longer used.
- The constants ``EVENT_PRIORITY_LOW``, ``EVENT_PRIORITY_NORMAL`` and ``EVENT_PRIORITY_HIGH`` are deprecated. Use the class constants ``CodeIgniter\Events\Events::PRIORITY_LOW``, ``CodeIgniter\Events\Events::PRIORITY_NORMAL`` and ``CodeIgniter\Events\Events::PRIORITY_HIGH`` instead.

Bugs Fixed
**********
Expand Down

4 changes: 3 additions & 1 deletion
user_guide_src/source/extending/events.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,11 +46,13 @@ are executed first, with a value of 1 having the highest priority, and there bei

Any subscribers with the same priority will be executed in the order they were defined.

Three constants are defined for your use, that set some helpful ranges on the values. You are not required to use these
Since v4.2.0, three class constants are defined for your use, that set some helpful ranges on the values. You are not required to use these
but you might find they aid readability:

.. literalinclude:: events/004.php

.. note:: The constants ``EVENT_PRIORITY_LOW``, ``EVENT_PRIORITY_NORMAL`` and ``EVENT_PRIORITY_HIGH`` are deprecated, and the definitions are moved to ``app/Config/Constants.php``.

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

8 changes: 5 additions & 3 deletions
user_guide_src/source/extending/events/004.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
<?php

define('EVENT_PRIORITY_LOW', 200);
define('EVENT_PRIORITY_NORMAL', 100);
define('EVENT_PRIORITY_HIGH', 10);
use CodeIgniter\Events\Events;

Events::PRIORITY_LOW; // 200
Events::PRIORITY_NORMAL; // 100
Events::PRIORITY_HIGH; // 10

8 changes: 8 additions & 0 deletions
user_guide_src/source/installation/upgrade_420.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,12 +15,20 @@ Please refer to the upgrade instructions corresponding to your installation meth
Mandatory File Changes
**********************

index.php and spark
===================

The following files received significant changes and
**you must merge the updated versions** with your application:

* ``public/index.php``
* ``spark``

Config/Constants.php
====================

The constants ``EVENT_PRIORITY_LOW``, ``EVENT_PRIORITY_NORMAL`` and ``EVENT_PRIORITY_HIGH`` are deprecated, and the definitions are moved to ``app/Config/Constants.php``. If you use these constants, define them in ``app/Config/Constants.php``. Or use new class constants ``CodeIgniter\Events\Events::PRIORITY_LOW``, ``CodeIgniter\Events\Events::PRIORITY_NORMAL`` and ``CodeIgniter\Events\Events::PRIORITY_HIGH``.

Breaking Changes
****************

Expand Down