docs: fix helper loading#8084

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 5 commits into from
Oct 25, 2023
Merged

docs: fix helper loading #8084

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
cfe8b09
docs: add new section titles "Confirming Namespaces" and "Application…
kenjis Oct 23, 2023
1ab5845
docs: add link to function page
kenjis Oct 23, 2023
bb1369a
docs: add link to "Helper Functions"
kenjis Oct 23, 2023
fa31844
docs: fix description for helper loading
kenjis Oct 23, 2023
59ae2e6
docs: fix typo in doc comment
kenjis Oct 23, 2023
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
2 changes: 1 addition & 1 deletion system/Common.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -579,7 +579,7 @@ function function_usable(string $functionName): bool
if (! function_exists('helper')) {
/**
* Loads a helper file into memory. Supports namespaced helpers,
* both in and out of the 'helpers' directory of a namespaced directory.
* both in and out of the 'Helpers' directory of a namespaced directory.
*
* Will load ALL helpers of the matching name, in the following order:
* 1. app/Helpers
Expand Down
20 changes: 15 additions & 5 deletions user_guide_src/source/concepts/autoloader.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -42,8 +42,10 @@ Configuration
Initial configuration is done in **app/Config/Autoload.php**. This file contains two primary
arrays: one for the classmap, and one for PSR-4 compatible namespaces.

.. _autoloader-namespaces:

Namespaces
**********
==========

The recommended method for organizing your classes is to create one or more namespaces for your
application's files. This is most important for any business-logic related classes, entity classes,
Expand All@@ -55,11 +57,19 @@ those classes can be found in:
The key of each row is the namespace itself. This does not need a trailing back slash.
The value is the location to the directory the classes can be found in.

.. note:: You can check the namespace configuration by ``spark namespaces`` command:
.. _confirming-namespaces:

Confirming Namespaces
=====================

You can check the namespace configuration by ``spark namespaces`` command:

.. code-block:: console

.. code-block:: console
php spark namespaces

php spark namespaces
Application Namespace
=====================

By default, the application directory is namespace to the ``App`` namespace. You must namespace the controllers,
libraries, or models in the application directory, and they will be found under the ``App`` namespace.
Expand All@@ -77,7 +87,7 @@ You will need to modify any existing files that are referencing the current name
namespace has changed.

Classmap
********
========

The classmap is used extensively by CodeIgniter to eke the last ounces of performance out of the system
by not hitting the file-system with extra ``is_file()`` calls. You can use the classmap to link to
Expand Down
41 changes: 29 additions & 12 deletions user_guide_src/source/general/helpers.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -28,17 +28,17 @@ in your :doc:`controller <../incoming/controllers>` and
:doc:`views <../outgoing/views>`.

Helpers are typically stored in your **system/Helpers**, or
**app/Helpers** directory. CodeIgniter will look first in your
**app/Helpers** directory. If the directory does not exist or the
specified helper is not located there CI will instead look in your
global **system/Helpers** directory.
**app/Helpers** directory.

****************
Loading a Helper
****************
***************
Loading Helpers
***************

.. note:: The URL helper is always loaded so you do not need to load it yourself.

Loading a Helper
================

Loading a helper file is quite simple using the following method:

.. literalinclude:: helpers/001.php
Expand All@@ -58,6 +58,23 @@ For example, to load the **Cookie Helper** file, which is named
.. note:: The Helper loading method above does not return a value, so
don't try to assign it to a variable. Just use it as shown.

Auto-Discovery and Composer Packages
------------------------------------

By default, CodeIgniter will search for the helper files in all defined namespaces
by :ref:`auto-discovery`.
You can check your defined namespaces by the spark command. See :ref:`confirming-namespaces`.

If you use many Composer packages, you will have many defined namespaces.
CodeIgniter will scan all namespaces by default.

To avoid wasting time scanning for irrelevant Composer packages, you can manually
specify packages for Auto-Discovery. See :ref:`modules-specify-composer-packages`
for details.

Or you can :ref:`specify a namespace <helpers-loading-from-specified-namespace>`
for a helper that you want to load.

Loading Multiple Helpers
========================

Expand All@@ -81,14 +98,14 @@ it.
However if you want to load in your controller constructor, you can use the ``$helpers``
property in Controller instead. See :ref:`Controllers <controllers-helpers>`.

.. _helpers-loading-from-non-standard-locations:
.. _helpers-loading-from-specified-namespace:

Loading from Non-standard Locations
===================================
Loading from Specified Namespace
================================

Helpers can be loaded from directories outside of **app/Helpers** and
**system/Helpers**, as long as that path can be found through a namespace that
has been set up within the PSR-4 section of the :doc:`Autoloader config file <../concepts/autoloader>`.
**system/Helpers**, as long as that path can be found in defined namespaces.

You would prefix the name of the Helper with the namespace that it can be located
in. Within that namespaced directory, the loader expects it to live within a
sub-directory named **Helpers**. An example will help understand this.
Expand Down
7 changes: 4 additions & 3 deletions user_guide_src/source/general/modules.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -240,12 +240,13 @@ For Windows:
Helpers
=======

Helpers will be automatically discovered within defined namespaces when using the ``helper()`` function, as long as it
is within the namespaces **Helpers** directory:
Helpers will be automatically discovered within defined namespaces when using the
:php:func:`helper()` function, as long as it is within the namespaces **Helpers**
directory:

.. literalinclude:: modules/009.php

You can specify namespaces. See :ref:`helpers-loading-from-non-standard-locations` for details.
You can specify namespaces. See :ref:`helpers-loading-from-specified-namespace` for details.

Language Files
==============
Expand Down
1 change: 1 addition & 0 deletions user_guide_src/source/helpers/index.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ Helpers
#######

Helpers are collections of useful procedural functions.
See also :doc:`../general/helpers`.

.. toctree::
:glob:
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n 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;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
docs: fix helper loading#8084

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 5 commits into

from

Oct 25, 2023
 Merged


docs: fix helper loading
#8084
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
cfe8b09

docs: add new section titles "Confirming Namespaces" and "Application…


kenjis Oct 23, 2023
1ab5845

docs: add link to function page


kenjis Oct 23, 2023
bb1369a

docs: add link to "Helper Functions"


kenjis Oct 23, 2023
fa31844

docs: fix description for helper loading


kenjis Oct 23, 2023
59ae2e6

docs: fix typo in doc comment


kenjis Oct 23, 2023

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


2 changes: 1 addition & 1 deletion
system/Common.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -579,7 +579,7 @@ function function_usable(string $functionName): bool
if (! function_exists('helper')) {
 /**
 * Loads a helper file into memory. Supports namespaced helpers,
 * both in and out of the 'helpers' directory of a namespaced directory.
 * both in and out of the 'Helpers' directory of a namespaced directory.
 *
 * Will load ALL helpers of the matching name, in the following order:
 * 1. app/Helpers
Expand Down

20 changes: 15 additions & 5 deletions
user_guide_src/source/concepts/autoloader.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,8 +42,10 @@ Configuration
Initial configuration is done in **app/Config/Autoload.php**. This file contains two primary
arrays: one for the classmap, and one for PSR-4 compatible namespaces.

.. _autoloader-namespaces:

Namespaces
**********
==========

The recommended method for organizing your classes is to create one or more namespaces for your
application's files. This is most important for any business-logic related classes, entity classes,
Expand All@@ -55,11 +57,19 @@ those classes can be found in:
The key of each row is the namespace itself. This does not need a trailing back slash.
The value is the location to the directory the classes can be found in.

.. note:: You can check the namespace configuration by ``spark namespaces`` command:
.. _confirming-namespaces:

Confirming Namespaces
=====================

You can check the namespace configuration by ``spark namespaces`` command:

.. code-block:: console

.. code-block:: console
php spark namespaces

 php spark namespaces
Application Namespace
=====================

By default, the application directory is namespace to the ``App`` namespace. You must namespace the controllers,
libraries, or models in the application directory, and they will be found under the ``App`` namespace.
Expand All@@ -77,7 +87,7 @@ You will need to modify any existing files that are referencing the current name
 namespace has changed.

Classmap
********
========

The classmap is used extensively by CodeIgniter to eke the last ounces of performance out of the system
by not hitting the file-system with extra ``is_file()`` calls. You can use the classmap to link to
Expand Down

41 changes: 29 additions & 12 deletions
user_guide_src/source/general/helpers.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,17 +28,17 @@ in your :doc:`controller <../incoming/controllers>` and
:doc:`views <../outgoing/views>`.

Helpers are typically stored in your **system/Helpers**, or
**app/Helpers** directory. CodeIgniter will look first in your
**app/Helpers** directory. If the directory does not exist or the
specified helper is not located there CI will instead look in your
global **system/Helpers** directory.
**app/Helpers** directory.

****************
Loading a Helper
****************
***************
Loading Helpers
***************

.. note:: The URL helper is always loaded so you do not need to load it yourself.

Loading a Helper
================

Loading a helper file is quite simple using the following method:

.. literalinclude:: helpers/001.php
Expand All@@ -58,6 +58,23 @@ For example, to load the **Cookie Helper** file, which is named
.. note:: The Helper loading method above does not return a value, so
 don't try to assign it to a variable. Just use it as shown.

Auto-Discovery and Composer Packages
------------------------------------

By default, CodeIgniter will search for the helper files in all defined namespaces
by :ref:`auto-discovery`.
You can check your defined namespaces by the spark command. See :ref:`confirming-namespaces`.

If you use many Composer packages, you will have many defined namespaces.
CodeIgniter will scan all namespaces by default.

To avoid wasting time scanning for irrelevant Composer packages, you can manually
specify packages for Auto-Discovery. See :ref:`modules-specify-composer-packages`
for details.

Or you can :ref:`specify a namespace <helpers-loading-from-specified-namespace>`
for a helper that you want to load.

Loading Multiple Helpers
========================

Expand All@@ -81,14 +98,14 @@ it.
However if you want to load in your controller constructor, you can use the ``$helpers``
property in Controller instead. See :ref:`Controllers <controllers-helpers>`.

.. _helpers-loading-from-non-standard-locations:
.. _helpers-loading-from-specified-namespace:

Loading from Non-standard Locations
===================================
Loading from Specified Namespace
================================

Helpers can be loaded from directories outside of **app/Helpers** and
**system/Helpers**, as long as that path can be found through a namespace that
has been set up within the PSR-4 section of the :doc:`Autoloader config file <../concepts/autoloader>`.
**system/Helpers**, as long as that path can be found in defined namespaces.

You would prefix the name of the Helper with the namespace that it can be located
in. Within that namespaced directory, the loader expects it to live within a
sub-directory named **Helpers**. An example will help understand this.
Expand Down

7 changes: 4 additions & 3 deletions
user_guide_src/source/general/modules.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -240,12 +240,13 @@ For Windows:
Helpers
=======

Helpers will be automatically discovered within defined namespaces when using the ``helper()`` function, as long as it
is within the namespaces **Helpers** directory:
Helpers will be automatically discovered within defined namespaces when using the
:php:func:`helper()` function, as long as it is within the namespaces **Helpers**
directory:

.. literalinclude:: modules/009.php

You can specify namespaces. See :ref:`helpers-loading-from-non-standard-locations` for details.
You can specify namespaces. See :ref:`helpers-loading-from-specified-namespace` for details.

Language Files
==============
Expand Down

1 change: 1 addition & 0 deletions
user_guide_src/source/helpers/index.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ Helpers
#######

Helpers are collections of useful procedural functions.
See also :doc:`../general/helpers`.

.. toctree::
 :glob:
Expand Down

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

Skip to content
docs: fix helper loading#8084

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 5 commits into

from

Oct 25, 2023
 Merged


docs: fix helper loading
#8084
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
cfe8b09

docs: add new section titles "Confirming Namespaces" and "Application…


kenjis Oct 23, 2023
1ab5845

docs: add link to function page


kenjis Oct 23, 2023
bb1369a

docs: add link to "Helper Functions"


kenjis Oct 23, 2023
fa31844

docs: fix description for helper loading


kenjis Oct 23, 2023
59ae2e6

docs: fix typo in doc comment


kenjis Oct 23, 2023

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


2 changes: 1 addition & 1 deletion
system/Common.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -579,7 +579,7 @@ function function_usable(string $functionName): bool
if (! function_exists('helper')) {
 /**
 * Loads a helper file into memory. Supports namespaced helpers,
 * both in and out of the 'helpers' directory of a namespaced directory.
 * both in and out of the 'Helpers' directory of a namespaced directory.
 *
 * Will load ALL helpers of the matching name, in the following order:
 * 1. app/Helpers
Expand Down

20 changes: 15 additions & 5 deletions
user_guide_src/source/concepts/autoloader.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,8 +42,10 @@ Configuration
Initial configuration is done in **app/Config/Autoload.php**. This file contains two primary
arrays: one for the classmap, and one for PSR-4 compatible namespaces.

.. _autoloader-namespaces:

Namespaces
**********
==========

The recommended method for organizing your classes is to create one or more namespaces for your
application's files. This is most important for any business-logic related classes, entity classes,
Expand All@@ -55,11 +57,19 @@ those classes can be found in:
The key of each row is the namespace itself. This does not need a trailing back slash.
The value is the location to the directory the classes can be found in.

.. note:: You can check the namespace configuration by ``spark namespaces`` command:
.. _confirming-namespaces:

Confirming Namespaces
=====================

You can check the namespace configuration by ``spark namespaces`` command:

.. code-block:: console

.. code-block:: console
php spark namespaces

 php spark namespaces
Application Namespace
=====================

By default, the application directory is namespace to the ``App`` namespace. You must namespace the controllers,
libraries, or models in the application directory, and they will be found under the ``App`` namespace.
Expand All@@ -77,7 +87,7 @@ You will need to modify any existing files that are referencing the current name
 namespace has changed.

Classmap
********
========

The classmap is used extensively by CodeIgniter to eke the last ounces of performance out of the system
by not hitting the file-system with extra ``is_file()`` calls. You can use the classmap to link to
Expand Down

41 changes: 29 additions & 12 deletions
user_guide_src/source/general/helpers.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,17 +28,17 @@ in your :doc:`controller <../incoming/controllers>` and
:doc:`views <../outgoing/views>`.

Helpers are typically stored in your **system/Helpers**, or
**app/Helpers** directory. CodeIgniter will look first in your
**app/Helpers** directory. If the directory does not exist or the
specified helper is not located there CI will instead look in your
global **system/Helpers** directory.
**app/Helpers** directory.

****************
Loading a Helper
****************
***************
Loading Helpers
***************

.. note:: The URL helper is always loaded so you do not need to load it yourself.

Loading a Helper
================

Loading a helper file is quite simple using the following method:

.. literalinclude:: helpers/001.php
Expand All@@ -58,6 +58,23 @@ For example, to load the **Cookie Helper** file, which is named
.. note:: The Helper loading method above does not return a value, so
 don't try to assign it to a variable. Just use it as shown.

Auto-Discovery and Composer Packages
------------------------------------

By default, CodeIgniter will search for the helper files in all defined namespaces
by :ref:`auto-discovery`.
You can check your defined namespaces by the spark command. See :ref:`confirming-namespaces`.

If you use many Composer packages, you will have many defined namespaces.
CodeIgniter will scan all namespaces by default.

To avoid wasting time scanning for irrelevant Composer packages, you can manually
specify packages for Auto-Discovery. See :ref:`modules-specify-composer-packages`
for details.

Or you can :ref:`specify a namespace <helpers-loading-from-specified-namespace>`
for a helper that you want to load.

Loading Multiple Helpers
========================

Expand All@@ -81,14 +98,14 @@ it.
However if you want to load in your controller constructor, you can use the ``$helpers``
property in Controller instead. See :ref:`Controllers <controllers-helpers>`.

.. _helpers-loading-from-non-standard-locations:
.. _helpers-loading-from-specified-namespace:

Loading from Non-standard Locations
===================================
Loading from Specified Namespace
================================

Helpers can be loaded from directories outside of **app/Helpers** and
**system/Helpers**, as long as that path can be found through a namespace that
has been set up within the PSR-4 section of the :doc:`Autoloader config file <../concepts/autoloader>`.
**system/Helpers**, as long as that path can be found in defined namespaces.

You would prefix the name of the Helper with the namespace that it can be located
in. Within that namespaced directory, the loader expects it to live within a
sub-directory named **Helpers**. An example will help understand this.
Expand Down

7 changes: 4 additions & 3 deletions
user_guide_src/source/general/modules.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -240,12 +240,13 @@ For Windows:
Helpers
=======

Helpers will be automatically discovered within defined namespaces when using the ``helper()`` function, as long as it
is within the namespaces **Helpers** directory:
Helpers will be automatically discovered within defined namespaces when using the
:php:func:`helper()` function, as long as it is within the namespaces **Helpers**
directory:

.. literalinclude:: modules/009.php

You can specify namespaces. See :ref:`helpers-loading-from-non-standard-locations` for details.
You can specify namespaces. See :ref:`helpers-loading-from-specified-namespace` for details.

Language Files
==============
Expand Down

1 change: 1 addition & 0 deletions
user_guide_src/source/helpers/index.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ Helpers
#######

Helpers are collections of useful procedural functions.
See also :doc:`../general/helpers`.

.. toctree::
 :glob:
Expand Down

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

Skip to content
docs: fix helper loading#8084

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 5 commits into

from

Oct 25, 2023
 Merged


docs: fix helper loading
#8084
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
cfe8b09

docs: add new section titles "Confirming Namespaces" and "Application…


kenjis Oct 23, 2023
1ab5845

docs: add link to function page


kenjis Oct 23, 2023
bb1369a

docs: add link to "Helper Functions"


kenjis Oct 23, 2023
fa31844

docs: fix description for helper loading


kenjis Oct 23, 2023
59ae2e6

docs: fix typo in doc comment


kenjis Oct 23, 2023

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


2 changes: 1 addition & 1 deletion
system/Common.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -579,7 +579,7 @@ function function_usable(string $functionName): bool
if (! function_exists('helper')) {
 /**
 * Loads a helper file into memory. Supports namespaced helpers,
 * both in and out of the 'helpers' directory of a namespaced directory.
 * both in and out of the 'Helpers' directory of a namespaced directory.
 *
 * Will load ALL helpers of the matching name, in the following order:
 * 1. app/Helpers
Expand Down

20 changes: 15 additions & 5 deletions
user_guide_src/source/concepts/autoloader.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,8 +42,10 @@ Configuration
Initial configuration is done in **app/Config/Autoload.php**. This file contains two primary
arrays: one for the classmap, and one for PSR-4 compatible namespaces.

.. _autoloader-namespaces:

Namespaces
**********
==========

The recommended method for organizing your classes is to create one or more namespaces for your
application's files. This is most important for any business-logic related classes, entity classes,
Expand All@@ -55,11 +57,19 @@ those classes can be found in:
The key of each row is the namespace itself. This does not need a trailing back slash.
The value is the location to the directory the classes can be found in.

.. note:: You can check the namespace configuration by ``spark namespaces`` command:
.. _confirming-namespaces:

Confirming Namespaces
=====================

You can check the namespace configuration by ``spark namespaces`` command:

.. code-block:: console

.. code-block:: console
php spark namespaces

 php spark namespaces
Application Namespace
=====================

By default, the application directory is namespace to the ``App`` namespace. You must namespace the controllers,
libraries, or models in the application directory, and they will be found under the ``App`` namespace.
Expand All@@ -77,7 +87,7 @@ You will need to modify any existing files that are referencing the current name
 namespace has changed.

Classmap
********
========

The classmap is used extensively by CodeIgniter to eke the last ounces of performance out of the system
by not hitting the file-system with extra ``is_file()`` calls. You can use the classmap to link to
Expand Down

41 changes: 29 additions & 12 deletions
user_guide_src/source/general/helpers.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,17 +28,17 @@ in your :doc:`controller <../incoming/controllers>` and
:doc:`views <../outgoing/views>`.

Helpers are typically stored in your **system/Helpers**, or
**app/Helpers** directory. CodeIgniter will look first in your
**app/Helpers** directory. If the directory does not exist or the
specified helper is not located there CI will instead look in your
global **system/Helpers** directory.
**app/Helpers** directory.

****************
Loading a Helper
****************
***************
Loading Helpers
***************

.. note:: The URL helper is always loaded so you do not need to load it yourself.

Loading a Helper
================

Loading a helper file is quite simple using the following method:

.. literalinclude:: helpers/001.php
Expand All@@ -58,6 +58,23 @@ For example, to load the **Cookie Helper** file, which is named
.. note:: The Helper loading method above does not return a value, so
 don't try to assign it to a variable. Just use it as shown.

Auto-Discovery and Composer Packages
------------------------------------

By default, CodeIgniter will search for the helper files in all defined namespaces
by :ref:`auto-discovery`.
You can check your defined namespaces by the spark command. See :ref:`confirming-namespaces`.

If you use many Composer packages, you will have many defined namespaces.
CodeIgniter will scan all namespaces by default.

To avoid wasting time scanning for irrelevant Composer packages, you can manually
specify packages for Auto-Discovery. See :ref:`modules-specify-composer-packages`
for details.

Or you can :ref:`specify a namespace <helpers-loading-from-specified-namespace>`
for a helper that you want to load.

Loading Multiple Helpers
========================

Expand All@@ -81,14 +98,14 @@ it.
However if you want to load in your controller constructor, you can use the ``$helpers``
property in Controller instead. See :ref:`Controllers <controllers-helpers>`.

.. _helpers-loading-from-non-standard-locations:
.. _helpers-loading-from-specified-namespace:

Loading from Non-standard Locations
===================================
Loading from Specified Namespace
================================

Helpers can be loaded from directories outside of **app/Helpers** and
**system/Helpers**, as long as that path can be found through a namespace that
has been set up within the PSR-4 section of the :doc:`Autoloader config file <../concepts/autoloader>`.
**system/Helpers**, as long as that path can be found in defined namespaces.

You would prefix the name of the Helper with the namespace that it can be located
in. Within that namespaced directory, the loader expects it to live within a
sub-directory named **Helpers**. An example will help understand this.
Expand Down

7 changes: 4 additions & 3 deletions
user_guide_src/source/general/modules.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -240,12 +240,13 @@ For Windows:
Helpers
=======

Helpers will be automatically discovered within defined namespaces when using the ``helper()`` function, as long as it
is within the namespaces **Helpers** directory:
Helpers will be automatically discovered within defined namespaces when using the
:php:func:`helper()` function, as long as it is within the namespaces **Helpers**
directory:

.. literalinclude:: modules/009.php

You can specify namespaces. See :ref:`helpers-loading-from-non-standard-locations` for details.
You can specify namespaces. See :ref:`helpers-loading-from-specified-namespace` for details.

Language Files
==============
Expand Down

1 change: 1 addition & 0 deletions
user_guide_src/source/helpers/index.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ Helpers
#######

Helpers are collections of useful procedural functions.
See also :doc:`../general/helpers`.

.. toctree::
 :glob:
Expand Down

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

Skip to content
docs: fix helper loading#8084

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 5 commits into

from

Oct 25, 2023
 Merged


docs: fix helper loading
#8084
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
cfe8b09

docs: add new section titles "Confirming Namespaces" and "Application…


kenjis Oct 23, 2023
1ab5845

docs: add link to function page


kenjis Oct 23, 2023
bb1369a

docs: add link to "Helper Functions"


kenjis Oct 23, 2023
fa31844

docs: fix description for helper loading


kenjis Oct 23, 2023
59ae2e6

docs: fix typo in doc comment


kenjis Oct 23, 2023

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


2 changes: 1 addition & 1 deletion
system/Common.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -579,7 +579,7 @@ function function_usable(string $functionName): bool
if (! function_exists('helper')) {
 /**
 * Loads a helper file into memory. Supports namespaced helpers,
 * both in and out of the 'helpers' directory of a namespaced directory.
 * both in and out of the 'Helpers' directory of a namespaced directory.
 *
 * Will load ALL helpers of the matching name, in the following order:
 * 1. app/Helpers
Expand Down

20 changes: 15 additions & 5 deletions
user_guide_src/source/concepts/autoloader.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,8 +42,10 @@ Configuration
Initial configuration is done in **app/Config/Autoload.php**. This file contains two primary
arrays: one for the classmap, and one for PSR-4 compatible namespaces.

.. _autoloader-namespaces:

Namespaces
**********
==========

The recommended method for organizing your classes is to create one or more namespaces for your
application's files. This is most important for any business-logic related classes, entity classes,
Expand All@@ -55,11 +57,19 @@ those classes can be found in:
The key of each row is the namespace itself. This does not need a trailing back slash.
The value is the location to the directory the classes can be found in.

.. note:: You can check the namespace configuration by ``spark namespaces`` command:
.. _confirming-namespaces:

Confirming Namespaces
=====================

You can check the namespace configuration by ``spark namespaces`` command:

.. code-block:: console

.. code-block:: console
php spark namespaces

 php spark namespaces
Application Namespace
=====================

By default, the application directory is namespace to the ``App`` namespace. You must namespace the controllers,
libraries, or models in the application directory, and they will be found under the ``App`` namespace.
Expand All@@ -77,7 +87,7 @@ You will need to modify any existing files that are referencing the current name
 namespace has changed.

Classmap
********
========

The classmap is used extensively by CodeIgniter to eke the last ounces of performance out of the system
by not hitting the file-system with extra ``is_file()`` calls. You can use the classmap to link to
Expand Down

41 changes: 29 additions & 12 deletions
user_guide_src/source/general/helpers.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,17 +28,17 @@ in your :doc:`controller <../incoming/controllers>` and
:doc:`views <../outgoing/views>`.

Helpers are typically stored in your **system/Helpers**, or
**app/Helpers** directory. CodeIgniter will look first in your
**app/Helpers** directory. If the directory does not exist or the
specified helper is not located there CI will instead look in your
global **system/Helpers** directory.
**app/Helpers** directory.

****************
Loading a Helper
****************
***************
Loading Helpers
***************

.. note:: The URL helper is always loaded so you do not need to load it yourself.

Loading a Helper
================

Loading a helper file is quite simple using the following method:

.. literalinclude:: helpers/001.php
Expand All@@ -58,6 +58,23 @@ For example, to load the **Cookie Helper** file, which is named
.. note:: The Helper loading method above does not return a value, so
 don't try to assign it to a variable. Just use it as shown.

Auto-Discovery and Composer Packages
------------------------------------

By default, CodeIgniter will search for the helper files in all defined namespaces
by :ref:`auto-discovery`.
You can check your defined namespaces by the spark command. See :ref:`confirming-namespaces`.

If you use many Composer packages, you will have many defined namespaces.
CodeIgniter will scan all namespaces by default.

To avoid wasting time scanning for irrelevant Composer packages, you can manually
specify packages for Auto-Discovery. See :ref:`modules-specify-composer-packages`
for details.

Or you can :ref:`specify a namespace <helpers-loading-from-specified-namespace>`
for a helper that you want to load.

Loading Multiple Helpers
========================

Expand All@@ -81,14 +98,14 @@ it.
However if you want to load in your controller constructor, you can use the ``$helpers``
property in Controller instead. See :ref:`Controllers <controllers-helpers>`.

.. _helpers-loading-from-non-standard-locations:
.. _helpers-loading-from-specified-namespace:

Loading from Non-standard Locations
===================================
Loading from Specified Namespace
================================

Helpers can be loaded from directories outside of **app/Helpers** and
**system/Helpers**, as long as that path can be found through a namespace that
has been set up within the PSR-4 section of the :doc:`Autoloader config file <../concepts/autoloader>`.
**system/Helpers**, as long as that path can be found in defined namespaces.

You would prefix the name of the Helper with the namespace that it can be located
in. Within that namespaced directory, the loader expects it to live within a
sub-directory named **Helpers**. An example will help understand this.
Expand Down

7 changes: 4 additions & 3 deletions
user_guide_src/source/general/modules.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -240,12 +240,13 @@ For Windows:
Helpers
=======

Helpers will be automatically discovered within defined namespaces when using the ``helper()`` function, as long as it
is within the namespaces **Helpers** directory:
Helpers will be automatically discovered within defined namespaces when using the
:php:func:`helper()` function, as long as it is within the namespaces **Helpers**
directory:

.. literalinclude:: modules/009.php

You can specify namespaces. See :ref:`helpers-loading-from-non-standard-locations` for details.
You can specify namespaces. See :ref:`helpers-loading-from-specified-namespace` for details.

Language Files
==============
Expand Down

1 change: 1 addition & 0 deletions
user_guide_src/source/helpers/index.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ Helpers
#######

Helpers are collections of useful procedural functions.
See also :doc:`../general/helpers`.

.. toctree::
 :glob:
Expand Down

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

Skip to content
docs: fix helper loading#8084

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 5 commits into

from

Oct 25, 2023
 Merged


docs: fix helper loading
#8084
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
cfe8b09

docs: add new section titles "Confirming Namespaces" and "Application…


kenjis Oct 23, 2023
1ab5845

docs: add link to function page


kenjis Oct 23, 2023
bb1369a

docs: add link to "Helper Functions"


kenjis Oct 23, 2023
fa31844

docs: fix description for helper loading


kenjis Oct 23, 2023
59ae2e6

docs: fix typo in doc comment


kenjis Oct 23, 2023

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


2 changes: 1 addition & 1 deletion
system/Common.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -579,7 +579,7 @@ function function_usable(string $functionName): bool
if (! function_exists('helper')) {
 /**
 * Loads a helper file into memory. Supports namespaced helpers,
 * both in and out of the 'helpers' directory of a namespaced directory.
 * both in and out of the 'Helpers' directory of a namespaced directory.
 *
 * Will load ALL helpers of the matching name, in the following order:
 * 1. app/Helpers
Expand Down

20 changes: 15 additions & 5 deletions
user_guide_src/source/concepts/autoloader.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,8 +42,10 @@ Configuration
Initial configuration is done in **app/Config/Autoload.php**. This file contains two primary
arrays: one for the classmap, and one for PSR-4 compatible namespaces.

.. _autoloader-namespaces:

Namespaces
**********
==========

The recommended method for organizing your classes is to create one or more namespaces for your
application's files. This is most important for any business-logic related classes, entity classes,
Expand All@@ -55,11 +57,19 @@ those classes can be found in:
The key of each row is the namespace itself. This does not need a trailing back slash.
The value is the location to the directory the classes can be found in.

.. note:: You can check the namespace configuration by ``spark namespaces`` command:
.. _confirming-namespaces:

Confirming Namespaces
=====================

You can check the namespace configuration by ``spark namespaces`` command:

.. code-block:: console

.. code-block:: console
php spark namespaces

 php spark namespaces
Application Namespace
=====================

By default, the application directory is namespace to the ``App`` namespace. You must namespace the controllers,
libraries, or models in the application directory, and they will be found under the ``App`` namespace.
Expand All@@ -77,7 +87,7 @@ You will need to modify any existing files that are referencing the current name
 namespace has changed.

Classmap
********
========

The classmap is used extensively by CodeIgniter to eke the last ounces of performance out of the system
by not hitting the file-system with extra ``is_file()`` calls. You can use the classmap to link to
Expand Down

41 changes: 29 additions & 12 deletions
user_guide_src/source/general/helpers.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,17 +28,17 @@ in your :doc:`controller <../incoming/controllers>` and
:doc:`views <../outgoing/views>`.

Helpers are typically stored in your **system/Helpers**, or
**app/Helpers** directory. CodeIgniter will look first in your
**app/Helpers** directory. If the directory does not exist or the
specified helper is not located there CI will instead look in your
global **system/Helpers** directory.
**app/Helpers** directory.

****************
Loading a Helper
****************
***************
Loading Helpers
***************

.. note:: The URL helper is always loaded so you do not need to load it yourself.

Loading a Helper
================

Loading a helper file is quite simple using the following method:

.. literalinclude:: helpers/001.php
Expand All@@ -58,6 +58,23 @@ For example, to load the **Cookie Helper** file, which is named
.. note:: The Helper loading method above does not return a value, so
 don't try to assign it to a variable. Just use it as shown.

Auto-Discovery and Composer Packages
------------------------------------

By default, CodeIgniter will search for the helper files in all defined namespaces
by :ref:`auto-discovery`.
You can check your defined namespaces by the spark command. See :ref:`confirming-namespaces`.

If you use many Composer packages, you will have many defined namespaces.
CodeIgniter will scan all namespaces by default.

To avoid wasting time scanning for irrelevant Composer packages, you can manually
specify packages for Auto-Discovery. See :ref:`modules-specify-composer-packages`
for details.

Or you can :ref:`specify a namespace <helpers-loading-from-specified-namespace>`
for a helper that you want to load.

Loading Multiple Helpers
========================

Expand All@@ -81,14 +98,14 @@ it.
However if you want to load in your controller constructor, you can use the ``$helpers``
property in Controller instead. See :ref:`Controllers <controllers-helpers>`.

.. _helpers-loading-from-non-standard-locations:
.. _helpers-loading-from-specified-namespace:

Loading from Non-standard Locations
===================================
Loading from Specified Namespace
================================

Helpers can be loaded from directories outside of **app/Helpers** and
**system/Helpers**, as long as that path can be found through a namespace that
has been set up within the PSR-4 section of the :doc:`Autoloader config file <../concepts/autoloader>`.
**system/Helpers**, as long as that path can be found in defined namespaces.

You would prefix the name of the Helper with the namespace that it can be located
in. Within that namespaced directory, the loader expects it to live within a
sub-directory named **Helpers**. An example will help understand this.
Expand Down

7 changes: 4 additions & 3 deletions
user_guide_src/source/general/modules.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -240,12 +240,13 @@ For Windows:
Helpers
=======

Helpers will be automatically discovered within defined namespaces when using the ``helper()`` function, as long as it
is within the namespaces **Helpers** directory:
Helpers will be automatically discovered within defined namespaces when using the
:php:func:`helper()` function, as long as it is within the namespaces **Helpers**
directory:

.. literalinclude:: modules/009.php

You can specify namespaces. See :ref:`helpers-loading-from-non-standard-locations` for details.
You can specify namespaces. See :ref:`helpers-loading-from-specified-namespace` for details.

Language Files
==============
Expand Down

1 change: 1 addition & 0 deletions
user_guide_src/source/helpers/index.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ Helpers
#######

Helpers are collections of useful procedural functions.
See also :doc:`../general/helpers`.

.. toctree::
 :glob:
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
docs: fix helper loading#8084

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 5 commits into

from

Oct 25, 2023
 Merged


docs: fix helper loading
#8084
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
cfe8b09

docs: add new section titles "Confirming Namespaces" and "Application…


kenjis Oct 23, 2023
1ab5845

docs: add link to function page


kenjis Oct 23, 2023
bb1369a

docs: add link to "Helper Functions"


kenjis Oct 23, 2023
fa31844

docs: fix description for helper loading


kenjis Oct 23, 2023
59ae2e6

docs: fix typo in doc comment


kenjis Oct 23, 2023

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


2 changes: 1 addition & 1 deletion
system/Common.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -579,7 +579,7 @@ function function_usable(string $functionName): bool
if (! function_exists('helper')) {
 /**
 * Loads a helper file into memory. Supports namespaced helpers,
 * both in and out of the 'helpers' directory of a namespaced directory.
 * both in and out of the 'Helpers' directory of a namespaced directory.
 *
 * Will load ALL helpers of the matching name, in the following order:
 * 1. app/Helpers
Expand Down

20 changes: 15 additions & 5 deletions
user_guide_src/source/concepts/autoloader.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,8 +42,10 @@ Configuration
Initial configuration is done in **app/Config/Autoload.php**. This file contains two primary
arrays: one for the classmap, and one for PSR-4 compatible namespaces.

.. _autoloader-namespaces:

Namespaces
**********
==========

The recommended method for organizing your classes is to create one or more namespaces for your
application's files. This is most important for any business-logic related classes, entity classes,
Expand All@@ -55,11 +57,19 @@ those classes can be found in:
The key of each row is the namespace itself. This does not need a trailing back slash.
The value is the location to the directory the classes can be found in.

.. note:: You can check the namespace configuration by ``spark namespaces`` command:
.. _confirming-namespaces:

Confirming Namespaces
=====================

You can check the namespace configuration by ``spark namespaces`` command:

.. code-block:: console

.. code-block:: console
php spark namespaces

 php spark namespaces
Application Namespace
=====================

By default, the application directory is namespace to the ``App`` namespace. You must namespace the controllers,
libraries, or models in the application directory, and they will be found under the ``App`` namespace.
Expand All@@ -77,7 +87,7 @@ You will need to modify any existing files that are referencing the current name
 namespace has changed.

Classmap
********
========

The classmap is used extensively by CodeIgniter to eke the last ounces of performance out of the system
by not hitting the file-system with extra ``is_file()`` calls. You can use the classmap to link to
Expand Down

41 changes: 29 additions & 12 deletions
user_guide_src/source/general/helpers.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,17 +28,17 @@ in your :doc:`controller <../incoming/controllers>` and
:doc:`views <../outgoing/views>`.

Helpers are typically stored in your **system/Helpers**, or
**app/Helpers** directory. CodeIgniter will look first in your
**app/Helpers** directory. If the directory does not exist or the
specified helper is not located there CI will instead look in your
global **system/Helpers** directory.
**app/Helpers** directory.

****************
Loading a Helper
****************
***************
Loading Helpers
***************

.. note:: The URL helper is always loaded so you do not need to load it yourself.

Loading a Helper
================

Loading a helper file is quite simple using the following method:

.. literalinclude:: helpers/001.php
Expand All@@ -58,6 +58,23 @@ For example, to load the **Cookie Helper** file, which is named
.. note:: The Helper loading method above does not return a value, so
 don't try to assign it to a variable. Just use it as shown.

Auto-Discovery and Composer Packages
------------------------------------

By default, CodeIgniter will search for the helper files in all defined namespaces
by :ref:`auto-discovery`.
You can check your defined namespaces by the spark command. See :ref:`confirming-namespaces`.

If you use many Composer packages, you will have many defined namespaces.
CodeIgniter will scan all namespaces by default.

To avoid wasting time scanning for irrelevant Composer packages, you can manually
specify packages for Auto-Discovery. See :ref:`modules-specify-composer-packages`
for details.

Or you can :ref:`specify a namespace <helpers-loading-from-specified-namespace>`
for a helper that you want to load.

Loading Multiple Helpers
========================

Expand All@@ -81,14 +98,14 @@ it.
However if you want to load in your controller constructor, you can use the ``$helpers``
property in Controller instead. See :ref:`Controllers <controllers-helpers>`.

.. _helpers-loading-from-non-standard-locations:
.. _helpers-loading-from-specified-namespace:

Loading from Non-standard Locations
===================================
Loading from Specified Namespace
================================

Helpers can be loaded from directories outside of **app/Helpers** and
**system/Helpers**, as long as that path can be found through a namespace that
has been set up within the PSR-4 section of the :doc:`Autoloader config file <../concepts/autoloader>`.
**system/Helpers**, as long as that path can be found in defined namespaces.

You would prefix the name of the Helper with the namespace that it can be located
in. Within that namespaced directory, the loader expects it to live within a
sub-directory named **Helpers**. An example will help understand this.
Expand Down

7 changes: 4 additions & 3 deletions
user_guide_src/source/general/modules.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -240,12 +240,13 @@ For Windows:
Helpers
=======

Helpers will be automatically discovered within defined namespaces when using the ``helper()`` function, as long as it
is within the namespaces **Helpers** directory:
Helpers will be automatically discovered within defined namespaces when using the
:php:func:`helper()` function, as long as it is within the namespaces **Helpers**
directory:

.. literalinclude:: modules/009.php

You can specify namespaces. See :ref:`helpers-loading-from-non-standard-locations` for details.
You can specify namespaces. See :ref:`helpers-loading-from-specified-namespace` for details.

Language Files
==============
Expand Down

1 change: 1 addition & 0 deletions
user_guide_src/source/helpers/index.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ Helpers
#######

Helpers are collections of useful procedural functions.
See also :doc:`../general/helpers`.

.. toctree::
 :glob:
Expand Down

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

Skip to content
docs: fix helper loading#8084

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 5 commits into

from

Oct 25, 2023
 Merged


docs: fix helper loading
#8084
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
cfe8b09

docs: add new section titles "Confirming Namespaces" and "Application…


kenjis Oct 23, 2023
1ab5845

docs: add link to function page


kenjis Oct 23, 2023
bb1369a

docs: add link to "Helper Functions"


kenjis Oct 23, 2023
fa31844

docs: fix description for helper loading


kenjis Oct 23, 2023
59ae2e6

docs: fix typo in doc comment


kenjis Oct 23, 2023

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


2 changes: 1 addition & 1 deletion
system/Common.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -579,7 +579,7 @@ function function_usable(string $functionName): bool
if (! function_exists('helper')) {
 /**
 * Loads a helper file into memory. Supports namespaced helpers,
 * both in and out of the 'helpers' directory of a namespaced directory.
 * both in and out of the 'Helpers' directory of a namespaced directory.
 *
 * Will load ALL helpers of the matching name, in the following order:
 * 1. app/Helpers
Expand Down

20 changes: 15 additions & 5 deletions
user_guide_src/source/concepts/autoloader.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,8 +42,10 @@ Configuration
Initial configuration is done in **app/Config/Autoload.php**. This file contains two primary
arrays: one for the classmap, and one for PSR-4 compatible namespaces.

.. _autoloader-namespaces:

Namespaces
**********
==========

The recommended method for organizing your classes is to create one or more namespaces for your
application's files. This is most important for any business-logic related classes, entity classes,
Expand All@@ -55,11 +57,19 @@ those classes can be found in:
The key of each row is the namespace itself. This does not need a trailing back slash.
The value is the location to the directory the classes can be found in.

.. note:: You can check the namespace configuration by ``spark namespaces`` command:
.. _confirming-namespaces:

Confirming Namespaces
=====================

You can check the namespace configuration by ``spark namespaces`` command:

.. code-block:: console

.. code-block:: console
php spark namespaces

 php spark namespaces
Application Namespace
=====================

By default, the application directory is namespace to the ``App`` namespace. You must namespace the controllers,
libraries, or models in the application directory, and they will be found under the ``App`` namespace.
Expand All@@ -77,7 +87,7 @@ You will need to modify any existing files that are referencing the current name
 namespace has changed.

Classmap
********
========

The classmap is used extensively by CodeIgniter to eke the last ounces of performance out of the system
by not hitting the file-system with extra ``is_file()`` calls. You can use the classmap to link to
Expand Down

41 changes: 29 additions & 12 deletions
user_guide_src/source/general/helpers.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,17 +28,17 @@ in your :doc:`controller <../incoming/controllers>` and
:doc:`views <../outgoing/views>`.

Helpers are typically stored in your **system/Helpers**, or
**app/Helpers** directory. CodeIgniter will look first in your
**app/Helpers** directory. If the directory does not exist or the
specified helper is not located there CI will instead look in your
global **system/Helpers** directory.
**app/Helpers** directory.

****************
Loading a Helper
****************
***************
Loading Helpers
***************

.. note:: The URL helper is always loaded so you do not need to load it yourself.

Loading a Helper
================

Loading a helper file is quite simple using the following method:

.. literalinclude:: helpers/001.php
Expand All@@ -58,6 +58,23 @@ For example, to load the **Cookie Helper** file, which is named
.. note:: The Helper loading method above does not return a value, so
 don't try to assign it to a variable. Just use it as shown.

Auto-Discovery and Composer Packages
------------------------------------

By default, CodeIgniter will search for the helper files in all defined namespaces
by :ref:`auto-discovery`.
You can check your defined namespaces by the spark command. See :ref:`confirming-namespaces`.

If you use many Composer packages, you will have many defined namespaces.
CodeIgniter will scan all namespaces by default.

To avoid wasting time scanning for irrelevant Composer packages, you can manually
specify packages for Auto-Discovery. See :ref:`modules-specify-composer-packages`
for details.

Or you can :ref:`specify a namespace <helpers-loading-from-specified-namespace>`
for a helper that you want to load.

Loading Multiple Helpers
========================

Expand All@@ -81,14 +98,14 @@ it.
However if you want to load in your controller constructor, you can use the ``$helpers``
property in Controller instead. See :ref:`Controllers <controllers-helpers>`.

.. _helpers-loading-from-non-standard-locations:
.. _helpers-loading-from-specified-namespace:

Loading from Non-standard Locations
===================================
Loading from Specified Namespace
================================

Helpers can be loaded from directories outside of **app/Helpers** and
**system/Helpers**, as long as that path can be found through a namespace that
has been set up within the PSR-4 section of the :doc:`Autoloader config file <../concepts/autoloader>`.
**system/Helpers**, as long as that path can be found in defined namespaces.

You would prefix the name of the Helper with the namespace that it can be located
in. Within that namespaced directory, the loader expects it to live within a
sub-directory named **Helpers**. An example will help understand this.
Expand Down

7 changes: 4 additions & 3 deletions
user_guide_src/source/general/modules.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -240,12 +240,13 @@ For Windows:
Helpers
=======

Helpers will be automatically discovered within defined namespaces when using the ``helper()`` function, as long as it
is within the namespaces **Helpers** directory:
Helpers will be automatically discovered within defined namespaces when using the
:php:func:`helper()` function, as long as it is within the namespaces **Helpers**
directory:

.. literalinclude:: modules/009.php

You can specify namespaces. See :ref:`helpers-loading-from-non-standard-locations` for details.
You can specify namespaces. See :ref:`helpers-loading-from-specified-namespace` for details.

Language Files
==============
Expand Down

1 change: 1 addition & 0 deletions
user_guide_src/source/helpers/index.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ Helpers
#######

Helpers are collections of useful procedural functions.
See also :doc:`../general/helpers`.

.. toctree::
 :glob:
Expand Down