Merge branch '4.5' of https://github.com/codeigniter4/CodeIgniter4 into fix-command-routes-with-locale

Author: neznaika0

phpstan-baseline.php

@@ -96,11 +96,6 @@
 	'count' => 6,
 	'path' => __DIR__ . '/system/CLI/CLI.php',
 ];
-$ignoreErrors[] = [
-	'message' => '#^Only booleans are allowed in &&, array given on the right side\\.$#',
-	'count' => 1,
-	'path' => __DIR__ . '/system/CLI/CLI.php',
-];
 $ignoreErrors[] = [
 	'message' => '#^Only booleans are allowed in &&, array\\<int, string\\> given on the right side\\.$#',
 	'count' => 1,
@@ -1158,7 +1153,7 @@
 ];
 $ignoreErrors[] = [
 	'message' => '#^Only booleans are allowed in a ternary operator condition, int\\<0, max\\> given\\.$#',
-	'count' => 4,
+	'count' => 3,
 	'path' => __DIR__ . '/system/Database/MigrationRunner.php',
 ];
 $ignoreErrors[] = [
@@ -2098,7 +2093,7 @@
 ];
 $ignoreErrors[] = [
 	'message' => '#^Construct empty\\(\\) is not allowed\\. Use more strict comparison\\.$#',
-	'count' => 6,
+	'count' => 5,
 	'path' => __DIR__ . '/system/HTTP/IncomingRequest.php',
 ];
 $ignoreErrors[] = [

rector.php

@@ -94,6 +94,7 @@
             __DIR__ . '/system/Router/AutoRouterImproved.php',
             // @TODO remove if deprecated $config is removed
             __DIR__ . '/system/HTTP/Request.php',
+            __DIR__ . '/system/HTTP/Response.php',
         ],
 
         // check on constant compare

system/CLI/CLI.php

@@ -213,9 +213,9 @@ public static function input(?string $prefix = null): string
      * // Do not provide options but requires a valid email
      * $email = CLI::prompt('What is your email?', null, 'required|valid_email');
      *
-     * @param string            $field      Output "field" question
-     * @param array|string      $options    String to a default value, array to a list of options (the first option will be the default value)
-     * @param array|string|null $validation Validation rules
+     * @param string                  $field      Output "field" question
+     * @param list<int|string>|string $options    String to a default value, array to a list of options (the first option will be the default value)
+     * @param array|string|null       $validation Validation rules
      *
      * @return string The user input
      */
@@ -237,9 +237,9 @@ public static function prompt(string $field, $options = null, $validation = null
             $default     = $options;
         }
 
