refactor: bump to phpstan-codeigniter v2.1

Author: paulbalandan

.gitattributes

@@ -26,7 +26,7 @@ structarmed.php              export-ignore
 phpmetrics.json              export-ignore
 phpstan-baseline.php         export-ignore
 phpstan-bootstrap.php        export-ignore
-phpstan.neon.dist            export-ignore
+phpstan.dist.neon            export-ignore
 phpunit.dist.xml             export-ignore
 psalm-baseline.xml           export-ignore
 psalm.xml                    export-ignore

.github/workflows/test-phpstan.yml

@@ -13,7 +13,7 @@ on:
       - 'tests/**.php'
       - 'utils/**.php'
       - composer.json
-      - phpstan.neon.dist
+      - phpstan.dist.neon
       - phpstan-baseline.php
       - '.github/workflows/test-phpstan.yml'
 
@@ -27,7 +27,7 @@ on:
       - 'tests/**.php'
       - 'utils/**.php'
       - composer.json
-      - phpstan.neon.dist
+      - phpstan.dist.neon
       - phpstan-baseline.php
       - '.github/workflows/test-phpstan.yml'
 

phpstan-bootstrap.php

@@ -1,5 +1,9 @@
 <?php
 
+// Analyse under the testing environment so the Tests\Support namespace is
+// registered and its migrations are discovered for schema introspection.
+$_SERVER['CI_ENVIRONMENT'] = 'testing';
+
 require __DIR__ . '/system/util_bootstrap.php';
 
 defined('OCI_COMMIT_ON_SUCCESS') || define('OCI_COMMIT_ON_SUCCESS', 32);

phpstan.neon.dist phpstan.dist.neonphpstan.neon.dist renamed to phpstan.dist.neon

@@ -47,6 +47,6 @@ parameters:
         additionalModelNamespaces:
             - Tests\Support\Models
         checkArgumentTypeOfModel: false
-        schemaCacheDirectory: %currentWorkingDirectory%/build/phpstan
+        schemaCacheDirectory: build/schema-cache
     shipmonkBaselinePerIdentifier:
         directory: %currentWorkingDirectory%

rector.php

@@ -76,10 +76,10 @@
         __DIR__ . '/phpstan-bootstrap.php',
     ])
     ->withPHPStanConfigs([
+        __DIR__ . '/phpstan.dist.neon',
         __DIR__ . '/vendor/codeigniter/phpstan-codeigniter/extension.neon',
         __DIR__ . '/vendor/phpstan/phpstan-strict-rules/rules.neon',
         __DIR__ . '/vendor/shipmonk/phpstan-baseline-per-identifier/extension.neon',
-        __DIR__ . '/phpstan.neon.dist',
     ])
     // is there a file you need to skip?
     ->withSkip([

system/BaseModel.php

@@ -49,7 +49,7 @@
  *      - process various callbacks
  *      - allow intermingling calls to the db connection
  *
- * @phpstan-type row_array               array<int|string, float|int|null|object|string|bool>
+ * @phpstan-type row_array               array<array-key, mixed>
  * @phpstan-type event_data_beforeinsert array{data: row_array}
  * @phpstan-type event_data_afterinsert  array{id: int|string, data: row_array, result: bool}
  * @phpstan-type event_data_beforefind   array{id?: int|string, method: string, singleton: bool, limit?: int, offset?: int}

system/Boot.php

@@ -426,9 +426,11 @@ protected static function initializeConsole(): Console
     {
         $console = new Console();
 
+        $args = $_SERVER['argv'] ?? []; // @phpstan-ignore codeigniter.superglobalsOffsetAccess (reads live $_SERVER, not the snapshot service)
+
         // Show basic information before we do anything else.
-        if (is_int($suppress = array_search('--no-header', $_SERVER['argv'], true))) {
-            unset($_SERVER['argv'][$suppress]);
+        if (is_int($suppress = array_search('--no-header', $args, true))) {
+            unset($args[$suppress]);
             $suppress = true;
         }
 

system/CLI/CLI.php

@@ -707,7 +707,7 @@ public static function streamSupports(string $function, $resource): bool
     public static function hasColorSupport($resource): bool
     {
         // Follow https://no-color.org/
-        if (isset($_SERVER['NO_COLOR']) || getenv('NO_COLOR') !== false) {
+        if (isset($_SERVER['NO_COLOR']) || getenv('NO_COLOR') !== false) { // @phpstan-ignore codeigniter.superglobalsOffsetAccess (reads live $_SERVER, not the snapshot service)
             return false;
         }
 
@@ -718,7 +718,7 @@ public static function hasColorSupport($resource): bool
         if (is_windows()) {
             // @codeCoverageIgnoreStart
             return static::streamSupports('sapi_windows_vt100_support', $resource)
-                || isset($_SERVER['ANSICON'])
+                || isset($_SERVER['ANSICON']) // @phpstan-ignore codeigniter.superglobalsOffsetAccess (reads live $_SERVER, not the snapshot service)
                 || getenv('ANSICON') !== false
                 || getenv('ConEmuANSI') === 'ON'
                 || getenv('TERM') === 'xterm';
@@ -887,7 +887,7 @@ public static function wrap(?string $string = null, int $max = 0, int $padLeft =
      */
     protected static function parseCommandLine()
     {
-        $args = $_SERVER['argv'] ?? [];
+        $args = $_SERVER['argv'] ?? []; // @phpstan-ignore codeigniter.superglobalsOffsetAccess (reads live $_SERVER, not the snapshot service)
         array_shift($args); // scrap invoking program
         $optionValue = false;
 

system/Commands/Encryption/GenerateKey.php

@@ -101,7 +101,8 @@ public function run(array $params)
 
         // force DotEnv to reload the new env vars
         putenv('encryption.key');
-        unset($_ENV['encryption.key'], $_SERVER['encryption.key']);
+        unset($_ENV['encryption.key']);
+        service('superglobals')->unsetServer('encryption.key');
         $dotenv = new DotEnv((new Paths())->envDirectory ?? ROOTPATH); // @phpstan-ignore nullCoalesce.property
         $dotenv->load();
 

system/Common.php

@@ -409,7 +409,7 @@ function db_connect($db = null, bool $getShared = true)
      */
     function env(string $key, $default = null)
     {
-        $value = $_ENV[$key] ?? $_SERVER[$key] ?? getenv($key);
+        $value = $_ENV[$key] ?? $_SERVER[$key] ?? getenv($key); // @phpstan-ignore codeigniter.superglobalsOffsetAccess (reads live $_SERVER, not the snapshot service)
 
         // Not found? Return the default value
         if ($value === false) {
@@ -697,7 +697,7 @@ function is_cli(): bool
 
         // PHP_SAPI could be 'cgi-fcgi', 'fpm-fcgi'.
         // See https://github.com/codeigniter4/CodeIgniter4/pull/5393
-        return ! isset($_SERVER['REMOTE_ADDR']) && ! isset($_SERVER['REQUEST_METHOD']);
+        return ! isset($_SERVER['REMOTE_ADDR']) && ! isset($_SERVER['REQUEST_METHOD']); // @phpstan-ignore codeigniter.superglobalsOffsetAccess (reads live $_SERVER, not the snapshot service), codeigniter.superglobalsOffsetAccess (reads live $_SERVER, not the snapshot service)
     }
 }