Merge branch 'develop' into 4.7

Author: paulbalandan

app/Config/Logger.php

@@ -4,6 +4,7 @@
 
 use CodeIgniter\Config\BaseConfig;
 use CodeIgniter\Log\Handlers\FileHandler;
+use CodeIgniter\Log\Handlers\HandlerInterface;
 
 class Logger extends BaseConfig
 {
@@ -73,7 +74,7 @@ class Logger extends BaseConfig
      * Handlers are executed in the order defined in this array, starting with
      * the handler on top and continuing down.
      *
-     * @var array<class-string, array<string, int|list<string>|string>>
+     * @var array<class-string<HandlerInterface>, array<string, int|list<string>|string>>
      */
     public array $handlers = [
         /*

composer.json

@@ -28,7 +28,7 @@
         "phpunit/phpcov": "^9.0.2 || ^10.0",
         "phpunit/phpunit": "^10.5.16 || ^11.2",
         "predis/predis": "^3.0",
-        "rector/rector": "2.0.16",
+        "rector/rector": "2.0.17",
         "shipmonk/phpstan-baseline-per-identifier": "^2.0"
     },
     "replace": {

system/API/ResponseTrait.php

@@ -13,17 +13,21 @@
 
 namespace CodeIgniter\API;
 
+use CodeIgniter\Format\Format;
 use CodeIgniter\Format\FormatterInterface;
 use CodeIgniter\HTTP\IncomingRequest;
+use CodeIgniter\HTTP\RequestInterface;
 use CodeIgniter\HTTP\ResponseInterface;
 
 /**
  * Provides common, more readable, methods to provide
  * consistent HTTP responses under a variety of common
  * situations when working as an API.
  *
- * @property bool $stringAsHtml Whether to treat string data as HTML in JSON response.
- *                              Setting `true` is only for backward compatibility.
+ * @property RequestInterface  $request
+ * @property ResponseInterface $response
+ * @property bool              $stringAsHtml Whether to treat string data as HTML in JSON response.
+ *                                           Setting `true` is only for backward compatibility.
  */
 trait ResponseTrait
 {
@@ -84,7 +88,7 @@ trait ResponseTrait
      * Provides a single, simple method to return an API response, formatted
      * to match the requested format, with proper content-type and status code.
      *
-     * @param array|string|null $data
+     * @param array<string, mixed>|string|null $data
      *
      * @return ResponseInterface
      */
@@ -118,9 +122,9 @@ protected function respond($data = null, ?int $status = null, string $message =
     /**
      * Used for generic failures that no custom methods exist for.
      *
-     * @param array|string $messages
-     * @param int          $status   HTTP status code
-     * @param string|null  $code     Custom, API-specific, error code
+     * @param list<string>|string $messages
+     * @param int                 $status   HTTP status code
+     * @param string|null         $code     Custom, API-specific, error code
      *
      * @return ResponseInterface
      */
@@ -146,7 +150,7 @@ protected function fail($messages, int $status = 400, ?string $code = null, stri
     /**
      * Used after successfully creating a new resource.
      *
-     * @param array|string|null $data
+     * @param array<string, mixed>|string|null $data
      *
      * @return ResponseInterface
      */
@@ -158,7 +162,7 @@ protected function respondCreated($data = null, string $message = '')
     /**
      * Used after a resource has been successfully deleted.
      *
-     * @param array|string|null $data
+     * @param array<string, mixed>|string|null $data
      *
      * @return ResponseInterface
      */
@@ -170,7 +174,7 @@ protected function respondDeleted($data = null, string $message = '')
     /**
      * Used after a resource has been successfully updated.
      *
-     * @param array|string|null $data
+     * @param array<string, mixed>|string|null $data
      *
      * @return ResponseInterface
      */
@@ -287,15 +291,17 @@ protected function failServerError(string $description = 'Internal Server Error'
      * Handles formatting a response. Currently, makes some heavy assumptions
      * and needs updating! :)
      *
-     * @param array|string|null $data
+     * @param array<string, mixed>|string|null $data
      *
      * @return string|null
      */
     protected function format($data = null)
     {
+        /** @var Format $format */
         $format = service('format');
 
-        $mime = ($this->format === null) ? $format->getConfig()->supportedResponseFormats[0]
+        $mime = $this->format === null
+            ? $format->getConfig()->supportedResponseFormats[0]
             : "application/{$this->format}";
 
         // Determine correct response type through content negotiation if not explicitly declared
@@ -313,14 +319,10 @@ protected function format($data = null)
         $this->response->setContentType($mime);
 
         // if we don't have a formatter, make one
-        if (! isset($this->formatter)) {
-            // if no formatter, use the default
-            $this->formatter = $format->getFormatter($mime);
-        }
+        $this->formatter ??= $format->getFormatter($mime);
 
         $asHtml = $this->stringAsHtml ?? false;
 
-        // Returns as HTML.
         if (
             ($mime === 'application/json' && $asHtml && is_string($data))
             || ($mime !== 'application/json' && is_string($data))
@@ -338,6 +340,7 @@ protected function format($data = null)
         if ($mime !== 'application/json') {
             // Recursively convert objects into associative arrays
             // Conversion not required for JSONFormatter
+            /** @var array<string, mixed>|string|null $data */
             $data = json_decode(json_encode($data), true);
         }
 
@@ -353,7 +356,7 @@ protected function format($data = null)
      */
     protected function setResponseFormat(?string $format = null)
     {
-        $this->format = ($format === null) ? null : strtolower($format);
+        $this->format = $format === null ? null : strtolower($format);
 
         return $this;
     }

system/Cache/Handlers/FileHandler.php

@@ -217,7 +217,7 @@ public function isSupported(): bool
 
     /**
      * Does the heavy lifting of actually retrieving the file and
-     * verifying it's age.
+     * verifying its age.
      *
      * @return array{data: mixed, ttl: int, time: int}|false
      */
@@ -227,7 +227,17 @@ protected function getItem(string $filename)
             return false;
         }
 
-        $data = @unserialize(file_get_contents($this->path . $filename));
+        $content = @file_get_contents($this->path . $filename);
+
+        if ($content === false) {
+            return false;
+        }
+
+        try {
+            $data = unserialize($content);
+        } catch (Throwable) {
+            return false;
+        }
 
         if (! is_array($data)) {
             return false;

system/Debug/Toolbar/Collectors/Logs.php

@@ -45,12 +45,14 @@ class Logs extends BaseCollector
     /**
      * Our collected data.
      *
-     * @var array
+     * @var list<array{level: string, msg: string}>
      */
     protected $data;
 
     /**
-     * Returns the data of this collector to be formatted in the toolbar
+     * Returns the data of this collector to be formatted in the toolbar.
+     *
+     * @return array{logs: list<array{level: string, msg: string}>}
      */
     public function display(): array
     {
@@ -66,7 +68,7 @@ public function isEmpty(): bool
     {
         $this->collectLogs();
 
-        return empty($this->data);
+        return $this->data !== [];
     }
 
     /**
@@ -82,14 +84,18 @@ public function icon(): string
     /**
      * Ensures the data has been collected.
      *
-     * @return array
+     * @return list<array{level: string, msg: string}>
      */
     protected function collectLogs()
     {
-        if (! empty($this->data)) {
+        if ($this->data !== []) {
             return $this->data;
         }
 
-        return $this->data = service('logger', true)->logCache ?? [];
+        $cache = service('logger')->logCache;
+
+        $this->data = $cache ?? [];
+
+        return $this->data;
     }
 }