PHPDoc types (#5960)

redaxo · Feb 28, 2024 · c677470 · c677470
1 parent db77f21
commit c677470
Show file tree

Hide file tree

Showing 20 changed files with 39 additions and 353 deletions.
diff --git a/.github/tests-visual/cronjob_cronjobs_add--dark.png b/.github/tests-visual/cronjob_cronjobs_add--dark.png
diff --git a/.github/tests-visual/cronjob_cronjobs_add.png b/.github/tests-visual/cronjob_cronjobs_add.png
diff --git a/.tools/phpstan/baseline.neon b/.tools/phpstan/baseline.neon
diff --git a/.tools/psalm/baseline.xml b/.tools/psalm/baseline.xml
@@ -1299,6 +1299,9 @@
       <code><![CDATA[$params['id']]]></code>
       <code><![CDATA[$params['id']]]></code>
     </MixedArgument>
+    <MixedArgumentTypeCoercion>
+      <code><![CDATA[$params]]></code>
+    </MixedArgumentTypeCoercion>
     <MixedAssignment>
       <code><![CDATA[$params['activeItem']]]></code>
     </MixedAssignment>
@@ -3451,7 +3454,6 @@
   </file>
   <file src="redaxo/src/core/lib/autoload.php">
     <MixedArgument>
-      <code><![CDATA[$class]]></code>
       <code><![CDATA[$path]]></code>
       <code><![CDATA[$path]]></code>
       <code><![CDATA[$path]]></code>
@@ -3462,7 +3464,6 @@
       <code><![CDATA[self::$dirs]]></code>
     </MixedArrayAccess>
     <MixedAssignment>
-      <code><![CDATA[$class]]></code>
       <code><![CDATA[$file]]></code>
       <code><![CDATA[$path]]></code>
       <code><![CDATA[[self::$classes, self::$dirs]]]></code>
@@ -4079,8 +4080,6 @@
       <code><![CDATA[$column['span'] ?? null]]></code>
       <code><![CDATA[$column['width'] ?? null]]></code>
       <code><![CDATA[$format[0]]]></code>
-      <code><![CDATA[$layout[0]]]></code>
-      <code><![CDATA[$layout[1]]]></code>
       <code><![CDATA[$params]]></code>
       <code><![CDATA[$string]]></code>
       <code><![CDATA[$v]]></code>
@@ -4094,8 +4093,6 @@
     </MixedArrayAssignment>
     <MixedArrayOffset>
       <code><![CDATA[$this->customColumns[$column]]]></code>
-      <code><![CDATA[$this->linkAttributes[$columnName]]]></code>
-      <code><![CDATA[$this->linkAttributes[$columnName][$attrName]]]></code>
       <code><![CDATA[$this->linkAttributes[$column]]]></code>
     </MixedArrayOffset>
     <MixedAssignment>
@@ -4129,7 +4126,6 @@
     </MixedOperand>
     <MixedPropertyTypeCoercion>
       <code><![CDATA[$attr]]></code>
-      <code><![CDATA[$this->linkAttributes]]></code>
     </MixedPropertyTypeCoercion>
     <MixedReturnStatement>
       <code><![CDATA[$this->columnNames[$columnIndex] ?? $default]]></code>
@@ -4138,12 +4134,6 @@
       <code><![CDATA[$this->linkAttributes[$column] ?? $default]]></code>
       <code><![CDATA[json_decode($this->getValue($column), true)]]></code>
     </MixedReturnStatement>
-    <PossiblyInvalidArgument>
-      <code><![CDATA[$columnValue]]></code>
-    </PossiblyInvalidArgument>
-    <PossiblyInvalidOperand>
-      <code><![CDATA[str_replace('###VALUE###', $columnHead, $layout[0])]]></code>
-    </PossiblyInvalidOperand>
     <PossiblyNullArgument>
       <code><![CDATA[$columnLayout]]></code>
       <code><![CDATA[$column['width'] ?? null]]></code>
@@ -4263,24 +4253,6 @@
       <code><![CDATA[$this->getDescription()]]></code>
     </PossiblyNullArgument>
   </file>
-  <file src="redaxo/src/core/lib/login/perm.php">
-    <MixedArgument>
-      <code><![CDATA[$perms]]></code>
-    </MixedArgument>
-    <MixedArrayAssignment>
-      <code><![CDATA[self::$perms[$group][$perm]]]></code>
-    </MixedArrayAssignment>
-    <MixedAssignment>
-      <code><![CDATA[$perms]]></code>
-      <code><![CDATA[$perms]]></code>
-    </MixedAssignment>
-    <MixedInferredReturnType>
-      <code><![CDATA[array]]></code>
-    </MixedInferredReturnType>
-    <MixedReturnStatement>
-      <code><![CDATA[$perms]]></code>
-    </MixedReturnStatement>
-  </file>
   <file src="redaxo/src/core/lib/login/user.php">
     <ArgumentTypeCoercion>
       <code><![CDATA[$role]]></code>
@@ -4803,7 +4775,7 @@
   </file>
   <file src="redaxo/src/core/lib/util/file.php">
     <MixedInferredReturnType>
-      <code><![CDATA[array|T]]></code>
+      <code><![CDATA[array<mixed>|T]]></code>
     </MixedInferredReturnType>
     <MixedReturnStatement>
       <code><![CDATA[null === $content ? $default : json_decode($content, true)]]></code>
@@ -5180,7 +5152,6 @@
   <file src="redaxo/src/core/pages/setup.php">
     <MixedArgument>
       <code><![CDATA[$config['timezone']]]></code>
-      <code><![CDATA[$error]]></code>
       <code><![CDATA[$message]]></code>
       <code><![CDATA[$messages]]></code>
       <code><![CDATA[$value]]></code>
@@ -5200,7 +5171,6 @@
       <code><![CDATA[$config['db'][1]['password']]]></code>
     </MixedArrayAssignment>
     <MixedAssignment>
-      <code><![CDATA[$error]]></code>
       <code><![CDATA[$message]]></code>
       <code><![CDATA[$messages]]></code>
       <code><![CDATA[$value]]></code>

diff --git a/redaxo/src/addons/structure/plugins/content/lib/extension_point/art_content_updated.php b/redaxo/src/addons/structure/plugins/content/lib/extension_point/art_content_updated.php
@@ -15,6 +15,7 @@ class rex_extension_point_art_content_updated extends rex_extension_point
     /** @var string */
     private $action;
 
+    /** @param array<string, mixed> $params */
     public function __construct(rex_article $article, string $action, string $subject = '', array $params = [], bool $readonly = false)
     {
         // for BC 'simple' attach params

diff --git a/redaxo/src/core/lib/api_function.php b/redaxo/src/core/lib/api_function.php
@@ -103,7 +103,7 @@ public static function factory()
      *
      * The method must be called on sub classes.
      *
-     * @return array
+     * @return array<string, string>
      */
     public static function getUrlParams()
     {

diff --git a/redaxo/src/core/lib/autoload.php b/redaxo/src/core/lib/autoload.php
@@ -314,7 +314,7 @@ private static function _addDirectory($dir)
      *
      * @throws RuntimeException
      *
-     * @return array The found classes
+     * @return list<string> The found classes
      */
     private static function findClasses($path)
     {

diff --git a/redaxo/src/core/lib/base/factory_trait.php b/redaxo/src/core/lib/base/factory_trait.php
@@ -90,7 +90,7 @@ public static function hasFactoryClass()
      * Calls the factory class with the given method and arguments.
      *
      * @param string $method Method name
-     * @param array $arguments Array of arguments
+     * @param array<mixed> $arguments Array of arguments
      *
      * @return mixed Result of the callback
      *

diff --git a/redaxo/src/core/lib/base/instance_list_pool_trait.php b/redaxo/src/core/lib/base/instance_list_pool_trait.php
@@ -9,14 +9,14 @@
  */
 trait rex_instance_list_pool_trait
 {
-    /** @var array<string, array> */
+    /** @var array<string, array<mixed>> */
     private static $instanceLists = [];
 
     /**
      * Adds an instance list.
      *
      * @param mixed $key Key
-     * @param array $instanceKeyList Array of instance keys
+     * @param array<mixed> $instanceKeyList Array of instance keys
      * @return void
      */
     protected static function addInstanceList($key, array $instanceKeyList)

diff --git a/redaxo/src/core/lib/base/singleton_trait.php b/redaxo/src/core/lib/base/singleton_trait.php
@@ -12,7 +12,7 @@ trait rex_singleton_trait
     /**
      * Singleton instances.
      *
-     * @var static[]
+     * @var array<class-string<static>, static>
      */
     private static $instances = [];
 

diff --git a/redaxo/src/core/lib/csrf_token.php b/redaxo/src/core/lib/csrf_token.php
@@ -70,7 +70,7 @@ public function getHiddenField()
     /**
      * Returns an array containing the `_csrf_token` param.
      *
-     * @return array
+     * @return array<self::PARAM, string>
      */
     public function getUrlParams()
     {

diff --git a/redaxo/src/core/lib/extension.php b/redaxo/src/core/lib/extension.php
@@ -18,7 +18,7 @@ abstract class rex_extension
     /**
      * Array of registered extensions.
      *
-     * @var array<string, array<self::*, list<array{callable, array}>>>
+     * @var array<string, array<self::*, list<array{callable, array<string, mixed>}>>>
      */
     private static $extensions = [];
 
@@ -72,7 +72,7 @@ public static function registerPoint(rex_extension_point $extensionPoint)
      * @param string|string[] $extensionPoint Name(s) of extension point(s)
      * @param callable(T):mixed $extension Callback extension
      * @param self::* $level Runlevel (`rex_extension::EARLY`, `rex_extension::NORMAL` or `rex_extension::LATE`)
-     * @param array $params Additional params
+     * @param array<string, mixed> $params Additional params
      * @return void
      */
     public static function register($extensionPoint, callable $extension, $level = self::NORMAL, array $params = [])

diff --git a/redaxo/src/core/lib/extension_point.php b/redaxo/src/core/lib/extension_point.php
@@ -17,16 +17,17 @@ class rex_extension_point
     private $name;
     /** @var T */
     private $subject;
-    /** @var array */
+    /** @var array<string, mixed> */
     private $params = [];
-    /** @var array */
+    /** @var array<string, mixed> */
     private $extensionParams = [];
     /** @var bool */
     private $readonly = false;
 
     /**
      * @param string $name
      * @param T $subject
+     * @param array<string, mixed> $params
      * @param bool $readonly
      */
     public function __construct($name, $subject = null, array $params = [], $readonly = false)
@@ -91,6 +92,7 @@ public function setParam($key, $value)
 
     /**
      * Sets the specific params for the next extension.
+     * @param array<string, mixed> $params
      * @return void
      */
     public function setExtensionParams(array $params)
@@ -126,7 +128,7 @@ public function getParam($key, $default = null)
     /**
      * Returns all params.
      *
-     * @return array
+     * @return array<string, mixed>
      */
     public function getParams()
     {

diff --git a/redaxo/src/core/lib/list.php b/redaxo/src/core/lib/list.php
@@ -363,6 +363,9 @@ public function getFormAttributes()
     }
 
     /**
+     * @param string $columnName
+     * @param string $attrName
+     * @param string|int $attrValue
      * @return void
      */
     public function addLinkAttribute($columnName, $attrName, $attrValue)
@@ -457,7 +460,7 @@ public function setColumnLayout($columnHead, $columnLayout)
      *
      * @param string $columnName Name der Spalte
      *
-     * @return array
+     * @return array{string, string}
      */
     public function getColumnLayout($columnName)
     {

diff --git a/redaxo/src/core/lib/login/perm.php b/redaxo/src/core/lib/login/perm.php
@@ -16,16 +16,16 @@ abstract class rex_perm
     /**
      * Array of permissions.
      *
-     * @var array
+     * @var array<self::*, array<string, string>>
      */
     private static $perms = [];
 
     /**
      * Registers a new permission.
      *
      * @param string $perm Perm key
-     * @param string $name Perm name
-     * @param string $group Perm group, possible values are rex_perm::GENERAL, rex_perm::OPTIONS and rex_perm::EXTRAS
+     * @param string|null $name Perm name
+     * @param self::* $group Perm group, possible values are rex_perm::GENERAL, rex_perm::OPTIONS and rex_perm::EXTRAS
      * @return void
      */
     public static function register($perm, $name = null, $group = self::GENERAL)
@@ -59,9 +59,9 @@ public static function has($perm)
     /**
      * Returns all permissions for the given group.
      *
-     * @param string $group Perm group
+     * @param self::* $group Perm group
      *
-     * @return array Permissions
+     * @return array<string, string> Permissions
      */
     public static function getAll($group = self::GENERAL)
     {

diff --git a/redaxo/src/core/lib/setup/setup.php b/redaxo/src/core/lib/setup/setup.php
@@ -61,7 +61,7 @@ public static function init($skinAddon = 'be_style', $skinPlugin = 'redaxo')
     /**
      * checks environment related conditions.
      *
-     * @return array An array of error messages
+     * @return list<string> An array of error messages
      */
     public static function checkEnvironment()
     {

diff --git a/redaxo/src/core/lib/sql/sql.php b/redaxo/src/core/lib/sql/sql.php
@@ -301,7 +301,7 @@ public static function datetime($timestamp = null)
      *
      * @param string $query The sql-query
      * @param array $params An optional array of statement parameter
-     * @param array $options For possible option keys view `rex_sql::OPT_*` constants
+     * @param array<self::OPT_*, bool> $options For possible option keys view `rex_sql::OPT_*` constants
      *
      * @throws rex_sql_exception on errors
      *
@@ -371,7 +371,7 @@ public function prepareQuery($query)
      * Executes the prepared statement with the given input parameters.
      *
      * @param array $params Array of input parameters
-     * @param array $options For possible option keys view `rex_sql::OPT_*` constants
+     * @param array<self::OPT_*, bool> $options For possible option keys view `rex_sql::OPT_*` constants
      *
      * @throws rex_sql_exception
      *
@@ -436,7 +436,7 @@ public function execute(array $params = [], array $options = [])
      *
      * @param string $query The sql-query
      * @param array $params An optional array of statement parameter
-     * @param array $options For possible option keys view `rex_sql::OPT_*` constants
+     * @param array<self::OPT_*, bool> $options For possible option keys view `rex_sql::OPT_*` constants
      *
      * @throws rex_sql_exception on errors
      *
@@ -747,7 +747,7 @@ public function getValue($column)
      *
      * @throws rex_sql_exception
      *
-     * @return array
+     * @return array<mixed>
      */
     public function getArrayValue($column)
     {

diff --git a/redaxo/src/core/lib/util/file.php b/redaxo/src/core/lib/util/file.php
@@ -53,7 +53,7 @@ public static function get($file, $default = null)
      * @template T
      * @param string $file Path to the file
      * @param T $default Default value
-     * @return array|T Content of the file or default value if the file isn't readable
+     * @return array<mixed>|T Content of the file or default value if the file isn't readable
      */
     public static function getConfig($file, $default = [])
     {
@@ -67,7 +67,7 @@ public static function getConfig($file, $default = [])
      * @template T
      * @param string $file Path to the file
      * @param T $default Default value
-     * @return array|T Content of the file or default value if the file isn't readable
+     * @return array<mixed>|T Content of the file or default value if the file isn't readable
      */
     public static function getCache($file, $default = [])
     {
@@ -144,7 +144,7 @@ public static function append(string $file, string $content, string $delimiter =
      * Puts content in a config file.
      *
      * @param string $file Path to the file
-     * @param array $content Content for the file
+     * @param array<mixed> $content Content for the file
      * @param int $inline The level where you switch to inline YAML
      *
      * @return bool TRUE on success, FALSE on failure
@@ -160,7 +160,7 @@ public static function putConfig($file, $content, $inline = 3)
      * Puts content in a cache file.
      *
      * @param string $file Path to the file
-     * @param array $content Content for the file
+     * @param array<mixed> $content Content for the file
      *
      * @return bool TRUE on success, FALSE on failure
      *

diff --git a/redaxo/src/core/lib/util/markdown.php b/redaxo/src/core/lib/util/markdown.php
@@ -53,7 +53,7 @@ public function parse($code, $options = [])
      * @param int $bottomLevel Bottom included headline level for TOC, e.g. `6` for `<h6>`
      * @param array<self::*, bool>|bool $options
      *
-     * @return array tupel of table-of-content and content
+     * @return list{string, string} tupel of table-of-content and content
      */
     public function parseWithToc($code, $topLevel = 2, $bottomLevel = 3, $options = [])
     {

diff --git a/redaxo/src/core/lib/util/string.php b/redaxo/src/core/lib/util/string.php
@@ -149,7 +149,7 @@ public static function yamlEncode(array $value, $inline = 3)
      *
      * @throws rex_yaml_parse_exception
      *
-     * @return array
+     * @return array<mixed>
      */
     public static function yamlDecode($value)
     {