Proper docblocks for filter arrays

Author: devdot

composer.json

@@ -33,5 +33,8 @@
                 "Devdot\\LogArtisan\\ServiceProvider"
             ]
         }
+    },
+    "require-dev": {
+        "phpstan/phpstan": "^1.10"
     }
 }

phpstan.neon

@@ -0,0 +1,17 @@
+parameters:
+
+    paths:
+        - src/
+
+    ignoreErrors:
+        -
+            message: '#Function config not found#'
+        -
+            message: '#Call to an undefined method Illuminate\\Contracts\\Foundation\\Application::configurationIsCached\(\)#'
+            path: src/Commands/AboutLog.php
+        -
+            message: '#Call to static method add\(\) on an unknown class Illuminate\\Foundation\\Console\\AboutCommand#'
+            path: src/ServiceProvider.php
+        -
+            message: '#Call to method info\(\) on an unknown class Psr\\Log\\LoggerInterface.#'
+            path: src/Commands/ClearLog.php

src/Commands/SearchLog.php

@@ -9,6 +9,13 @@
 class SearchLog extends ShowLog {
     protected $description = 'Search through all log entries';
 
+    /**
+     * @var array{count?: int, level?: string, search: string} Search is always set on SearchLog
+     */
+    protected array $filter = [
+        'search' => '',
+    ];
+
     public function __construct() {
         // basically, we use the parent class and add an arugment
         parent::__construct();

src/Commands/ShowLog.php

@@ -47,12 +47,9 @@ class ShowLog extends Command
     protected int $terminalWidth;
 
     /**
-     * @var array<string, int|string|null>
+     * @var array{count?: int, level?: string, search?: string}
      */
-    protected array $filter = [
-        'count' => null,
-        'level' => null,
-    ];
+    protected array $filter = [];
 
     /**
      * Execute the console command.
@@ -102,7 +99,7 @@ public function handle()
         $multidriver = new DriverMultiple('', $channels);
 
         // info line at top
-        $this->line('Showing <fg=gray>'.$this->filter['count'].'</> entries from log channel <fg=gray>'.implode(', ', $channels).'</>'.($this->filter['level'] ? ' at level <fg=gray>'.$this->filter['level'].'</fg=gray>' : ''));
+        $this->line('Showing <fg=gray>'.$this->filter['count'].'</> entries from log channel <fg=gray>'.implode(', ', $channels).'</>'.(isset($this->filter['level']) ? ' at level <fg=gray>'.$this->filter['level'].'</fg=gray>' : ''));
 
         // check if we have files at all
         if(count($multidriver->getFilenames()) === 0) {

src/Models/Driver.php

@@ -50,7 +50,7 @@ public function getLogs(): array {
     }
 
     /**
-     * @param array<string, int|string>  $filter
+     * @param array{count?: int, level?: string, search?: string} $filter Filter array as provided by ShowLog
      * @return array<LogRecord>
      */
     public function getRecords(array $filter = []): array {
@@ -63,7 +63,7 @@ public function getRecords(array $filter = []): array {
     }
 
     /**
-     * @param array<string, int|string>  $filter
+     * @param array{count?: int, level?: string, search?: string} $filter Filter array as provided by ShowLog
      * @return array<LogRecord>
      */
     protected function getFilteredRecords(array $filter): array {

src/Models/DriverMultiple.php

@@ -66,6 +66,9 @@ public function getLogs(): array {
         return $this->logs;
     }
 
+    /**
+     * @param array{count?: int, level?: string, search?: string} $filter Filter array as provided by ShowLog
+     */
     protected function accumulateRecords(array $filter = []): void {
         $this->records = [];
         foreach($this->drivers as $driver) {