Merge remote-tracking branch 'upstream/develop' into 4.5

Conflicts: system/Router/AutoRouterImproved.php system/Router/Router.php
codeigniter4 · Feb 25, 2024 · e1df9f5 · e1df9f5
2 parents f40b371 + ad11363
commit e1df9f5
Show file tree

Hide file tree

Showing 61 changed files with 213 additions and 161 deletions.
diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php
@@ -44,6 +44,7 @@
     ]);
 
 $overrides = [
+    'phpdoc_array_type'   => true,
     'phpdoc_no_alias_tag' => [
         'replacements' => [
             'type' => 'var',
@@ -62,6 +63,8 @@
             'phpstan-param',
             'phpstan-property',
             'phpstan-return',
+            'phpstan-type',
+            'phpstan-var',
             'property',
             'property-read',
             'property-write',

diff --git a/.php-cs-fixer.no-header.php b/.php-cs-fixer.no-header.php
@@ -29,7 +29,32 @@
         __DIR__ . '/admin/starter/builds',
     ]);
 
-$overrides = [];
+$overrides = [
+    'phpdoc_array_type' => true,
+    'phpdoc_align'      => [
+        'align'   => 'vertical',
+        'spacing' => 1,
+        'tags'    => [
+            'method',
+            'param',
+            'phpstan-assert',
+            'phpstan-assert-if-true',
+            'phpstan-assert-if-false',
+            'phpstan-param',
+            'phpstan-property',
+            'phpstan-return',
+            'phpstan-type',
+            'phpstan-var',
+            'property',
+            'property-read',
+            'property-write',
+            'return',
+            'throws',
+            'type',
+            'var',
+        ],
+    ],
+];
 
 $options = [
     'cacheFile' => 'build/.php-cs-fixer.no-header.cache',

diff --git a/.php-cs-fixer.user-guide.php b/.php-cs-fixer.user-guide.php
@@ -39,6 +39,30 @@
         'import_symbols'                        => false,
         'leading_backslash_in_global_namespace' => true,
     ],
+    'phpdoc_array_type' => true,
+    'phpdoc_align'      => [
+        'align'   => 'vertical',
+        'spacing' => 1,
+        'tags'    => [
+            'method',
+            'param',
+            'phpstan-assert',
+            'phpstan-assert-if-true',
+            'phpstan-assert-if-false',
+            'phpstan-param',
+            'phpstan-property',
+            'phpstan-return',
+            'phpstan-type',
+            'phpstan-var',
+            'property',
+            'property-read',
+            'property-write',
+            'return',
+            'throws',
+            'type',
+            'var',
+        ],
+    ],
 ];
 
 $options = [

diff --git a/app/Config/Cache.php b/app/Config/Cache.php
@@ -61,7 +61,7 @@ class Cache extends BaseConfig
      *    ['q'] = Enabled, but only take into account the specified list
      *            of query parameters.
      *
-     * @var bool|string[]
+     * @var array<string>|bool
      */
     public $cacheQueryString = false;
 

diff --git a/app/Config/ContentSecurityPolicy.php b/app/Config/ContentSecurityPolicy.php
@@ -45,28 +45,28 @@ class ContentSecurityPolicy extends BaseConfig
     /**
      * Will default to self if not overridden
      *
-     * @var string|string[]|null
+     * @var array<string>|string|null
      */
     public $defaultSrc;
 
     /**
      * Lists allowed scripts' URLs.
      *
-     * @var string|string[]
+     * @var array<string>|string
      */
     public $scriptSrc = 'self';
 
     /**
      * Lists allowed stylesheets' URLs.
      *
-     * @var string|string[]
+     * @var array<string>|string
      */
     public $styleSrc = 'self';
 
     /**
      * Defines the origins from which images can be loaded.
      *
-     * @var string|string[]
+     * @var array<string>|string
      */
     public $imageSrc = 'self';
 
@@ -75,36 +75,36 @@ class ContentSecurityPolicy extends BaseConfig
      *
      * Will default to self if not overridden
      *
-     * @var string|string[]|null
+     * @var array<string>|string|null
      */
     public $baseURI;
 
     /**
      * Lists the URLs for workers and embedded frame contents
      *
-     * @var string|string[]
+     * @var array<string>|string
      */
     public $childSrc = 'self';
 
     /**
      * Limits the origins that you can connect to (via XHR,
      * WebSockets, and EventSource).
      *
-     * @var string|string[]
+     * @var array<string>|string
      */
     public $connectSrc = 'self';
 
     /**
      * Specifies the origins that can serve web fonts.
      *
-     * @var string|string[]
+     * @var array<string>|string
      */
     public $fontSrc;
 
     /**
      * Lists valid endpoints for submission from `<form>` tags.
      *
-     * @var string|string[]
+     * @var array<string>|string
      */
     public $formAction = 'self';
 
@@ -114,7 +114,7 @@ class ContentSecurityPolicy extends BaseConfig
      * and `<applet>` tags. This directive can't be used in
      * `<meta>` tags and applies only to non-HTML resources.
      *
-     * @var string|string[]|null
+     * @var array<string>|string|null
      */
     public $frameAncestors;
 
@@ -129,33 +129,33 @@ class ContentSecurityPolicy extends BaseConfig
     /**
      * Restricts the origins allowed to deliver video and audio.
      *
-     * @var string|string[]|null
+     * @var array<string>|string|null
      */
     public $mediaSrc;
 
     /**
      * Allows control over Flash and other plugins.
      *
-     * @var string|string[]
+     * @var array<string>|string
      */
     public $objectSrc = 'self';
 
     /**
-     * @var string|string[]|null
+     * @var array<string>|string|null
      */
     public $manifestSrc;
 
     /**
      * Limits the kinds of plugins a page may invoke.
      *
-     * @var string|string[]|null
+     * @var array<string>|string|null
      */
     public $pluginTypes;
 
     /**
      * List of actions allowed.
      *
-     * @var string|string[]|null
+     * @var array<string>|string|null
      */
     public $sandbox;
 

diff --git a/app/Config/Format.php b/app/Config/Format.php
@@ -22,7 +22,7 @@ class Format extends BaseConfig
      * These formats are only checked when the data passed to the respond()
      * method is an array.
      *
-     * @var string[]
+     * @var array<string>
      */
     public array $supportedResponseFormats = [
         'application/json',

diff --git a/app/Config/Toolbar.php b/app/Config/Toolbar.php
@@ -31,7 +31,7 @@ class Toolbar extends BaseConfig
      * List of toolbar collectors that will be called when Debug Toolbar
      * fires up and collects data from.
      *
-     * @var string[]
+     * @var array<string>
      */
     public array $collectors = [
         Timers::class,

diff --git a/app/Config/Validation.php b/app/Config/Validation.php
@@ -18,7 +18,7 @@ class Validation extends BaseConfig
      * Stores the classes that contain the
      * rules that are available.
      *
-     * @var string[]
+     * @var array<string>
      */
     public array $ruleSets = [
         Rules::class,

diff --git a/app/Config/View.php b/app/Config/View.php
@@ -34,7 +34,7 @@ class View extends BaseView
      *  { title|esc(js) }
      *  { created_on|date(Y-m-d)|esc(attr) }
      *
-     * @var array<string, string>
+     * @var         array<string, string>
      * @phpstan-var array<string, ParserCallableString>
      */
     public $filters = [];
@@ -44,7 +44,7 @@ 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<string, array<string>|callable|string>
+     * @var         array<string, array<string>|callable|string>
      * @phpstan-var array<string, array<ParserCallableString>|ParserCallableString|ParserCallable>
      */
     public $plugins = [];
@@ -56,7 +56,7 @@ class View extends BaseView
      *
      * All classes must implement CodeIgniter\View\ViewDecoratorInterface
      *
-     * @var class-string<ViewDecoratorInterface>[]
+     * @var array<class-string<ViewDecoratorInterface>>
      */
     public array $decorators = [];
 }
diff --git a/system/API/ResponseTrait.php b/system/API/ResponseTrait.php
@@ -70,7 +70,7 @@ trait ResponseTrait
      * Either 'json' or 'xml'. If null is set, it will be determined through
      * content negotiation.
      *
-     * @var string|null
+     * @var         string|null
      * @phpstan-var 'html'|'json'|'xml'|null
      */
     protected $format = 'json';
@@ -240,7 +240,7 @@ protected function failValidationError(string $description = 'Bad Request', ?str
     /**
      * Used when the data provided by the client cannot be validated on one or more fields.
      *
-     * @param string|string[] $errors
+     * @param array<string>|string $errors
      *
      * @return ResponseInterface
      */

diff --git a/system/Autoloader/FileLocator.php b/system/Autoloader/FileLocator.php
@@ -306,7 +306,7 @@ public function findQualifiedNameFromPath(string $path)
      * Scans the defined namespaces, returning a list of all files
      * that are contained within the subpath specified by $path.
      *
-     * @return string[] List of file paths
+     * @return array<string> List of file paths
      */
     public function listFiles(string $path): array
     {
@@ -339,7 +339,7 @@ public function listFiles(string $path): array
      * Scans the provided namespace, returning a list of all files
      * that are contained within the sub path specified by $path.
      *
-     * @return string[] List of file paths
+     * @return array<string> List of file paths
      */
     public function listNamespaceFiles(string $prefix, string $path): array
     {

diff --git a/system/Autoloader/FileLocatorInterface.php b/system/Autoloader/FileLocatorInterface.php
@@ -68,15 +68,15 @@ public function findQualifiedNameFromPath(string $path);
      * Scans the defined namespaces, returning a list of all files
      * that are contained within the subpath specified by $path.
      *
-     * @return string[] List of file paths
+     * @return array<string> List of file paths
      */
     public function listFiles(string $path): array;
 
     /**
      * Scans the provided namespace, returning a list of all files
      * that are contained within the sub path specified by $path.
      *
-     * @return string[] List of file paths
+     * @return array<string> List of file paths
      */
     public function listNamespaceFiles(string $prefix, string $path): array;
 }
diff --git a/system/BaseModel.php b/system/BaseModel.php
@@ -47,15 +47,15 @@
  *      - process various callbacks
  *      - allow intermingling calls to the db connection
  *
- * @phpstan-type row_array array<int|string, float|int|null|object|string>
+ * @phpstan-type row_array               array<int|string, float|int|null|object|string>
  * @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}
- * @phpstan-type event_data_afterfind array{id: int|string|null|list<int|string>, data: row_array|list<row_array>|object|null, method: string, singleton: bool}
+ * @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}
+ * @phpstan-type event_data_afterfind    array{id: int|string|null|list<int|string>, data: row_array|list<row_array>|object|null, method: string, singleton: bool}
  * @phpstan-type event_data_beforeupdate array{id: null|list<int|string>, data: row_array}
- * @phpstan-type event_data_afterupdate array{id: null|list<int|string>, data: row_array|object, result: bool}
+ * @phpstan-type event_data_afterupdate  array{id: null|list<int|string>, data: row_array|object, result: bool}
  * @phpstan-type event_data_beforedelete array{id: null|list<int|string>, purge: bool}
- * @phpstan-type event_data_afterdelete array{id: null|list<int|string>, data: null, purge: bool, result: bool}
+ * @phpstan-type event_data_afterdelete  array{id: null|list<int|string>, data: null, purge: bool, result: bool}
  */
 abstract class BaseModel
 {
@@ -485,7 +485,7 @@ abstract protected function doUpdate($id = null, $row = null): bool;
      * @param int         $batchSize The size of the batch to run
      * @param bool        $returnSQL True means SQL is returned, false will execute the query
      *
-     * @return false|int|string[] Number of rows affected or FALSE on failure, SQL array when testMode
+     * @return array<string>|false|int Number of rows affected or FALSE on failure, SQL array when testMode
      *
      * @throws DatabaseException
      */
@@ -1039,7 +1039,7 @@ public function update($id = null, $row = null): bool
      * @param         int                         $batchSize The size of the batch to run
      * @param         bool                        $returnSQL True means SQL is returned, false will execute the query
      *
-     * @return false|int|string[] Number of rows affected or FALSE on failure, SQL array when testMode
+     * @return array<string>|false|int Number of rows affected or FALSE on failure, SQL array when testMode
      *
      * @throws DatabaseException
      * @throws ReflectionException

diff --git a/system/Cache/ResponseCache.php b/system/Cache/ResponseCache.php
@@ -38,7 +38,7 @@ final class ResponseCache
      *    array('q') = Enabled, but only take into account the specified list
      *                 of query parameters.
      *
-     * @var bool|string[]
+     * @var array<string>|bool
      */
     private $cacheQueryString = false;
 

diff --git a/system/CodeIgniter.php b/system/CodeIgniter.php
@@ -808,7 +808,7 @@ public function displayPerformanceMetrics(string $output): string
      * @param RouteCollectionInterface|null $routes A collection interface to use in place
      *                                              of the config file.
      *
-     * @return string|string[]|null Route filters, that is, the filters specified in the routes file
+     * @return array<string>|string|null Route filters, that is, the filters specified in the routes file
      *
      * @throws RedirectException
      */

diff --git a/system/Commands/Database/MigrateStatus.php b/system/Commands/Database/MigrateStatus.php
@@ -65,7 +65,7 @@ class MigrateStatus extends BaseCommand
     /**
      * Namespaces to ignore when looking for migrations.
      *
-     * @var string[]
+     * @var array<string>
      */
     protected $ignoredNamespaces = [
         'CodeIgniter',

diff --git a/system/Commands/Translation/LocalizationFinder.php b/system/Commands/Translation/LocalizationFinder.php
@@ -359,7 +359,7 @@ private function isSubDirectory(string $directory, string $rootDirectory): bool
     }
 
     /**
-     * @param SplFileInfo[] $files
+     * @param array<SplFileInfo> $files
      *
      * @return         array<string, array|int>
      * @phpstan-return array{'foundLanguageKeys': array<string, array<string, string>>, 'badLanguageKeys': array<int, array<int, string>>, 'countFiles': int}