Fix PHPStan iterable type errors in LocalizationFinder, AutoRouteCollector and Modules; clean baseline (#8732)

Author: chuchokun

system/Commands/Translation/LocalizationFinder.php

@@ -304,6 +304,11 @@ private function replaceArraySyntax(string $code): string
 
     /**
      * Create multidimensional array from another keys
+     * 
+     * @param array<int,string> $fromKeys List of keys to build nested array
+     * @param string            $lastArrayValue Value to assign at the deepest key
+     * 
+     * @return array<string,mixed>   Multidimensional associative array
      */
     private function buildMultiArray(array $fromKeys, string $lastArrayValue = ''): array
     {
@@ -323,6 +328,10 @@ private function buildMultiArray(array $fromKeys, string $lastArrayValue = ''):
 
     /**
      * Convert multi arrays to specific CLI table rows (flat array)
+     * 
+     * @param array<int,mixed> $array Input translations (nested array or strings)
+     * 
+     * @return array<int,array{0:string,1:string}> Flat list of table rows [langFileNames, value]
      */
     private function arrayToTableRows(string $langFileName, array $array): array
     {

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

@@ -95,9 +95,10 @@ public function get(): array
     /**
      * Adding Filters
      *
-     * @param list<array<string, array|string>> $routes
+     * @param array<int,array<string,string|array<string>>>     $routes List of route definitions
+     * 
+     * @return array<int,array<string,string|array<string>>>    $Updated route definitions with filters
      *
-     * @return list<array<string, array|string>>
      */
     private function addFilters(array $routes): array
     {

system/Modules/Modules.php

@@ -60,6 +60,13 @@ public function shouldDiscover(string $alias): bool
         return in_array(strtolower($alias), $this->aliases, true);
     }
 
+    /**
+     * Restores the state of the object when exported with var_export()
+     * 
+     * @param array<string,mixed>   $array Properties and their values
+     * 
+     * @return static
+     */
     public static function __set_state(array $array)
     {
         $obj = new static();

utils/phpstan-baseline/missingType.iterableValue.neon

@@ -1,4 +1,4 @@
-# total 1209 errors
+# total 1200 errors
 
 parameters:
     ignoreErrors:
@@ -207,26 +207,6 @@ parameters:
             count: 1
             path: ../../system/Commands/ListCommands.php
 
-        -
-            message: '#^Method CodeIgniter\\Commands\\Translation\\LocalizationFinder\:\:arrayToTableRows\(\) has parameter \$array with no value type specified in iterable type array\.$#'
-            count: 1
-            path: ../../system/Commands/Translation/LocalizationFinder.php
-
-        -
-            message: '#^Method CodeIgniter\\Commands\\Translation\\LocalizationFinder\:\:arrayToTableRows\(\) return type has no value type specified in iterable type array\.$#'
-            count: 1
-            path: ../../system/Commands/Translation/LocalizationFinder.php
-
-        -
-            message: '#^Method CodeIgniter\\Commands\\Translation\\LocalizationFinder\:\:buildMultiArray\(\) has parameter \$fromKeys with no value type specified in iterable type array\.$#'
-            count: 1
-            path: ../../system/Commands/Translation/LocalizationFinder.php
-
-        -
-            message: '#^Method CodeIgniter\\Commands\\Translation\\LocalizationFinder\:\:buildMultiArray\(\) return type has no value type specified in iterable type array\.$#'
-            count: 1
-            path: ../../system/Commands/Translation/LocalizationFinder.php
-
         -
             message: '#^Method CodeIgniter\\Commands\\Translation\\LocalizationFinder\:\:findTranslationsInFile\(\) return type has no value type specified in iterable type array\.$#'
             count: 1
@@ -257,16 +237,6 @@ parameters:
             count: 1
             path: ../../system/Commands/Utilities/Namespaces.php
 
-        -
-            message: '#^Method CodeIgniter\\Commands\\Utilities\\Routes\\AutoRouterImproved\\AutoRouteCollector\:\:addFilters\(\) has parameter \$routes with no value type specified in iterable type array\.$#'
-            count: 1
-            path: ../../system/Commands/Utilities/Routes/AutoRouterImproved/AutoRouteCollector.php
-
-        -
-            message: '#^Method CodeIgniter\\Commands\\Utilities\\Routes\\AutoRouterImproved\\AutoRouteCollector\:\:addFilters\(\) return type has no value type specified in iterable type array\.$#'
-            count: 1
-            path: ../../system/Commands/Utilities/Routes/AutoRouterImproved/AutoRouteCollector.php
-
         -
             message: '#^Method CodeIgniter\\Commands\\Utilities\\Routes\\AutoRouterImproved\\AutoRouteCollector\:\:generateSampleUri\(\) has parameter \$route with no value type specified in iterable type array\.$#'
             count: 1
@@ -4127,11 +4097,6 @@ parameters:
             count: 1
             path: ../../system/Model.php
 
-        -
-            message: '#^Method CodeIgniter\\Modules\\Modules\:\:__set_state\(\) has parameter \$array with no value type specified in iterable type array\.$#'
-            count: 1
-            path: ../../system/Modules/Modules.php
-
         -
             message: '#^Method CodeIgniter\\Pager\\Pager\:\:getDetails\(\) return type has no value type specified in iterable type array\.$#'
             count: 1