Merge pull request #7611 from kenjis/refactor-config-classname

refactor: use ::class to config() param
codeigniter4 · Jun 26, 2023 · 3bb0831 · 3bb0831
2 parents c9b6f3d + 3bdb53f
commit 3bb0831
Show file tree

Hide file tree

Showing 52 changed files with 136 additions and 108 deletions.
diff --git a/system/CLI/BaseCommand.php b/system/CLI/BaseCommand.php
@@ -11,6 +11,7 @@
 
 namespace CodeIgniter\CLI;
 
+use Config\Exceptions;
 use Psr\Log\LoggerInterface;
 use ReflectionException;
 use Throwable;
@@ -121,7 +122,7 @@ protected function showError(Throwable $e)
     {
         $exception = $e;
         $message   = $e->getMessage();
-        $config    = config('Exceptions');
+        $config    = config(Exceptions::class);
 
         require $config->errorViewPath . '/cli/error_exception.php';
     }

diff --git a/system/CLI/GeneratorTrait.php b/system/CLI/GeneratorTrait.php
@@ -11,6 +11,7 @@
 
 namespace CodeIgniter\CLI;
 
+use Config\Generators;
 use Config\Services;
 use Throwable;
 
@@ -267,7 +268,7 @@ protected function qualifyClassName(): string
     protected function renderTemplate(array $data = []): string
     {
         try {
-            return view(config('Generators')->views[$this->name], $data, ['debug' => false]);
+            return view(config(Generators::class)->views[$this->name], $data, ['debug' => false]);
         } catch (Throwable $e) {
             log_message('error', (string) $e);
 

diff --git a/system/Cache/Handlers/BaseHandler.php b/system/Cache/Handlers/BaseHandler.php
@@ -13,6 +13,7 @@
 
 use Closure;
 use CodeIgniter\Cache\CacheInterface;
+use Config\Cache;
 use Exception;
 use InvalidArgumentException;
 
@@ -61,7 +62,7 @@ public static function validateKey($key, $prefix = ''): string
             throw new InvalidArgumentException('Cache key cannot be empty.');
         }
 
-        $reserved = config('Cache')->reservedCharacters ?? self::RESERVED_CHARACTERS;
+        $reserved = config(Cache::class)->reservedCharacters ?? self::RESERVED_CHARACTERS;
         if ($reserved && strpbrk($key, $reserved) !== false) {
             throw new InvalidArgumentException('Cache key contains reserved characters ' . $reserved);
         }

diff --git a/system/CodeIgniter.php b/system/CodeIgniter.php
@@ -28,6 +28,7 @@
 use CodeIgniter\Router\Router;
 use Config\App;
 use Config\Cache;
+use Config\Feature;
 use Config\Kint as KintConfig;
 use Config\Services;
 use Exception;
@@ -268,7 +269,6 @@ private function autoloadKint(): void
 
     private function configureKint(): void
     {
-        /** @var \Config\Kint $config */
         $config = config(KintConfig::class);
 
         Kint::$depth_limit         = $config->maxDepth;
@@ -455,7 +455,7 @@ protected function handleRequest(?RouteCollectionInterface $routes, Cache $cache
             // If any filters were specified within the routes file,
             // we need to ensure it's active for the current request
             if ($routeFilter !== null) {
-                $multipleFiltersEnabled = config('Feature')->multipleFilters ?? false;
+                $multipleFiltersEnabled = config(Feature::class)->multipleFilters ?? false;
                 if ($multipleFiltersEnabled) {
                     $filters->enableFilters($routeFilter, 'before');
                     $filters->enableFilters($routeFilter, 'after');
@@ -822,7 +822,7 @@ protected function tryToRouteIt(?RouteCollectionInterface $routes = null)
         $this->benchmark->stop('routing');
 
         // for backward compatibility
-        $multipleFiltersEnabled = config('Feature')->multipleFilters ?? false;
+        $multipleFiltersEnabled = config(Feature::class)->multipleFilters ?? false;
         if (! $multipleFiltersEnabled) {
             return $this->router->getFilter();
         }

diff --git a/system/Commands/Cache/ClearCache.php b/system/Commands/Cache/ClearCache.php
@@ -14,6 +14,7 @@
 use CodeIgniter\Cache\CacheFactory;
 use CodeIgniter\CLI\BaseCommand;
 use CodeIgniter\CLI\CLI;
+use Config\Cache;
 
 /**
  * Clears current cache.
@@ -62,7 +63,7 @@ class ClearCache extends BaseCommand
      */
     public function run(array $params)
     {
-        $config  = config('Cache');
+        $config  = config(Cache::class);
         $handler = $params[0] ?? $config->handler;
 
         if (! array_key_exists($handler, $config->validHandlers)) {

diff --git a/system/Commands/Cache/InfoCache.php b/system/Commands/Cache/InfoCache.php
@@ -15,6 +15,7 @@
 use CodeIgniter\CLI\BaseCommand;
 use CodeIgniter\CLI\CLI;
 use CodeIgniter\I18n\Time;
+use Config\Cache;
 
 /**
  * Shows information on the cache.
@@ -54,7 +55,7 @@ class InfoCache extends BaseCommand
      */
     public function run(array $params)
     {
-        $config = config('Cache');
+        $config = config(Cache::class);
         helper('number');
 
         if ($config->handler !== 'file') {

diff --git a/system/Commands/Database/CreateDatabase.php b/system/Commands/Database/CreateDatabase.php
@@ -82,10 +82,7 @@ public function run(array $params)
         }
 
         try {
-            /**
-             * @var Database $config
-             */
-            $config = config('Database');
+            $config = config(Database::class);
 
             // Set to an empty database to prevent connection errors.
             $group = ENVIRONMENT === 'testing' ? 'tests' : $config->defaultGroup;

diff --git a/system/Commands/Generators/MigrationGenerator.php b/system/Commands/Generators/MigrationGenerator.php
@@ -15,6 +15,8 @@
 use CodeIgniter\CLI\CLI;
 use CodeIgniter\CLI\GeneratorTrait;
 use Config\App as AppConfig;
+use Config\Database;
+use Config\Migrations;
 use Config\Session as SessionConfig;
 
 /**
@@ -107,12 +109,11 @@ protected function prepare(string $class): string
             $data['session']  = true;
             $data['table']    = is_string($table) ? $table : 'ci_sessions';
             $data['DBGroup']  = is_string($DBGroup) ? $DBGroup : 'default';
-            $data['DBDriver'] = config('Database')->{$data['DBGroup']}['DBDriver'];
+            $data['DBDriver'] = config(Database::class)->{$data['DBGroup']}['DBDriver'];
 
-            /** @var AppConfig $config */
-            $config = config('App');
+            $config = config(AppConfig::class);
             /** @var SessionConfig|null $session */
-            $session = config('Session');
+            $session = config(SessionConfig::class);
 
             $data['matchIP'] = ($session instanceof SessionConfig)
                 ? $session->matchIP : $config->sessionMatchIP;
@@ -126,6 +127,6 @@ protected function prepare(string $class): string
      */
     protected function basename(string $filename): string
     {
-        return gmdate(config('Migrations')->timestampFormat) . basename($filename);
+        return gmdate(config(Migrations::class)->timestampFormat) . basename($filename);
     }
 }
diff --git a/system/Commands/Generators/SessionMigrationGenerator.php b/system/Commands/Generators/SessionMigrationGenerator.php
@@ -14,6 +14,8 @@
 use CodeIgniter\CLI\BaseCommand;
 use CodeIgniter\CLI\CLI;
 use CodeIgniter\CLI\GeneratorTrait;
+use Config\App;
+use Config\Migrations;
 
 /**
  * Generates a migration file for database sessions.
@@ -93,7 +95,7 @@ protected function prepare(string $class): string
         $data['session'] = true;
         $data['table']   = $this->getOption('t');
         $data['DBGroup'] = $this->getOption('g');
-        $data['matchIP'] = config('App')->sessionMatchIP ?? false;
+        $data['matchIP'] = config(App::class)->sessionMatchIP ?? false;
 
         $data['table']   = is_string($data['table']) ? $data['table'] : 'ci_sessions';
         $data['DBGroup'] = is_string($data['DBGroup']) ? $data['DBGroup'] : 'default';
@@ -106,6 +108,6 @@ protected function prepare(string $class): string
      */
     protected function basename(string $filename): string
     {
-        return gmdate(config('Migrations')->timestampFormat) . basename($filename);
+        return gmdate(config(Migrations::class)->timestampFormat) . basename($filename);
     }
 }
diff --git a/system/Commands/Utilities/Routes.php b/system/Commands/Utilities/Routes.php
@@ -18,6 +18,7 @@
 use CodeIgniter\Commands\Utilities\Routes\AutoRouterImproved\AutoRouteCollector as AutoRouteCollectorImproved;
 use CodeIgniter\Commands\Utilities\Routes\FilterCollector;
 use CodeIgniter\Commands\Utilities\Routes\SampleURIGenerator;
+use Config\Feature;
 use Config\Services;
 
 /**
@@ -124,7 +125,7 @@ public function run(array $params)
         }
 
         if ($collection->shouldAutoRoute()) {
-            $autoRoutesImproved = config('Feature')->autoRoutesImproved ?? false;
+            $autoRoutesImproved = config(Feature::class)->autoRoutesImproved ?? false;
 
             if ($autoRoutesImproved) {
                 $autoRouteCollector = new AutoRouteCollectorImproved(

diff --git a/system/Commands/Utilities/Routes/FilterCollector.php b/system/Commands/Utilities/Routes/FilterCollector.php
@@ -15,6 +15,7 @@
 use CodeIgniter\Filters\Filters;
 use CodeIgniter\HTTP\Request;
 use CodeIgniter\Router\Router;
+use Config\Filters as FiltersConfig;
 
 /**
  * Collects filters for a route.
@@ -72,7 +73,7 @@ private function createRouter(Request $request): Router
 
     private function createFilters(Request $request): Filters
     {
-        $config = config('Filters');
+        $config = config(FiltersConfig::class);
 
         return new Filters($config, $request, Services::response());
     }

diff --git a/system/Commands/Utilities/Routes/FilterFinder.php b/system/Commands/Utilities/Routes/FilterFinder.php
@@ -15,6 +15,7 @@
 use CodeIgniter\Filters\Filters;
 use CodeIgniter\Router\Exceptions\RedirectException;
 use CodeIgniter\Router\Router;
+use Config\Feature;
 use Config\Services;
 
 /**
@@ -35,7 +36,7 @@ private function getRouteFilters(string $uri): array
     {
         $this->router->handle($uri);
 
-        $multipleFiltersEnabled = config('Feature')->multipleFilters ?? false;
+        $multipleFiltersEnabled = config(Feature::class)->multipleFilters ?? false;
         if (! $multipleFiltersEnabled) {
             $filter = $this->router->getFilter();
 

diff --git a/system/Config/BaseConfig.php b/system/Config/BaseConfig.php
@@ -59,7 +59,7 @@ class BaseConfig
      */
     public function __construct()
     {
-        static::$moduleConfig = config('Modules');
+        static::$moduleConfig = config(Modules::class);
 
         $this->registerProperties();
 

diff --git a/system/Config/BaseService.php b/system/Config/BaseService.php
@@ -318,7 +318,7 @@ public static function injectMock(string $name, $mock)
     protected static function discoverServices(string $name, array $arguments)
     {
         if (! static::$discovered) {
-            $config = config('Modules');
+            $config = config(Modules::class);
 
             if ($config->shouldDiscover('services')) {
                 $locator = static::locator();
@@ -360,7 +360,7 @@ protected static function discoverServices(string $name, array $arguments)
     protected static function buildServicesCache(): void
     {
         if (! static::$discovered) {
-            $config = config('Modules');
+            $config = config(Modules::class);
 
             if ($config->shouldDiscover('services')) {
                 $locator = static::locator();

diff --git a/system/Config/Factories.php b/system/Config/Factories.php
@@ -230,7 +230,7 @@ public static function getOptions(string $component): array
             // Handle Config as a special case to prevent logic loops
             ? self::$configOptions
             // Load values from the best Factory configuration (will include Registrars)
-            : config('Factory')->{$component} ?? [];
+            : config(Factory::class)->{$component} ?? [];
 
         return self::setOptions($component, $values);
     }