refactor: fix phpstan errors in Debug (#10478)

Author: paulbalandan

system/Debug/BaseExceptionHandler.php

@@ -70,6 +70,16 @@ abstract public function handle(
 
     /**
      * Gathers the variables that will be made available to the view.
+     *
+     * @return array{
+     *   title: string,
+     *   type: string,
+     *   code: int,
+     *   message: string,
+     *   file: string,
+     *   line: int,
+     *   trace: list<array<string, mixed>>,
+     * }
      */
     protected function collectVars(Throwable $exception, int $statusCode): array
     {
@@ -99,6 +109,11 @@ protected function collectVars(Throwable $exception, int $statusCode): array
 
     /**
      * Mask sensitive data in the trace.
+     *
+     * @param list<array<string, mixed>> $trace
+     * @param list<string>               $keysToMask
+     *
+     * @return list<array<string, mixed>>
      */
     protected function maskSensitiveData(array $trace, array $keysToMask, string $path = ''): array
     {
@@ -110,9 +125,10 @@ protected function maskSensitiveData(array $trace, array $keysToMask, string $pa
     }
 
     /**
-     * @param array|object $args
+     * @param array<array-key, mixed>|object $args
+     * @param list<string>                   $keysToMask
      *
-     * @return array|object
+     * @return array<array-key, mixed>|object
      */
     private function maskData($args, array $keysToMask, string $path = '')
     {

system/Debug/Exceptions.php

@@ -355,6 +355,8 @@ protected function render(Throwable $exception, int $statusCode)
     /**
      * Gathers the variables that will be made available to the view.
      *
+     * @return array{title: string, type: string, code: int, message: string, file: string, line: int, trace: list<array<string, mixed>>}
+     *
      * @deprecated 4.4.0 No longer used. Moved to BaseExceptionHandler.
      */
     protected function collectVars(Throwable $exception, int $statusCode): array
@@ -386,9 +388,10 @@ protected function collectVars(Throwable $exception, int $statusCode): array
     /**
      * Mask sensitive data in the trace.
      *
-     * @param array $trace
+     * @param list<array<string, mixed>> $trace
+     * @param list<string>               $keysToMask
      *
-     * @return array
+     * @return list<array<string, mixed>>
      *
      * @deprecated 4.4.0 No longer used. Moved to BaseExceptionHandler.
      */
@@ -402,9 +405,10 @@ protected function maskSensitiveData($trace, array $keysToMask, string $path = '
     }
 
     /**
-     * @param array|object $args
+     * @param array<array-key, mixed>|object $args
+     * @param list<string>                   $keysToMask
      *
-     * @return array|object
+     * @return array<array-key, mixed>|object
      *
      * @deprecated 4.4.0 No longer used. Moved to BaseExceptionHandler.
      */
@@ -441,6 +445,8 @@ private function maskData($args, array $keysToMask, string $path = '')
 
     /**
      * Determines the HTTP status code and the exit status code for this request.
+     *
+     * @return array{int, int}
      */
     protected function determineCodes(Throwable $exception): array
     {

system/Debug/Iterator.php

@@ -23,14 +23,14 @@ class Iterator
     /**
      * Stores the tests that we are to run.
      *
-     * @var array
+     * @var array<string, Closure(): mixed>
      */
     protected $tests = [];
 
     /**
      * Stores the results of each of the tests.
      *
-     * @var array
+     * @var array<string, array{time: float, memory: int, n: int}>
      */
     protected $results = [];
 

system/Debug/Timer.php

@@ -28,7 +28,7 @@ class Timer
     /**
      * List of all timers.
      *
-     * @var array
+     * @var array<string, array{start: float, end: float|null}>
      */
     protected $timers = [];
 
@@ -107,6 +107,8 @@ public function getElapsedTime(string $name, int $decimals = 4)
      * Returns the array of timers, with the duration pre-calculated for you.
      *
      * @param int $decimals Number of decimal places
+     *
+     * @return array<string, array{start: float, end: float, duration: float}>
      */
     public function getTimers(int $decimals = 4): array
     {

system/Debug/Toolbar.php

@@ -190,6 +190,9 @@ public function run(float $startTime, float $totalTime, RequestInterface $reques
 
     /**
      * Called within the view to display the timeline itself.
+     *
+     * @param list<array{hasTimelineData: bool, timelineData: list<array<string, mixed>>}> $collectors
+     * @param array<string, string>                                                        $styles
      */
     protected function renderTimeline(array $collectors, float $startTime, int $segmentCount, int $segmentDuration, array &$styles): string
     {
@@ -202,6 +205,9 @@ protected function renderTimeline(array $collectors, float $startTime, int $segm
 
     /**
      * Recursively renders timeline elements and their children.
+     *
+     * @param list<array<string, mixed>> $rows
+     * @param array<string, string>      $styles
      */
     protected function renderTimelineRecursive(array $rows, float $startTime, int $segmentCount, int $segmentDuration, array &$styles, int &$styleCount, int $level = 0, bool $isChild = false): string
     {
@@ -268,7 +274,9 @@ protected function renderTimelineRecursive(array $rows, float $startTime, int $s
     /**
      * Returns a sorted array of timeline data arrays from the collectors.
      *
-     * @param array $collectors
+     * @param list<array{hasTimelineData: bool, timelineData: list<array<string, mixed>>}> $collectors
+     *
+     * @return list<array<string, mixed>>
      */
     protected function collectTimelineData($collectors): array
     {
@@ -305,6 +313,10 @@ protected function collectTimelineData($collectors): array
 
     /**
      * Arranges the already sorted timeline data into a parent => child structure.
+     *
+     * @param list<array<string, mixed>> $elements
+     *
+     * @return list<array<string, mixed>>
      */
     protected function structureTimelineData(array $elements): array
     {
@@ -333,6 +345,8 @@ protected function structureTimelineData(array $elements): array
     /**
      * Returns an array of data from all of the modules
      * that should be displayed in the 'Vars' tab.
+     *
+     * @return array<string, mixed>
      */
     protected function collectVarData(): array
     {

system/Debug/Toolbar/Collectors/BaseCollector.php

@@ -105,6 +105,8 @@ public function hasTimelineData(): bool
     /**
      * Grabs the data for the timeline, properly formatted,
      * or returns an empty array.
+     *
+     * @return list<array<string, mixed>>
      */
     public function timelineData(): array
     {
@@ -140,7 +142,7 @@ public function hasVarData(): bool
      *      ],
      *  ];
      *
-     * @return array|null
+     * @return array<string, mixed>|null
      */
     public function getVarData()
     {
@@ -159,6 +161,8 @@ public function getVarData()
      *      'start'     => 10       // milliseconds
      *      'duration'  => 15       // milliseconds
      *  ]
+     *
+     * @return list<array<string, mixed>>
      */
     protected function formatTimelineData(): array
     {
@@ -168,7 +172,7 @@ protected function formatTimelineData(): array
     /**
      * Returns the data of this collector to be formatted in the toolbar
      *
-     * @return array|string
+     * @return array<string, mixed>|string
      */
     public function display()
     {
@@ -218,6 +222,20 @@ public function icon(): string
 
     /**
      * Return settings as an array.
+     *
+     * @return array{
+     *   title: string,
+     *   titleSafe: string,
+     *   titleDetails: string,
+     *   display: array<string, mixed>|string,
+     *   badgeValue: int|null,
+     *   isEmpty: bool,
+     *   hasTabContent: bool,
+     *   hasLabel: bool,
+     *   icon: string,
+     *   hasTimelineData: bool,
+     *   timelineData: list<array<string, mixed>>,
+     * }
      */
     public function getAsArray(): array
     {

system/Debug/Toolbar/Collectors/Config.php

@@ -23,6 +23,17 @@ class Config
 {
     /**
      * Return toolbar config values as an array.
+     *
+     * @return array{
+     *   ciVersion: string,
+     *   phpVersion: string,
+     *   phpSAPI: string,
+     *   environment: string,
+     *   baseURL: string,
+     *   timezone: string,
+     *   locale: string,
+     *   cspEnabled: bool,
+     * }
      */
     public static function display(): array
     {

system/Debug/Toolbar/Collectors/Database.php

@@ -13,6 +13,7 @@
 
 namespace CodeIgniter\Debug\Toolbar\Collectors;
 
+use CodeIgniter\Database\BaseConnection;
 use CodeIgniter\Database\Query;
 use CodeIgniter\I18n\Time;
 use Config\Toolbar;
@@ -55,15 +56,15 @@ class Database extends BaseCollector
     /**
      * Array of database connections.
      *
-     * @var array
+     * @var array<string, BaseConnection>
      */
     protected $connections;
 
     /**
      * The query instances that have been collected
      * through the DBQuery Event.
      *
-     * @var array
+     * @var list<array{query: Query, string: string, duplicate: bool, trace: list<array<string, mixed>>}>
      */
     protected static $queries = [];
 
@@ -113,7 +114,13 @@ public static function collect(Query $query)
     /**
      * Returns timeline data formatted for the toolbar.
      *
-     * @return array The formatted data or an empty array.
+     * @return list<array{
+     *   name: string,
+     *   component: string,
+     *   start: float|string|null,
+     *   duration: string,
+     *   query?: string,
+     * }>
      */
     protected function formatTimelineData(): array
     {
@@ -144,6 +151,16 @@ protected function formatTimelineData(): array
 
     /**
      * Returns the data of this collector to be formatted in the toolbar
+     *
+     * @return array{queries: list<array{
+     *   hover: string,
+     *   class: string,
+     *   duration: string,
+     *   sql: string,
+     *   trace: list<array<string, mixed>>,
+     *   trace-file: string,
+     *   qid: string
+     * }>}
      */
     public function display(): array
     {

system/Debug/Toolbar/Collectors/Events.php

@@ -53,6 +53,8 @@ class Events extends BaseCollector
     /**
      * Child classes should implement this to return the timeline data
      * formatted for correct usage.
+     *
+     * @return list<array{name: string, component: string, start: float, duration: float}>
      */
     protected function formatTimelineData(): array
     {
@@ -74,6 +76,8 @@ protected function formatTimelineData(): array
 
     /**
      * Returns the data of this collector to be formatted in the toolbar
+     *
+     * @return array{events: array<string, array{event: string, duration: string, count: int}>}
      */
     public function display(): array
     {

system/Debug/Toolbar/Collectors/Files.php

@@ -52,6 +52,8 @@ public function getTitleDetails(): string
 
     /**
      * Returns the data of this collector to be formatted in the toolbar
+     *
+     * @return array{coreFiles: list<array{path: string, name: string}>, userFiles: list<array{path: string, name: string}>}
      */
     public function display(): array
     {