Merge pull request #8114 from paulbalandan/phpstan-phpdocs

docs: Use native PHPDocs instead of `@phpstan-`

app/Config/App.php

@@ -27,8 +27,7 @@ class App extends BaseConfig
      *      'http://accounts.example.com/':
      *          ['media.example.com', 'accounts.example.com']
      *
-     * @var string[]
-     * @phpstan-var list<string>
+     * @var list<string>
      */
     public array $allowedHostnames = [];
 

app/Config/Autoload.php

@@ -41,8 +41,7 @@ class Autoload extends AutoloadConfig
      *       'App'         => APPPATH
      *   ];
      *
-     * @var array<string, array<int, string>|string>
-     * @phpstan-var array<string, string|list<string>>
+     * @var array<string, list<string>|string>
      */
     public $psr4 = [
         APP_NAMESPACE => APPPATH, // For custom app namespace
@@ -81,8 +80,7 @@ class Autoload extends AutoloadConfig
      *       '/path/to/my/file.php',
      *   ];
      *
-     * @var string[]
-     * @phpstan-var list<string>
+     * @var list<string>
      */
     public $files = [];
 
@@ -95,8 +93,7 @@ class Autoload extends AutoloadConfig
      *       'form',
      *   ];
      *
-     * @var string[]
-     * @phpstan-var list<string>
+     * @var list<string>
      */
     public $helpers = [];
 }

app/Config/Cache.php

@@ -158,8 +158,7 @@ class Cache extends BaseConfig
      * This is an array of cache engine alias' and class names. Only engines
      * that are listed here are allowed to be used.
      *
