Update phpstan-codeigniter and fix new errors

codeigniter4 · Oct 12, 2023 · 01ac45a · 01ac45a
2 parents 815b802 + dc84d18
commit 01ac45a
Show file tree

Hide file tree

Showing 58 changed files with 125 additions and 176 deletions.
diff --git a/composer.json b/composer.json
@@ -19,7 +19,7 @@
     },
     "require-dev": {
         "codeigniter/coding-standard": "^1.5",
-        "codeigniter/phpstan-codeigniter": "^v1.1",
+        "codeigniter/phpstan-codeigniter": "^1.1",
         "ergebnis/composer-normalize": "^2.28",
         "fakerphp/faker": "^1.9",
         "kint-php/kint": "^5.0.4",

diff --git a/phpstan-baseline.php b/phpstan-baseline.php
@@ -221,6 +221,11 @@
 	'count' => 1,
 	'path' => __DIR__ . '/system/Cache/Handlers/RedisHandler.php',
 ];
+$ignoreErrors[] = [
+	'message' => '#^Call to function config with Config\\\\Kint\\:\\:class is discouraged\\.$#',
+	'count' => 1,
+	'path' => __DIR__ . '/system/CodeIgniter.php',
+];
 $ignoreErrors[] = [
 	'message' => '#^Construct empty\\(\\) is not allowed\\. Use more strict comparison\\.$#',
 	'count' => 6,
@@ -916,16 +921,6 @@
 	'count' => 4,
 	'path' => __DIR__ . '/system/Config/BaseConfig.php',
 ];
-$ignoreErrors[] = [
-	'message' => '#^Argument \\#1 \\$name \\(\'Config\\\\\\\\Modules\'\\) passed to function config does not extend CodeIgniter\\\\\\\\Config\\\\\\\\BaseConfig\\.$#',
-	'count' => 1,
-	'path' => __DIR__ . '/system/Config/BaseConfig.php',
-];
-$ignoreErrors[] = [
-	'message' => '#^Argument \\#1 \\$name \\(\'Config\\\\\\\\Modules\'\\) passed to function config does not extend CodeIgniter\\\\\\\\Config\\\\\\\\BaseConfig\\.$#',
-	'count' => 2,
-	'path' => __DIR__ . '/system/Config/BaseService.php',
-];
 $ignoreErrors[] = [
 	'message' => '#^Construct empty\\(\\) is not allowed\\. Use more strict comparison\\.$#',
 	'count' => 3,
@@ -981,11 +976,6 @@
 	'count' => 1,
 	'path' => __DIR__ . '/system/Config/Services.php',
 ];
-$ignoreErrors[] = [
-	'message' => '#^Argument \\#1 \\$name \\(\'Config\\\\\\\\Modules\'\\) passed to function config does not extend CodeIgniter\\\\\\\\Config\\\\\\\\BaseConfig\\.$#',
-	'count' => 1,
-	'path' => __DIR__ . '/system/Config/Services.php',
-];
 $ignoreErrors[] = [
 	'message' => '#^Construct empty\\(\\) is not allowed\\. Use more strict comparison\\.$#',
 	'count' => 1,
@@ -2086,11 +2076,6 @@
 	'count' => 4,
 	'path' => __DIR__ . '/system/Entity/Entity.php',
 ];
-$ignoreErrors[] = [
-	'message' => '#^Argument \\#1 \\$name \\(\'Config\\\\\\\\Modules\'\\) passed to function config does not extend CodeIgniter\\\\\\\\Config\\\\\\\\BaseConfig\\.$#',
-	'count' => 1,
-	'path' => __DIR__ . '/system/Events/Events.php',
-];
 $ignoreErrors[] = [
 	'message' => '#^Method CodeIgniter\\\\Events\\\\Events\\:\\:on\\(\\) has parameter \\$callback with no signature specified for callable\\.$#',
 	'count' => 1,
@@ -2131,11 +2116,6 @@
 	'count' => 3,
 	'path' => __DIR__ . '/system/Files/File.php',
 ];
