Add missing typehints and docblocks for arrays

Author: devdot

src/Commands/ShowLog.php

@@ -46,6 +46,9 @@ class ShowLog extends Command
 
     protected int $terminalWidth;
 
+    /**
+     * @var array<string, int|string|null>
+     */
     protected array $filter = [
         'count' => null,
         'level' => null,
@@ -146,7 +149,7 @@ public function handle()
         return Command::SUCCESS;
     }
 
-    protected function printSeparator() {
+    protected function printSeparator(): void {
         $this->newLine();
         $this->line('<bg=gray>'.str_pad('', $this->terminalWidth, ' ').'</>');
         $this->newLine();

src/Helpers/CommandHelper.php

@@ -9,6 +9,7 @@
 class CommandHelper extends Command { 
     /**
      * Print a section component
+     * @param array<string> $data
      */
     public static function displaySection(Command $cmd, string $section, array $data): void {
         $cmd->newLine();

src/Models/Driver.php

@@ -4,8 +4,17 @@
 
 class Driver {
     protected string $channel;
+    /**
+     * @var array<int, string>
+     */
     protected array $filenames = [];
+    /**
+     * @var array<int, Log>
+     */
     protected array $logs = [];
+    /**
+     * @var array<int, LogRecord>
+     */
     protected array $records;
 
     public function __construct(string $channel) {
@@ -14,26 +23,36 @@ public function __construct(string $channel) {
         $this->createLogs();
     }
 
-    protected function generateFilenames() {
+    protected function generateFilenames(): void {
         $this->filenames = [];
     }
 
-    protected function createLogs() {
+    protected function createLogs(): void {
         $this->logs = array_map(fn($filename) => new Log($filename), $this->filenames);
     }
 
     public function getLaravelChannel(): string {
         return $this->channel;
     }
 
+    /**
+     * @return array<string>
+     */
     public function getFilenames(): array {
         return $this->filenames;
     }
 
+    /**
+     * @return array<Log>
+     */
     public function getLogs(): array {
         return $this->logs;
     }
 
+    /**
+     * @param array<string, int|string>  $filter
+     * @return array<LogRecord>
+     */
     public function getRecords(array $filter = []): array {
         // check if we have generated it before
         if(!isset($this->records) || empty($this->records)) {
@@ -43,7 +62,11 @@ public function getRecords(array $filter = []): array {
         return $this->getFilteredRecords($filter);
     }
 
-    public function getFilteredRecords(array $filter): array {
+    /**
+     * @param array<string, int|string>  $filter
+     * @return array<LogRecord>
+     */
+    protected function getFilteredRecords(array $filter): array {
         $records = $this->records;
         if(isset($filter['level'])) {
             // filter all that have this level
@@ -55,12 +78,15 @@ public function getFilteredRecords(array $filter): array {
         }
         if(isset($filter['count']) && count($records) > $filter['count']) {
             // only return the last $count
-            $records = array_slice($records, -$filter['count']);
+            $records = array_slice($records, -((int)$filter['count']));
         }
         return $records;
     }
 
-    protected function accumulateRecords(array $filter = []) {
+    /**
+     * @param array<string, int|string>  $filter
+     */
+    protected function accumulateRecords(array $filter = []): void {
         $this->records = [];
         foreach($this->logs as $log) {
             // get all the records from this logfile and merge them into the others
@@ -85,7 +111,7 @@ protected function accumulateRecords(array $filter = []) {
         $this->sortRecords();
     }
 
-    protected function sortRecords() {
-        usort($this->records, fn($a, $b) => ($a['datetime']->format('U') > $b['datetime']->format('U')));
+    protected function sortRecords(): void {
+        usort($this->records, fn($a, $b): int => (int) ($a['datetime']->format('U') > $b['datetime']->format('U')));
     }
 }

src/Models/DriverMultiple.php

@@ -7,15 +7,24 @@
 use Devdot\LogArtisan\Models\Drivers\Stack;
 
 class DriverMultiple extends Driver {
+    /**
+     * @var array<int, Driver> 
+     */
     protected array $drivers;
 
+    /**
+     * @param array<int, string> $channels
+     */
     public function __construct(string $channel, array $channels = []) {
         $this->channel = $channel;
         $this->createDrivers($channels);
         parent::__construct($channel);
     }
 
-    protected function createDrivers(array $channels) {
+    /**
+     * @param array<int, string> $channels
+     */
+    protected function createDrivers(array $channels): void {
         foreach($channels as $channel) {
             // create a new driver for each subchannel
             $driver = config('logging.channels.'.$channel.'.driver');
@@ -57,13 +66,12 @@ public function getLogs(): array {
         return $this->logs;
     }
 
-    protected function accumulateRecords(array $filter = []) {
+    protected function accumulateRecords(array $filter = []): void {
         $this->records = [];
         foreach($this->drivers as $driver) {
             $this->records = array_merge($this->records, $driver->getRecords($filter));
         }
         // make sure to sort after merging
         $this->sortRecords();
-        return $this->records;
     }
 }

src/Models/Drivers/Daily.php

@@ -5,7 +5,7 @@
 use Devdot\LogArtisan\Models\Driver;
 
 class Daily extends Driver {
-    protected function generateFilenames() {
+    protected function generateFilenames(): void {
         // get the config data
         $filename = config('logging.channels.'.$this->channel.'.path');
         $days = config('logging.channels.'.$this->channel.'.days');

src/Models/Drivers/Single.php

@@ -5,7 +5,7 @@
 use Devdot\LogArtisan\Models\Driver;
 
 class Single extends Driver {
-    protected function generateFilenames() {
+    protected function generateFilenames(): void {
         // get the file from the config
         $filename = config('logging.channels.'.$this->channel.'.path');
         // check if the file exists

src/Models/Drivers/Stack.php

@@ -5,7 +5,10 @@
 use Devdot\LogArtisan\Models\DriverMultiple;
 
 class Stack extends DriverMultiple {
-    protected function createDrivers(array $channels) {
+    /**
+     * @param array<int, string> $channels
+     */
+    protected function createDrivers(array $channels): void {
         if(empty($channels)) {
             $channels = config('logging.channels.'.$this->channel.'.channels') ?? [];
         }

src/Models/Log.php

@@ -20,7 +20,7 @@ public function __construct(string $filename = '') {
         }
     }
 
-    public function setFile(string $filename) {
+    public function setFile(string $filename): bool {
         // set in object
         $this->filename = $filename;
         // now attempt to set in parser
@@ -33,11 +33,14 @@ public function setFile(string $filename) {
         return true;
     }
 
-    public function getFilename() {
+    public function getFilename(): string {
         return $this->filename;
     }
 
-    public function getRecords() {
+    /**
+     * @return array<int, \Devdot\Monolog\LogRecord>
+     */
+    public function getRecords(): array {
         // simply access the parser
         return $this->parser->get();
     }

src/Models/LogRecord.php

@@ -5,11 +5,11 @@
 class LogRecord extends \Devdot\Monolog\LogRecord {
     private Driver $driver;
 
-    public function getDriver() {
+    public function getDriver(): Driver {
         return $this->driver;
     }
 
-    public function setDriver(Driver $driver) {
+    public function setDriver(Driver $driver): void {
         $this->driver = $driver;
     }
 }