Merge pull request #6397 from kenjis/feat-autoload-helpers

feat: autoload helpers

Author: kenjis

app/Config/Autoload.php

@@ -31,12 +31,10 @@ class Autoload extends AutoloadConfig
      * else you will need to modify all of those classes for this to work.
      *
      * Prototype:
-     *```
      *   $psr4 = [
      *       'CodeIgniter' => SYSTEMPATH,
-     *       'App'	       => APPPATH
+     *       'App'         => APPPATH
      *   ];
-     *```
      *
      * @var array<string, string>
      */
@@ -56,11 +54,9 @@ class Autoload extends AutoloadConfig
      * were being autoloaded through a namespace.
      *
      * Prototype:
-     *```
      *   $classmap = [
      *       'MyClass'   => '/path/to/class/file.php'
      *   ];
-     *```
      *
      * @var array<string, string>
      */
@@ -75,13 +71,26 @@ class Autoload extends AutoloadConfig
      * or for loading functions.
      *
      * Prototype:
-     * ```
-     *	  $files = [
-     *	 	   '/path/to/my/file.php',
-     *    ];
-     * ```
+     *   $files = [
+     *       '/path/to/my/file.php',
+     *   ];
      *
-     * @var array<int, string>
+     * @var string[]
+     * @phpstan-var list<string>
      */
     public $files = [];
+
+    /**
+     * -------------------------------------------------------------------
+     * Helpers
+     * -------------------------------------------------------------------
+     * Prototype:
+     *   $helpers = [
+     *       'form',
+     *   ];
+     *
+     * @var string[]
+     * @phpstan-var list<string>
+     */
+    public $helpers = [];
 }

system/Autoloader/Autoloader.php

@@ -71,10 +71,20 @@ class Autoloader
     /**
      * Stores files as a list.
      *
-     * @var array<int, string>
+     * @var string[]
+     * @phpstan-var list<string>
      */
     protected $files = [];
 
+    /**
+     * Stores helper list.
+     * Always load the URL helper, it should be used in most apps.
+     *
+     * @var string[]
+     * @phpstan-var list<string>
+     */
+    protected $helpers = ['url'];
+
     /**
      * Reads in the configuration array (described above) and stores
      * the valid parts that we'll need.
@@ -105,6 +115,10 @@ public function initialize(Autoload $config, Modules $modules)
             $this->files = $config->files;
         }
 
+        if (isset($config->helpers)) { // @phpstan-ignore-line
+            $this->helpers = [...$this->helpers, ...$config->helpers];
+        }
+
         if (is_file(COMPOSER_PATH)) {
             $this->loadComposerInfo($modules);
         }
@@ -146,6 +160,17 @@ public function register()
         }
     }
 
+    /**
+     * Unregister autoloader.
+     *
+     * This method is for testing.
+     */
+    public function unregister(): void
+    {
+        spl_autoload_unregister([$this, 'loadClass']);
+        spl_autoload_unregister([$this, 'loadClassmap']);
+    }
+
     /**
      * Registers namespaces with the autoloader.
      *
@@ -396,4 +421,12 @@ protected function discoverComposerNamespaces()
         $this->prefixes = array_merge($this->prefixes, $newPaths);
         $this->classmap = array_merge($this->classmap, $classes);
     }
+
+    /**
+     * Loads helpers
+     */
+    public function loadHelpers(): void
+    {
+        helper($this->helpers);
+    }
 }

system/bootstrap.php

@@ -103,6 +103,7 @@
 
 // Initialize and register the loader with the SPL autoloader stack.
 Services::autoloader()->initialize(new Autoload(), new Modules())->register();
+Services::autoloader()->loadHelpers();
 
 // Now load Composer's if it's available
 if (is_file(COMPOSER_PATH)) {
@@ -117,6 +118,3 @@
 
     require_once COMPOSER_PATH;
 }
-
-// Always load the URL helper, it should be used in most of apps.
-helper('url');

tests/system/Autoloader/AutoloaderTest.php

@@ -49,6 +49,13 @@ protected function setUp(): void
         $this->loader->initialize($config, $modules)->register();
     }
 
+    protected function tearDown(): void
+    {
+        $this->loader->unregister();
+
+        parent::tearDown();
+    }
+
     public function testLoadStoredClass()
     {
         $this->assertInstanceOf('UnnamespacedClass', new UnnamespacedClass());
@@ -98,10 +105,13 @@ public function testServiceAutoLoader()
         $autoloader = Services::autoloader(false);
         $autoloader->initialize(new Autoload(), new Modules());
         $autoloader->register();
+
         // look for Home controller, as that should be in base repo
         $actual   = $autoloader->loadClass(Home::class);
         $expected = APPPATH . 'Controllers' . DIRECTORY_SEPARATOR . 'Home.php';
         $this->assertSame($expected, realpath($actual) ?: $actual);
+
+        $autoloader->unregister();
     }
 
     public function testExistingFile()
