feat: add Config\Optimize::$locatorCacheEnabled

codeigniter4 · Mar 7, 2024 · 49c4522 · 49c4522
1 parent a241659
commit 49c4522
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 28 deletions.
diff --git a/app/Config/Optimize.php b/app/Config/Optimize.php
@@ -20,4 +20,13 @@ class Optimize
      * @see https://codeigniter.com/user_guide/concepts/factories.html#config-caching
      */
     public bool $configCacheEnabled = false;
+
+    /**
+     * --------------------------------------------------------------------------
+     * Config Caching
+     * --------------------------------------------------------------------------
+     *
+     * @see https://codeigniter.com/user_guide/concepts/autoloader.html#file-locator-caching
+     */
+    public bool $locatorCacheEnabled = false;
 }
diff --git a/system/Config/BaseService.php b/system/Config/BaseService.php
@@ -15,6 +15,7 @@
 
 use CodeIgniter\Autoloader\Autoloader;
 use CodeIgniter\Autoloader\FileLocator;
+use CodeIgniter\Autoloader\FileLocatorCached;
 use CodeIgniter\Autoloader\FileLocatorInterface;
 use CodeIgniter\Cache\CacheInterface;
 use CodeIgniter\Cache\ResponseCache;
@@ -71,6 +72,7 @@
 use Config\Images;
 use Config\Migrations;
 use Config\Modules;
+use Config\Optimize;
 use Config\Pager as ConfigPager;
 use Config\Services as AppServices;
 use Config\Toolbar as ConfigToolbar;
@@ -281,7 +283,14 @@ public static function locator(bool $getShared = true)
     {
         if ($getShared) {
             if (empty(static::$instances['locator'])) {
-                static::$instances['locator'] = new FileLocator(static::autoloader());
+                $cacheEnabled = class_exists(Optimize::class)
+                    && (new Optimize())->locatorCacheEnabled;
+
+                if ($cacheEnabled) {
+                    static::$instances['locator'] = new FileLocatorCached(new FileLocator(static::autoloader()));
+                } else {
+                    static::$instances['locator'] = new FileLocator(static::autoloader());
+                }
             }
 
             return static::$mocks['locator'] ?? static::$instances['locator'];

diff --git a/user_guide_src/source/concepts/autoloader.rst b/user_guide_src/source/concepts/autoloader.rst
@@ -190,6 +190,6 @@ Or simply delete the **writable/cache/FileLocatorCache** file.
 How to Enable FileLocator Caching
 =================================
 
-Add the following code in **app/Config/Services.php**:
+Set the following property to ``true`` in **app/Config/Optimize.php**::
 
-.. literalinclude:: autoloader/004.php
+    public bool $locatorCacheEnabled = true;
diff --git a/user_guide_src/source/concepts/autoloader/004.php b/user_guide_src/source/concepts/autoloader/004.php