-        if (is_array($options) && $options) {
+        if (is_array($options) && $options !== []) {
             $opts               = $options;
-            $extraOutputDefault = static::color($opts[0], 'green');
+            $extraOutputDefault = static::color((string) $opts[0], 'green');
 
             unset($opts[0]);
 

system/Commands/Database/MigrateStatus.php

@@ -115,7 +115,7 @@ public function run(array $params)
             ksort($migrations);
 
             foreach ($migrations as $uid => $migration) {
-                $migrations[$uid]->name = mb_substr($migration->name, mb_strpos($migration->name, $uid . '_'));
+                $migrations[$uid]->name = mb_substr($migration->name, (int) mb_strpos($migration->name, $uid . '_'));
 
                 $date  = '---';
                 $group = '---';

system/Commands/Generators/Views/filter.tpl.php

@@ -21,7 +21,7 @@ class {class} implements FilterInterface
      * @param RequestInterface $request
      * @param array|null       $arguments
      *
-     * @return mixed
+     * @return RequestInterface|ResponseInterface|string|void
      */
     public function before(RequestInterface $request, $arguments = null)
     {
@@ -38,7 +38,7 @@ public function before(RequestInterface $request, $arguments = null)
      * @param ResponseInterface $response
      * @param array|null        $arguments
      *
-     * @return mixed
+     * @return ResponseInterface|void
      */
     public function after(RequestInterface $request, ResponseInterface $response, $arguments = null)
     {

system/Common.php

@@ -755,7 +755,7 @@ function is_windows(?bool $mock = null): bool
      * A convenience method to translate a string or array of them and format
      * the result with the intl extension's MessageFormatter.
      *
-     * @return string
+     * @return list<string>|string
      */
     function lang(string $line, array $args = [], ?string $locale = null)
     {

system/Database/MigrationRunner.php

@@ -752,7 +752,7 @@ public function getBatchEnd(int $batch): string
             ->get()
             ->getResultObject();
 
-        return count($migration) ? $migration[0]->version : 0;
+        return $migration === [] ? '0' : $migration[0]->version;
     }
 
     /**

system/HTTP/IncomingRequest.php

@@ -165,9 +165,14 @@ public function __construct($config, ?URI $uri = null, $body = 'php://input', ?U
             $body = file_get_contents('php://input');
         }
 
+        // If file_get_contents() returns false or empty string, set null.
+        if ($body === false || $body === '') {
+            $body = null;
+        }
+
         $this->config       = $config;
         $this->uri          = $uri;
-        $this->body         = ! empty($body) ? $body : null;
+        $this->body         = $body;
         $this->userAgent    = $userAgent;
         $this->validLocales = $config->supportedLocales;
 

system/HTTP/Response.php

@@ -146,8 +146,10 @@ class Response extends Message implements ResponseInterface
      * @param App $config
      *
      * @todo Recommend removing reliance on config injection
+     *
+     * @deprecated 4.5.0 The param $config is no longer used.
      */
-    public function __construct($config)
+    public function __construct($config) // @phpstan-ignore-line
     {
         // Default to a non-caching page.
         // Also ensures that a Cache-control header exists.
@@ -156,8 +158,6 @@ public function __construct($config)
         // We need CSP object even if not enabled to avoid calls to non existing methods
         $this->CSP = Services::csp();
 
-        $this->CSPEnabled = $config->CSPEnabled;
-
         $this->cookieStore = new CookieStore([]);
 
         $cookie = config(CookieConfig::class);

system/HTTP/ResponseTrait.php

@@ -34,23 +34,12 @@
  */
 trait ResponseTrait
 {
-    /**
-     * Whether Content Security Policy is being enforced.
-     *
-     * @var bool
-     *
-     * @deprecated Use $this->CSP->enabled() instead.
-     */
-    protected $CSPEnabled = false;
-
     /**
      * Content security policy handler
      *
      * @var ContentSecurityPolicy
-     *
-     * @deprecated Will be protected. Use `getCSP()` instead.
      */
-    public $CSP;
+    protected $CSP;
 
     /**
      * CookieStore instance.
@@ -59,69 +48,6 @@ trait ResponseTrait
      */
     protected $cookieStore;
 
-    /**
-     * Set a cookie name prefix if you need to avoid collisions
-     *
-     * @var string
-     *
-     * @deprecated Use the dedicated Cookie class instead.
-     */
-    protected $cookiePrefix = '';
-
-    /**
-     * Set to .your-domain.com for site-wide cookies
-     *
-     * @var string
-     *
-     * @deprecated Use the dedicated Cookie class instead.
-     */
-    protected $cookieDomain = '';
-
-    /**
-     * Typically will be a forward slash
-     *
-     * @var string
-     *
-     * @deprecated Use the dedicated Cookie class instead.
-     */
-    protected $cookiePath = '/';
-
-    /**
-     * Cookie will only be set if a secure HTTPS connection exists.
-     *
-     * @var bool
-     *
-     * @deprecated Use the dedicated Cookie class instead.
-     */
-    protected $cookieSecure = false;
-
-    /**
-     * Cookie will only be accessible via HTTP(S) (no javascript)
-     *
-     * @var bool
-     *
-     * @deprecated Use the dedicated Cookie class instead.
-     */
-    protected $cookieHTTPOnly = false;
-
-    /**
-     * Cookie SameSite setting
-     *
-     * @var string
-     *
-     * @deprecated Use the dedicated Cookie class instead.
-     */
-    protected $cookieSameSite = Cookie::SAMESITE_LAX;
-
-    /**
-     * Stores all cookies that were set in the response.
-     *
-     * @var array
-     *
-     * @deprecated Use the dedicated Cookie class instead.
-     */
-    protected $cookies = [];
-
     /**
      * Type of format the body is in.
      * Valid: html, json, xml

system/HTTP/SiteURI.php

@@ -197,7 +197,7 @@ private function normalizeBaseURL(App $configApp): string
         // Validate baseURL
         if (filter_var($baseURL, FILTER_VALIDATE_URL) === false) {
             throw new ConfigException(
-                'Config\App::$baseURL is invalid.'
+                'Config\App::$baseURL "' . $baseURL . '" is not a valid URL.'
             );
         }
 

system/Helpers/Array/ArrayHelper.php

@@ -11,6 +11,8 @@
 
 namespace CodeIgniter\Helpers\Array;
 
+use InvalidArgumentException;
+
 /**
  * @interal This is internal implementation for the framework.
  *
@@ -27,9 +29,21 @@ final class ArrayHelper
      *
      * @used-by dot_array_search()
      *
+     * @param string $index The index as dot array syntax.
+     *
      * @return array|bool|int|object|string|null
      */
     public static function dotSearch(string $index, array $array)
+    {
+        return self::arraySearchDot(self::convertToArray($index), $array);
+    }
+
+    /**
+     * @param string $index The index as dot array syntax.
+     *
+     * @return list<string> The index as an array.
+     */
+    private static function convertToArray(string $index): array
     {
         // See https://regex101.com/r/44Ipql/1
         $segments = preg_split(
@@ -39,9 +53,10 @@ public static function dotSearch(string $index, array $array)
             PREG_SPLIT_NO_EMPTY
         );
 
-        $segments = array_map(static fn ($key) => str_replace('\.', '.', $key), $segments);
-
-        return self::arraySearchDot($segments, $array);
+        return array_map(
+            static fn ($key) => str_replace('\.', '.', $key),
+            $segments
+        );
     }
 
     /**
@@ -106,6 +121,59 @@ private static function arraySearchDot(array $indexes, array $array)
         return null;
     }
 
+    /**
+     * array_key_exists() with dot array syntax.
+     *
+     * If wildcard `*` is used, all items for the key after it must have the key.
+     */
+    public static function dotKeyExists(string $index, array $array): bool
+    {
+        if (str_ends_with($index, '*') || str_contains($index, '*.*')) {
+            throw new InvalidArgumentException(
+                'You must set key right after "*". Invalid index: "' . $index . '"'
+            );
+        }
+
+        $indexes = self::convertToArray($index);
+
+        // If indexes is empty, returns false.
+        if ($indexes === []) {
+            return false;
+        }
+
+        $currentArray = $array;
+
+        // Grab the current index
+        while ($currentIndex = array_shift($indexes)) {
+            if ($currentIndex === '*') {
+                $currentIndex = array_shift($indexes);
+
+                foreach ($currentArray as $item) {
+                    if (! array_key_exists($currentIndex, $item)) {
+                        return false;
+                    }
+                }
+
+                // If indexes is empty, all elements are checked.
+                if ($indexes === []) {
+                    return true;
+                }
+
+                $currentArray = self::dotSearch('*.' . $currentIndex, $currentArray);
+
+                continue;
+            }
+
+            if (! array_key_exists($currentIndex, $currentArray)) {
+                return false;
+            }
+
+            $currentArray = $currentArray[$currentIndex];
+        }
+
+        return true;
+    }
+
     /**
      * Groups all rows by their index values. Result's depth equals number of indexes
      *

system/Language/Language.php

@@ -88,7 +88,7 @@ public function getLocale(): string
      * Parses the language string for a file, loads the file, if necessary,
      * getting the line.
      *
-     * @return string|string[]
+     * @return list<string>|string
      */
     public function getLine(string $line, array $args = [])
     {

system/Session/Handlers/RedisHandler.php

@@ -124,7 +124,13 @@ public function open($path, $name): bool
 
         $redis = new Redis();
 
-        if (! $redis->connect($this->savePath['protocol'] . '://' . $this->savePath['host'], ($this->savePath['host'][0] === '/' ? 0 : $this->savePath['port']), $this->savePath['timeout'])) {
+        if (
+            ! $redis->connect(
+                $this->savePath['protocol'] . '://' . $this->savePath['host'],
+                ($this->savePath['host'][0] === '/') ? 0 : (int) $this->savePath['port'],
+                $this->savePath['timeout']
+            )
+        ) {
             $this->logger->error('Session: Unable to connect to Redis with the configured settings.');
         } elseif (isset($this->savePath['password']) && ! $redis->auth($this->savePath['password'])) {
             $this->logger->error('Session: Unable to authenticate to Redis instance.');

system/Test/CIUnitTestCase.php

@@ -439,7 +439,7 @@ public function assertHeaderNotEmitted(string $header, bool $ignoreCase = false)
      * where the result is close but not exactly equal to the
      * expected time, for reasons beyond our control.
      *
-     * @param mixed $actual
+     * @param float|int $actual
      *
      * @throws Exception
      */