@@ -252,10 +262,10 @@ public function testFindsComposerRoutes()
         $modules                     = new Modules();
         $modules->discoverInComposer = true;
 
-        $this->loader = new Autoloader();
-        $this->loader->initialize($config, $modules);
+        $loader = new Autoloader();
+        $loader->initialize($config, $modules);
 
-        $namespaces = $this->loader->getNamespace();
+        $namespaces = $loader->getNamespace();
         $this->assertArrayHasKey('Laminas\\Escaper', $namespaces);
     }
 
@@ -268,10 +278,10 @@ public function testComposerNamespaceDoesNotOverwriteConfigAutoloadPsr4()
         $modules                     = new Modules();
         $modules->discoverInComposer = true;
 
-        $this->loader = new Autoloader();
-        $this->loader->initialize($config, $modules);
+        $loader = new Autoloader();
+        $loader->initialize($config, $modules);
 
-        $namespaces = $this->loader->getNamespace();
+        $namespaces = $loader->getNamespace();
         $this->assertSame('/Config/Autoload/Psr/Log/', $namespaces['Psr\Log'][0]);
         $this->assertStringContainsString(VENDORPATH, $namespaces['Psr\Log'][1]);
     }
@@ -284,29 +294,49 @@ public function testFindsComposerRoutesWithComposerPathNotFound()
         $modules                     = new Modules();
         $modules->discoverInComposer = true;
 
-        $this->loader = new Autoloader();
+        $loader = new Autoloader();
 
         rename(COMPOSER_PATH, COMPOSER_PATH . '.backup');
-        $this->loader->initialize($config, $modules);
+        $loader->initialize($config, $modules);
         rename(COMPOSER_PATH . '.backup', $composerPath);
 
-        $namespaces = $this->loader->getNamespace();
+        $namespaces = $loader->getNamespace();
         $this->assertArrayNotHasKey('Laminas\\Escaper', $namespaces);
     }
 
     public function testAutoloaderLoadsNonClassFiles(): void
     {
-        $config = new Autoload();
-
+        $config          = new Autoload();
         $config->files[] = SUPPORTPATH . 'Autoloader/functions.php';
 
-        $this->loader = new Autoloader();
-        $this->loader->initialize($config, new Modules());
-        $this->loader->register();
+        $loader = new Autoloader();
+        $loader->initialize($config, new Modules());
+        $loader->register();
 
         $this->assertTrue(function_exists('autoload_foo'));
         $this->assertSame('I am autoloaded by Autoloader through $files!', autoload_foo());
         $this->assertTrue(defined('AUTOLOAD_CONSTANT'));
         $this->assertSame('foo', AUTOLOAD_CONSTANT);
+
+        $loader->unregister();
+    }
+
+    /**
+     * @runInSeparateProcess
+     * @preserveGlobalState  disabled
+     */
+    public function testLoadHelpers(): void
+    {
+        $config            = new Autoload();
+        $config->helpers[] = 'form';
+
+        $loader = new Autoloader();
+        $loader->initialize($config, new Modules());
+
+        $loader->loadHelpers();
+
+        $this->assertTrue(function_exists('form_open'));
+
+        $loader->unregister();
     }
 }

user_guide_src/source/changelogs/v4.3.0.rst

@@ -68,6 +68,7 @@ Others
 - Added new :ref:`entities-property-casting` class ``IntBoolCast`` for Entity.
 - Help information for a spark command can now be accessed using the ``--help`` option (e.g. ``php spark serve --help``)
 - Added new Form helper function :php:func:`validation_errors()`, :php:func:`validation_list_errors()` and :php:func:`validation_show_error()` to display Validation Errors.
+- Now you can autoload helpers by **app/Config/Autoload.php**.
 
 Changes
 *******

user_guide_src/source/general/helpers.rst

@@ -83,6 +83,18 @@ use the following command to load the helper for us:
 .. note:: The functions within files loaded this way are not truly namespaced.
     The namespace is simply used as a convenient way to locate the files.
 
+.. _auto-loading-helpers:
+
+Auto-loading Helpers
+--------------------
+
+.. versionadded:: 4.3.0
+
+If you find that you need a particular helper globally throughout your application,
+you can tell CodeIgniter to auto-load it during system initialization.
+This is done by opening the **app/Config/Autoload.php** file
+and adding the helper to the ``$helpers`` property.
+
 Using a Helper
 ==============
 

user_guide_src/source/installation/upgrade_4xx.rst

@@ -109,6 +109,7 @@ Helpers
 =======
 
 - Helpers are pretty much the same as before, though some have been simplified.
+- Since v4.3.0, you can autoload helpers by **app/Config/Autoload.php** as well as CI3.
 - In CI4, ``redirect()`` returns a ``RedirectResponse`` instance instead of redirecting and terminating script execution. You must return it.
     - `redirect() Documentation CodeIgniter 3.X <https://codeigniter.com/userguide3/helpers/url_helper.html#redirect>`_
     - `redirect() Documentation CodeIgniter 4.X <../general/common_functions.html#redirect>`_