-     * @var array<string, string>
-     * @phpstan-var array<string, class-string<CacheInterface>>
+     * @var array<string, class-string<CacheInterface>>
      */
     public array $validHandlers = [
         'dummy'     => DummyHandler::class,

app/Config/Filters.php

@@ -15,9 +15,8 @@ class Filters extends BaseConfig
      * Configures aliases for Filter classes to
      * make reading things nicer and simpler.
      *
-     * @var array<string, array<int, string>|string> [filter_name => classname]
-     *                                               or [filter_name => [classname1, classname2, ...]]
-     * @phpstan-var array<string, class-string|list<class-string>>
+     * @var array<string, class-string|list<class-string>> [filter_name => classname]
+     *                                                     or [filter_name => [classname1, classname2, ...]]
      */
     public array $aliases = [
         'csrf'          => CSRF::class,
@@ -31,8 +30,7 @@ class Filters extends BaseConfig
      * List of filter aliases that are always
      * applied before and after every request.
      *
-     * @var array<string, array<string, array<string, string>>>|array<string, array<string>>
-     * @phpstan-var array<string, list<string>>|array<string, array<string, array<string, string>>>
+     * @var array<string, array<string, array<string, string>>>|array<string, list<string>>
      */
     public array $globals = [
         'before' => [

app/Config/Kint.php

@@ -27,8 +27,7 @@ class Kint extends BaseConfig
     */
 
     /**
-     * @var array<int, ConstructablePluginInterface|string>
-     * @phpstan-var list<class-string<ConstructablePluginInterface>|ConstructablePluginInterface>
+     * @var list<class-string<ConstructablePluginInterface>|ConstructablePluginInterface>
      */
     public $plugins;
 
@@ -46,14 +45,12 @@ class Kint extends BaseConfig
     public int $richSort     = AbstractRenderer::SORT_FULL;
 
     /**
-     * @var array<string, string>
-     * @phpstan-var array<string, class-string<ValuePluginInterface>>
+     * @var array<string, class-string<ValuePluginInterface>>
      */
     public $richObjectPlugins;
 
     /**
-     * @var array<string, string>
-     * @phpstan-var array<string, class-string<TabPluginInterface>>
+     * @var array<string, class-string<TabPluginInterface>>
      */
     public $richTabPlugins;
 

app/Config/Session.php

@@ -19,7 +19,7 @@ class Session extends BaseConfig
      * - `CodeIgniter\Session\Handlers\MemcachedHandler`
      * - `CodeIgniter\Session\Handlers\RedisHandler`
      *
-     * @phpstan-var class-string<BaseHandler>
+     * @var class-string<BaseHandler>
      */
     public string $driver = FileHandler::class;
 

phpstan-baseline.php

@@ -11,6 +11,11 @@
 	'count' => 1,
 	'path' => __DIR__ . '/system/Autoloader/Autoloader.php',
 ];
+$ignoreErrors[] = [
+	'message' => '#^Property Config\\\\Autoload\\:\\:\\$helpers \\(array\\<int, string\\>\\) in isset\\(\\) is not nullable\\.$#',
+	'count' => 1,
+	'path' => __DIR__ . '/system/Autoloader/Autoloader.php',
+];
 $ignoreErrors[] = [
 	'message' => '#^Construct empty\\(\\) is not allowed\\. Use more strict comparison\\.$#',
 	'count' => 13,

system/Autoloader/Autoloader.php

@@ -75,17 +75,15 @@ class Autoloader
     /**
      * Stores files as a list.
      *
-     * @var string[]
-     * @phpstan-var list<string>
+     * @var list<string>
      */
     protected $files = [];
 
     /**
      * Stores helper list.
      * Always load the URL helper, it should be used in most apps.
      *
-     * @var string[]
-     * @phpstan-var list<string>
+     * @var list<string>
      */
     protected $helpers = ['url'];
 
@@ -119,7 +117,7 @@ public function initialize(Autoload $config, Modules $modules)
             $this->files = $config->files;
         }
 
-        if (isset($config->helpers)) { // @phpstan-ignore-line
+        if (isset($config->helpers)) {
             $this->helpers = [...$this->helpers, ...$config->helpers];
         }
 
@@ -185,8 +183,7 @@ public function unregister(): void
     /**
      * Registers namespaces with the autoloader.
      *
-     * @param array<string, array<int, string>|string>|string $namespace
-     * @phpstan-param array<string, list<string>|string>|string $namespace
+     * @param array<string, list<string>|string>|string $namespace
      *
      * @return $this
      */

system/BaseModel.php

@@ -63,8 +63,7 @@ abstract class BaseModel
      * The Database connection group that
      * should be instantiated.
      *
-     * @var string|null
-     * @phpstan-var non-empty-string|null
+     * @var non-empty-string|null
      */
     protected $DBGroup;
 

system/Cache/Handlers/BaseHandler.php

@@ -76,10 +76,9 @@ public static function validateKey($key, $prefix = ''): string
     /**
      * Get an item from the cache, or execute the given Closure and store the result.
      *
-     * @param string  $key      Cache item name
-     * @param int     $ttl      Time to live
-     * @param Closure $callback Callback return value
-     * @phpstan-param Closure(): mixed $callback
+     * @param string           $key      Cache item name
+     * @param int              $ttl      Time to live
+     * @param Closure(): mixed $callback Callback return value
      *
      * @return array|bool|float|int|object|string|null
      */

system/Cache/Handlers/FileHandler.php

@@ -222,8 +222,7 @@ public function isSupported(): bool
      * Does the heavy lifting of actually retrieving the file and
      * verifying it's age.
      *
-     * @return array<string, mixed>|false
-     * @phpstan-return array{data: mixed, ttl: int, time: int}|false
+     * @return array{data: mixed, ttl: int, time: int}|false
      */
     protected function getItem(string $filename)
     {

system/Commands/Database/ShowTableInfo.php

@@ -84,7 +84,7 @@ class ShowTableInfo extends BaseCommand
     ];
 
     /**
-     * @phpstan-var  list<list<string|int>> Table Data.
+     * @var list<list<int|string>> Table Data.
      */
     private array $tbody;
 

system/Commands/Utilities/Routes/AutoRouteCollector.php

@@ -37,8 +37,7 @@ public function __construct(string $namespace, string $defaultController, string
     }
 
     /**
-     * @return array<int, array<int, string>>
-     * @phpstan-return list<list<string>>
+     * @return list<list<string>>
      */
     public function get(): array
     {

system/Commands/Utilities/Routes/AutoRouterImproved/AutoRouteCollector.php

@@ -62,8 +62,7 @@ public function __construct(
     }
 
     /**
-     * @return array<int, array<int, string>>
-     * @phpstan-return list<list<string>>
+     * @return list<list<string>>
      */
     public function get(): array
     {

system/Commands/Utilities/Routes/AutoRouterImproved/ControllerMethodReader.php

@@ -27,8 +27,7 @@ final class ControllerMethodReader
     private string $namespace;
 
     /**
-     * @var array<int, string>
-     * @phpstan-var list<string>
+     * @var list<string>
      */
     private array $httpMethods;
 
@@ -44,10 +43,9 @@ public function __construct(string $namespace, array $httpMethods)
     /**
      * Returns found route info in the controller.
      *
-     * @phpstan-param class-string $class
+     * @param class-string $class
      *
-     * @return array<int, array<string, array|string>>
-     * @phpstan-return list<array<string, string|array>>
+     * @return list<array<string, array|string>>
      */
     public function read(string $class, string $defaultController = 'Home', string $defaultMethod = 'index'): array
     {
@@ -154,7 +152,7 @@ private function getParameters(ReflectionMethod $method): array
     }
 
     /**
-     * @phpstan-param class-string $classname
+     * @param class-string $classname
      *
      * @return string URI path part from the folder(s) and controller
      */
@@ -179,7 +177,7 @@ private function getUriByClass(string $classname): string
     /**
      * Gets a route for the default controller.
      *
-     * @phpstan-return list<array>
+     * @return list<array>
      */
     private function getRouteForDefaultController(
         string $classShortname,

system/Commands/Utilities/Routes/ControllerFinder.php

@@ -38,8 +38,7 @@ public function __construct(string $namespace)
     }
 
     /**
-     * @return string[]
-     * @phpstan-return class-string[]
+     * @return class-string[]
      */
     public function find(): array
     {
@@ -66,7 +65,7 @@ public function find(): array
                 $classnameOrEmpty = $this->locator->getClassname($file);
 
                 if ($classnameOrEmpty !== '') {
-                    /** @phpstan-var class-string $classname */
+                    /** @var class-string $classname */
                     $classname = $classnameOrEmpty;
 
                     $classes[] = $classname;

system/Commands/Utilities/Routes/ControllerMethodReader.php

@@ -35,10 +35,9 @@ public function __construct(string $namespace)
     }
 
     /**
-     * @phpstan-param class-string $class
+     * @param class-string $class
      *
-     * @return array<int, array{route: string, handler: string}>
-     * @phpstan-return list<array{route: string, handler: string}>
+     * @return list<array{route: string, handler: string}>
      */
     public function read(string $class, string $defaultController = 'Home', string $defaultMethod = 'index'): array
     {
@@ -128,7 +127,7 @@ private function hasRemap(ReflectionClass $class): bool
     }
 
     /**
-     * @phpstan-param class-string $classname
+     * @param class-string $classname
      *
      * @return string URI path part from the folder(s) and controller
      */

system/Common.php

@@ -1139,7 +1139,7 @@ function stringify_attributes($attributes, bool $js = false): string
      * returns its return value if any.
      * Otherwise will start or stop the timer intelligently.
      *
-     * @phpstan-param (callable(): mixed)|null $callable
+     * @param (callable(): mixed)|null $callable
      *
      * @return Timer
      */

system/Config/AutoloadConfig.php

@@ -45,8 +45,7 @@ class AutoloadConfig
      * but this should be done prior to creating any namespaced classes,
      * else you will need to modify all of those classes for this to work.
      *
-     * @var array<string, array<int, string>|string>
-     * @phpstan-var array<string, string|list<string>>
+     * @var array<string, list<string>|string>
      */
     public $psr4 = [];
 
@@ -72,8 +71,7 @@ class AutoloadConfig
      * that will be autoloaded. This can be useful for bootstrap operations
      * or for loading functions.
      *
-     * @var array<int, string>
-     * @phpstan-var list<string>
+     * @var list<string>
      */
     public $files = [];
 

system/Config/Factories.php

@@ -62,8 +62,7 @@ class Factories
      *
      * [component => [alias => FQCN]]
      *
-     * @var array<string, array<string, string>>
-     * @phpstan-var array<string, array<string, class-string>>
+     * @var array<string, array<string, class-string>>
      */
     protected static $aliases = [];
 
@@ -76,8 +75,7 @@ class Factories
      *
      * [component => [FQCN => instance]]
      *
-     * @var array<string, array<string, object>>
-     * @phpstan-var  array<string, array<class-string, object>>
+     * @var array<string, array<class-string, object>>
      */
     protected static $instances = [];
 
@@ -93,10 +91,9 @@ class Factories
     /**
      * Define the class to load. You can *override* the concrete class.
      *
-     * @param string $component Lowercase, plural component name
-     * @param string $alias     Class alias. See the $aliases property.
-     * @param string $classname FQCN to be loaded
-     * @phpstan-param class-string $classname FQCN to be loaded
+     * @param string       $component Lowercase, plural component name
+     * @param string       $alias     Class alias. See the $aliases property.
+     * @param class-string $classname FQCN to be loaded
      */
     public static function define(string $component, string $alias, string $classname): void
     {