-$ignoreErrors[] = [
-	'message' => '#^Argument \\#1 \\$name \\(\'Config\\\\\\\\Modules\'\\) passed to function config does not extend CodeIgniter\\\\\\\\Config\\\\\\\\BaseConfig\\.$#',
-	'count' => 1,
-	'path' => __DIR__ . '/system/Filters/Filters.php',
-];
 $ignoreErrors[] = [
 	'message' => '#^Construct empty\\(\\) is not allowed\\. Use more strict comparison\\.$#',
 	'count' => 2,

diff --git a/phpstan.neon.dist b/phpstan.neon.dist
@@ -32,6 +32,9 @@ parameters:
 	checkGenericClassInNonGenericObjectType: false
 	checkMissingCallableSignature: true
 	treatPhpDocTypesAsCertain: false
+	codeigniter:
+		additionalConfigNamespaces:
+			- CodeIgniter\Config
 	strictRules:
 		allRules: false
 		disallowedLooseComparison: true

diff --git a/system/CLI/BaseCommand.php b/system/CLI/BaseCommand.php
@@ -11,7 +11,6 @@
 
 namespace CodeIgniter\CLI;
 
-use Config\Exceptions;
 use Psr\Log\LoggerInterface;
 use ReflectionException;
 use Throwable;
@@ -124,7 +123,7 @@ protected function showError(Throwable $e)
     {
         $exception = $e;
         $message   = $e->getMessage();
-        $config    = config(Exceptions::class);
+        $config    = config('Exceptions');
 
         require $config->errorViewPath . '/cli/error_exception.php';
     }

diff --git a/system/CLI/CLI.php b/system/CLI/CLI.php
@@ -42,13 +42,19 @@ class CLI
      * Is the readline library on the system?
      *
      * @var bool
+     *
+     * @deprecated 4.4.2 Should be protected.
+     * @TODO Fix to camelCase in the next major version.
      */
     public static $readline_support = false;
 
     /**
      * The message displayed at prompts.
      *
      * @var string
+     *
+     * @deprecated 4.4.2 Should be protected.
+     * @TODO Fix to camelCase in the next major version.
      */
     public static $wait_msg = 'Press any key to continue...';
 
@@ -63,6 +69,8 @@ class CLI
      * Foreground color list
      *
      * @var array<string, string>
+     *
+     * @TODO Fix to camelCase in the next major version.
      */
     protected static $foreground_colors = [
         'black'        => '0;30',
@@ -88,6 +96,8 @@ class CLI
      * Background color list
      *
      * @var array<string, string>
+     *
+     * @TODO Fix to camelCase in the next major version.
      */
     protected static $background_colors = [
         'black'      => '40',

diff --git a/system/CLI/Console.php b/system/CLI/Console.php
@@ -12,7 +12,6 @@
 namespace CodeIgniter\CLI;
 
 use CodeIgniter\CodeIgniter;
-use Config\App;
 use Config\Services;
 use Exception;
 
@@ -33,7 +32,7 @@ class Console
     public function run()
     {
         // Create CLIRequest
-        $appConfig = config(App::class);
+        $appConfig = config('App');
         Services::createRequest($appConfig, true);
 
         $runner  = Services::commands();

diff --git a/system/CLI/GeneratorTrait.php b/system/CLI/GeneratorTrait.php
@@ -11,7 +11,6 @@
 
 namespace CodeIgniter\CLI;
 
-use Config\Generators;
 use Config\Services;
 use Throwable;
 
@@ -268,7 +267,7 @@ protected function qualifyClassName(): string
     protected function renderTemplate(array $data = []): string
     {
         try {
-            return view(config(Generators::class)->views[$this->name], $data, ['debug' => false]);
+            return view(config('Generators')->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,7 +13,6 @@
 
 use Closure;
 use CodeIgniter\Cache\CacheInterface;
-use Config\Cache;
 use Exception;
 use InvalidArgumentException;
 
@@ -64,7 +63,7 @@ public static function validateKey($key, $prefix = ''): string
             throw new InvalidArgumentException('Cache key cannot be empty.');
         }
 
-        $reserved = config(Cache::class)->reservedCharacters ?? self::RESERVED_CHARACTERS;
+        $reserved = config('Cache')->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
@@ -31,11 +31,10 @@
 use CodeIgniter\Router\Router;
 use Config\App;
 use Config\Cache;
-use Config\Feature;
 use Config\Kint as KintConfig;
 use Config\Services;
 use Exception;
-use Kint;
+use Kint\Kint;
 use Kint\Renderer\CliRenderer;
 use Kint\Renderer\RichRenderer;
 use Locale;
@@ -358,7 +357,7 @@ public function run(?RouteCollectionInterface $routes = null, bool $returnRespon
         $this->spoofRequestMethod();
 
         try {
-            $this->response = $this->handleRequest($routes, config(Cache::class), $returnResponse);
+            $this->response = $this->handleRequest($routes, config('Cache'), $returnResponse);
         } catch (ResponsableInterface|DeprecatedRedirectException $e) {
             $this->outputBufferingEnd();
             if ($e instanceof DeprecatedRedirectException) {
@@ -458,7 +457,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::class)->multipleFilters ?? false;
+                $multipleFiltersEnabled = config('Feature')->multipleFilters ?? false;
                 if ($multipleFiltersEnabled) {
                     $filters->enableFilters($routeFilter, 'before');
                     $filters->enableFilters($routeFilter, 'after');
@@ -829,7 +828,7 @@ protected function tryToRouteIt(?RouteCollectionInterface $routes = null)
         $this->benchmark->stop('routing');
 
         // for backward compatibility
-        $multipleFiltersEnabled = config(Feature::class)->multipleFilters ?? false;
+        $multipleFiltersEnabled = config('Feature')->multipleFilters ?? false;
         if (! $multipleFiltersEnabled) {
             return $this->router->getFilter();
         }
@@ -970,7 +969,7 @@ protected function display404errors(PageNotFoundException $e)
 
             unset($override);
 
-            $cacheConfig = config(Cache::class);
+            $cacheConfig = config('Cache');
             $this->gatherOutput($cacheConfig, $returned);
 
             return $this->response;

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

diff --git a/system/Commands/Database/CreateDatabase.php b/system/Commands/Database/CreateDatabase.php
@@ -82,7 +82,7 @@ public function run(array $params)
         }
 
         try {
-            $config = config(Database::class);
+            $config = config('Database');
 
             // 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
@@ -14,9 +14,6 @@
 use CodeIgniter\CLI\BaseCommand;
 use CodeIgniter\CLI\CLI;
 use CodeIgniter\CLI\GeneratorTrait;
-use Config\Database;
-use Config\Migrations;
-use Config\Session as SessionConfig;
 
 /**
  * Generates a skeleton migration file.
@@ -108,10 +105,9 @@ 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::class)->{$data['DBGroup']}['DBDriver'];
+            $data['DBDriver'] = config('Database')->{$data['DBGroup']}['DBDriver'];
 
-            /** @var SessionConfig|null $session */
-            $session = config(SessionConfig::class);
+            $session = config('Session');
 
             $data['matchIP'] = $session->matchIP;
         }
@@ -124,6 +120,6 @@ protected function prepare(string $class): string
      */
     protected function basename(string $filename): string
     {
-        return gmdate(config(Migrations::class)->timestampFormat) . basename($filename);
+        return gmdate(config('Migrations')->timestampFormat) . basename($filename);
     }
 }
diff --git a/system/Commands/Generators/SessionMigrationGenerator.php b/system/Commands/Generators/SessionMigrationGenerator.php
@@ -14,8 +14,6 @@
 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.
@@ -95,7 +93,7 @@ protected function prepare(string $class): string
         $data['session'] = true;
         $data['table']   = $this->getOption('t');
         $data['DBGroup'] = $this->getOption('g');
-        $data['matchIP'] = config(App::class)->sessionMatchIP ?? false;
+        $data['matchIP'] = config('App')->sessionMatchIP ?? false;
 
         $data['table']   = is_string($data['table']) ? $data['table'] : 'ci_sessions';
         $data['DBGroup'] = is_string($data['DBGroup']) ? $data['DBGroup'] : 'default';
@@ -108,6 +106,6 @@ protected function prepare(string $class): string
      */
     protected function basename(string $filename): string
     {
-        return gmdate(config(Migrations::class)->timestampFormat) . basename($filename);
+        return gmdate(config('Migrations')->timestampFormat) . basename($filename);
     }
 }
diff --git a/system/Commands/Utilities/Routes.php b/system/Commands/Utilities/Routes.php
@@ -18,8 +18,6 @@
 use CodeIgniter\Commands\Utilities\Routes\FilterCollector;
 use CodeIgniter\Commands\Utilities\Routes\SampleURIGenerator;
 use CodeIgniter\Router\DefinedRouteCollector;
-use Config\Feature;
-use Config\Routing;
 use Config\Services;
 
 /**
@@ -134,7 +132,7 @@ public function run(array $params)
         }
 
         if ($collection->shouldAutoRoute()) {
-            $autoRoutesImproved = config(Feature::class)->autoRoutesImproved ?? false;
+            $autoRoutesImproved = config('Feature')->autoRoutesImproved ?? false;
 
             if ($autoRoutesImproved) {
                 $autoRouteCollector = new AutoRouteCollectorImproved(
@@ -148,7 +146,7 @@ public function run(array $params)
                 $autoRoutes = $autoRouteCollector->get();
 
                 // Check for Module Routes.
-                if ($routingConfig = config(Routing::class)) {
+                if ($routingConfig = config('Routing')) {
                     foreach ($routingConfig->moduleRoutes as $uri => $namespace) {
                         $autoRouteCollector = new AutoRouteCollectorImproved(
                             $namespace,

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

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