fix: add types to View $filters and $plugins

codeigniter4 · Aug 31, 2023 · 5174ed7 · 5174ed7
1 parent f7e6cff
commit 5174ed7
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 45 deletions.
diff --git a/app/Config/View.php b/app/Config/View.php
@@ -5,6 +5,12 @@
 use CodeIgniter\Config\View as BaseView;
 use CodeIgniter\View\ViewDecoratorInterface;
 
+/**
+ * @phpstan-type ParserCallable (callable(mixed): mixed)
+ * @psalm-type ParserCallable = (callable(mixed): mixed)
+ * @phpstan-type ParserCallableString (callable(mixed): mixed)&string
+ * @psalm-type ParserCallableString = (callable(mixed): mixed)&string
+ */
 class View extends BaseView
 {
     /**
@@ -30,7 +36,8 @@ class View extends BaseView
      *  { title|esc(js) }
      *  { created_on|date(Y-m-d)|esc(attr) }
      *
-     * @var array
+     * @var array<string, string>
+     * @phpstan-var array<string, ParserCallableString>
      */
     public $filters = [];
 
@@ -39,7 +46,8 @@ class View extends BaseView
      * by the core Parser by creating aliases that will be replaced with
      * any callable. Can be single or tag pair.
      *
-     * @var array
+     * @var array<string, array<string>|callable|string>
+     * @phpstan-var array<string, array<ParserCallableString>|ParserCallableString|ParserCallable>
      */
     public $plugins = [];
 

diff --git a/phpstan-baseline.php b/phpstan-baseline.php
@@ -1,16 +1,6 @@
 <?php declare(strict_types = 1);
 
 $ignoreErrors = [];
-$ignoreErrors[] = [
-	'message' => '#^PHPDoc type array of property Config\\\\View\\:\\:\\$filters is not covariant with PHPDoc type array\\<string, callable\\-string\\> of overridden property CodeIgniter\\\\Config\\\\View\\:\\:\\$filters\\.$#',
-	'count' => 1,
-	'path' => __DIR__ . '/app/Config/View.php',
-];
-$ignoreErrors[] = [
-	'message' => '#^PHPDoc type array of property Config\\\\View\\:\\:\\$plugins is not covariant with PHPDoc type array\\<string, callable\\-string\\> of overridden property CodeIgniter\\\\Config\\\\View\\:\\:\\$plugins\\.$#',
-	'count' => 1,
-	'path' => __DIR__ . '/app/Config/View.php',
-];
 $ignoreErrors[] = [
 	'message' => '#^Method CodeIgniter\\\\BaseModel\\:\\:chunk\\(\\) has parameter \\$userFunc with no signature specified for Closure\\.$#',
 	'count' => 1,
@@ -256,26 +246,6 @@
 	'count' => 1,
 	'path' => __DIR__ . '/system/ComposerScripts.php',
 ];
-$ignoreErrors[] = [
-	'message' => '#^Property CodeIgniter\\\\Config\\\\View\\:\\:\\$coreFilters type has no signature specified for callable\\.$#',
-	'count' => 1,
-	'path' => __DIR__ . '/system/Config/View.php',
-];
-$ignoreErrors[] = [
-	'message' => '#^Property CodeIgniter\\\\Config\\\\View\\:\\:\\$corePlugins type has no signature specified for callable\\.$#',
-	'count' => 1,
-	'path' => __DIR__ . '/system/Config/View.php',
-];
-$ignoreErrors[] = [
-	'message' => '#^Property CodeIgniter\\\\Config\\\\View\\:\\:\\$filters type has no signature specified for callable\\.$#',
-	'count' => 1,
-	'path' => __DIR__ . '/system/Config/View.php',
-];
-$ignoreErrors[] = [
-	'message' => '#^Property CodeIgniter\\\\Config\\\\View\\:\\:\\$plugins type has no signature specified for callable\\.$#',
-	'count' => 1,
-	'path' => __DIR__ . '/system/Config/View.php',
-];
 $ignoreErrors[] = [
 	'message' => '#^Method CodeIgniter\\\\Database\\\\BaseBuilder\\:\\:_whereIn\\(\\) has parameter \\$values with no signature specified for Closure\\.$#',
 	'count' => 1,
@@ -1706,11 +1676,6 @@
 	'count' => 1,
 	'path' => __DIR__ . '/system/View/Parser.php',
 ];
-$ignoreErrors[] = [
-	'message' => '#^Property Config\\\\View\\:\\:\\$plugins \\(array\\) on left side of \\?\\? is not nullable\\.$#',
-	'count' => 1,
-	'path' => __DIR__ . '/system/View/Parser.php',
-];
 $ignoreErrors[] = [
 	'message' => '#^Property CodeIgniter\\\\View\\\\Table\\:\\:\\$function type has no signature specified for callable\\.$#',
 	'count' => 1,

diff --git a/system/Config/View.php b/system/Config/View.php
@@ -15,6 +15,11 @@
 
 /**
  * View configuration
+ *
+ * @phpstan-type ParserCallable (callable(mixed): mixed)
+ * @psalm-type ParserCallable = (callable(mixed): mixed)
+ * @phpstan-type ParserCallableString (callable(mixed): mixed)&string
+ * @psalm-type ParserCallableString = (callable(mixed): mixed)&string
  */
 class View extends BaseConfig
 {
@@ -35,7 +40,7 @@ class View extends BaseConfig
      * in order for them to be available for use within the Parser.
      *
      * @var array<string, string>
-     * @phpstan-var array<string, callable-string>
+     * @phpstan-var array<string, ParserCallableString>
      */
     public $filters = [];
 
@@ -44,16 +49,16 @@ class View extends BaseConfig
      * by the core Parser by creating aliases that will be replaced with
      * any callable. Can be single or tag pair.
      *
-     * @var array<string, string>
-     * @phpstan-var array<string, callable-string>
+     * @var array<string, array<string>|callable|string>
+     * @phpstan-var array<string, array<ParserCallableString>|ParserCallableString|ParserCallable>
      */
     public $plugins = [];
 
     /**
      * Built-in View filters.
      *
      * @var array<string, string>
-     * @phpstan-var array<string, callable-string>
+     * @phpstan-var array<string, ParserCallableString>
      */
     protected $coreFilters = [
         'abs'            => '\abs',
@@ -82,8 +87,8 @@ class View extends BaseConfig
     /**
      * Built-in View plugins.
      *
-     * @var array<string, string>
-     * @phpstan-var array<string, callable-string>
+     * @var array<string, array<string>|callable|string>
+     * @phpstan-var array<string, array<ParserCallableString>|ParserCallableString|ParserCallable>
      */
     protected $corePlugins = [
         'csp_script_nonce'  => '\CodeIgniter\View\Plugins::cspScriptNonce',

diff --git a/system/View/Parser.php b/system/View/Parser.php
@@ -19,6 +19,11 @@
 
 /**
  * Class for parsing pseudo-vars
+ *
+ * @phpstan-type ParserCallable (callable(mixed): mixed)
+ * @psalm-type ParserCallable = (callable(mixed): mixed)
+ * @phpstan-type ParserCallableString (callable(mixed): mixed)&string
+ * @psalm-type ParserCallableString = (callable(mixed): mixed)&string
  */
 class Parser extends View
 {
@@ -58,7 +63,8 @@ class Parser extends View
     /**
      * Stores any plugins registered at run-time.
      *
-     * @var array
+     * @var array<string, array<string>|callable|string>
+     * @phpstan-var array<string, array<ParserCallableString>|ParserCallableString|ParserCallable>
      */
     protected $plugins = [];
 
@@ -78,7 +84,7 @@ class Parser extends View
     public function __construct(ViewConfig $config, ?string $viewPath = null, $loader = null, ?bool $debug = null, ?LoggerInterface $logger = null)
     {
         // Ensure user plugins override core plugins.
-        $this->plugins = $config->plugins ?? [];
+        $this->plugins = $config->plugins;
 
         parent::__construct($config, $viewPath, $loader, $debug, $logger);
     }