feat: Adding BaseService::updateServicesCache. Adds ablity to update Services Cache at runtime.

phpstan.neon.dist

@@ -42,3 +42,6 @@ parameters:
 		booleansInConditions: true
 		disallowedConstructs: true
 		matchingInheritedMethodNames: true
+	codeigniter:
+		additionalServices:
+			- AfterAutoloadModule\Config\Services

system/Config/BaseService.php

@@ -413,4 +413,35 @@ protected static function buildServicesCache(): void
             static::$discovered = true;
         }
     }
+
+    /**
+     * Update the services cache.
+     */
+    public static function updateServicesCache(): void
+    {
+        if ((new Modules())->shouldDiscover('services')) {
+            $locator = static::locator();
+            $files   = $locator->search('Config/Services');
+
+            $systemPath = static::autoloader()->getNamespace('CodeIgniter')[0];
+
+            // Get instances of all service classes and cache them locally.
+            foreach ($files as $file) {
+                // Does not search `CodeIgniter` namespace to prevent from loading twice.
+                if (str_starts_with($file, $systemPath)) {
+                    continue;
+                }
+
+                $classname = $locator->findQualifiedNameFromPath($file);
+
+                if ($classname === false) {
+                    continue;
+                }
+
+                if ($classname !== Services::class && ! in_array($classname, self::$serviceNames, true)) {
+                    self::$serviceNames[] = $classname;
+                }
+            }
+        }
+    }
 }

tests/_support/Test/AfterAutoloadModule/Config/Services.php

@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * This file is part of CodeIgniter 4 framework.
+ *
+ * (c) CodeIgniter Foundation <admin@codeigniter.com>
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+namespace AfterAutoloadModule\Config;
+
+use AfterAutoloadModule\Test;
+use CodeIgniter\Config\BaseService;
+
+/**
+ * Services for testing BaseService::updateServicesCache()
+ *
+ * This class should not be discovered by the autoloader until the test adds this namespace to the autoloader.
+ */
+class Services extends BaseService
+{
+    /**
+     * Return a shared instance of the Test class for testing
+     */
+    public static function test(bool $getShared = true): Test
+    {
+        if ($getShared) {
+            return static::getSharedInstance('test');
+        }
+
+        return new Test();
+    }
+}

tests/_support/Test/AfterAutoloadModule/Test.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * This file is part of CodeIgniter 4 framework.
+ *
+ * (c) CodeIgniter Foundation <admin@codeigniter.com>
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+namespace AfterAutoloadModule;
+
+/**
+ * A simple class for testing BaseService::updateServicesCache()
+ *
+ * This class should not be discovered by the autoloader until the test adds this namespace to the autoloader.
+ */
+class Test
+{
+}

tests/system/CommonSingleServiceTest.php

@@ -111,6 +111,7 @@ public static function provideServiceNames(): iterable
             'reset',
             'resetSingle',
             'injectMock',
+            'updateServicesCache',
             'encrypter', // Encrypter needs a starter key
             'session', // Headers already sent
         ];

tests/system/Config/ServicesTest.php

@@ -13,6 +13,7 @@
 
 namespace CodeIgniter\Config;
 
+use AfterAutoloadModule\Test;
 use CodeIgniter\Autoloader\Autoloader;
 use CodeIgniter\Autoloader\FileLocator;
 use CodeIgniter\Database\MigrationRunner;
@@ -350,6 +351,26 @@ public function testResetSingleCaseInsensitive(): void
         $this->assertNotInstanceOf(MockResponse::class, $someService);
     }
 
+    #[PreserveGlobalState(false)]
+    #[RunInSeparateProcess]
+    public function testUpdateServiceCache(): void
+    {
+        Services::injectMock('response', new MockResponse(new App()));
+        $someService = service('response');
+        $this->assertInstanceOf(MockResponse::class, $someService);
+        service('response')->setStatusCode(200);
+
+        Services::autoloader()->addNamespace('AfterAutoloadModule', TESTPATH . '_support/Test/AfterAutoloadModule/');
+        Services::updateServicesCache();
+
+        $someService = service('response');
+        $this->assertInstanceOf(MockResponse::class, $someService);
+        $this->assertSame(200, $someService->getStatusCode());
+
+        $someService = service('test');
+        $this->assertInstanceOf(Test::class, $someService);
+    }
+
     public function testFilters(): void
     {
         $result = Services::filters();

user_guide_src/source/changelogs/v4.6.0.rst

@@ -75,6 +75,9 @@ Helpers and Functions
 
 Others
 ======
+- **Services:** Added ``BaseService::updateServicesCache`` method to allow
+  updating the services cache file post autoloading. This will only look for
+  new services and add them to the class name cache.
 
 ***************
 Message Changes

user_guide_src/source/concepts/services.rst

@@ -171,3 +171,6 @@ would simply use the framework's ``Config\Services`` class to grab your service:
 .. literalinclude:: services/012.php
 
 .. note:: If multiple Services files have the same method name, the first one found will be the instance returned.
+
+There may be times when you need to have Service Discovery refresh it's cache after the inital autoload proccess. This can be done by running :php:meth:`Config\\Services::updateServicesCache()`.
+This will force the service discovery to re-scan the directories for any new services files.