Bump PHPStan to level 8; Add more parameter/return typing

iv-craig · iv-craig · commit 4a3a4d3e1c4e · 2024-10-08T14:38:58.000-04:00
diff --git a/phpstan.neon b/phpstan.neon
@@ -3,4 +3,12 @@ parameters:
     paths:
         - src/
 
-    level: 5
+    level: 8
+
+    ignoreErrors:
+        -
+            identifier: ternary.alwaysTrue
+            path: src/InterfaxChannel.php
+
+    stubFiles:
+        - stubs/Resource.stub
diff --git a/src/Contracts/InterfaxNotificationContract.php b/src/Contracts/InterfaxNotificationContract.php
@@ -6,5 +6,9 @@
 
 interface InterfaxNotificationContract
 {
+    /**
+     * @param  mixed $notifiable
+     * @return InterfaxMessage
+     */
     public function toInterfax($notifiable): InterfaxMessage;
 }
diff --git a/src/Exceptions/CouldNotSendNotification.php b/src/Exceptions/CouldNotSendNotification.php
@@ -7,9 +7,18 @@
 
 class CouldNotSendNotification extends Exception
 {
-    protected $interfaxMessage;
-    protected $responseAttributes;
+    protected InterfaxMessage $interfaxMessage;
 
+    /** @var array<string, mixed> */
+    protected array $responseAttributes;
+
+    /**
+     * @param string          $message
+     * @param int             $code
+     * @param Exception|null  $previous
+     * @param InterfaxMessage $interfaxMessage
+     * @param array<string, mixed>    $responseAttributes
+     */
     final public function __construct(string $message, int $code, Exception $previous = null, InterfaxMessage $interfaxMessage, array $responseAttributes)
     {
         parent::__construct($message, $code, $previous);
@@ -18,22 +27,37 @@ final public function __construct(string $message, int $code, Exception $previou
         $this->responseAttributes = $responseAttributes;
     }
 
-    public static function serviceRespondedWithAnError($message, $responseAttributes, string $exceptionMessage = 'The fax failed to send via InterFAX.')
+    /**
+     * @param  InterfaxMessage $message
+     * @param  array<string, mixed> $responseAttributes
+     * @param  string          $exceptionMessage
+     * @return CouldNotSendNotification
+     */
+    public static function serviceRespondedWithAnError(InterfaxMessage $message, array $responseAttributes, string $exceptionMessage = 'The fax failed to send via InterFAX.')
     {
         return new static($exceptionMessage, $responseAttributes['status'], null, $message, $responseAttributes);
     }
 
+    /**
+     * @return mixed
+     */
     public function getUser()
     {
         return $this->interfaxMessage->user;
     }
 
-    public function getMetadata()
+    /**
+     * @return array<string, mixed>
+     */
+    public function getMetadata(): array
     {
         return $this->interfaxMessage->metadata;
     }
 
-    public function getAttributes()
+    /**
+     * @return array<string, mixed>
+     */
+    public function getAttributes(): array
     {
         return $this->responseAttributes;
     }
diff --git a/src/InterfaxChannel.php b/src/InterfaxChannel.php
@@ -8,13 +8,10 @@
 
 class InterfaxChannel
 {
-    protected $client;
+    /** @var \Interfax\Outbound\Fax $fax */
     protected $fax;
 
-    public function __construct(Client $client)
-    {
-        $this->client = $client;
-    }
+    public function __construct(protected Client $client) {}
 
     /**
      * Send the given notification.
@@ -24,7 +21,7 @@ public function __construct(Client $client)
      *
      * @throws \NotificationChannels\Interfax\Exceptions\CouldNotSendNotification
      */
-    public function send($notifiable, InterfaxNotificationContract $notification)
+    public function send($notifiable, InterfaxNotificationContract $notification): void
     {
         if (! $faxNumber = $notifiable->routeNotificationFor('interfax')) {
             return;
@@ -41,11 +38,11 @@ public function send($notifiable, InterfaxNotificationContract $notification)
             if ($message->shouldCheckStatus()) {
                 $message->sleep();
 
-                while ($this->fax->refresh()->status < 0) {
+                while ($this->getStatus() < 0) {
                     $message->sleep();
                 }
 
-                if ($this->fax->refresh()->status > 0) {
+                if ($this->getStatus() > 0) {
                     throw CouldNotSendNotification::serviceRespondedWithAnError($message, $this->fax->attributes());
                 }
             }
@@ -56,4 +53,10 @@ public function send($notifiable, InterfaxNotificationContract $notification)
             throw CouldNotSendNotification::serviceRespondedWithAnError($message, $attributes, $exceptionMessage);
         }
     }
+
+    protected function getStatus(): int
+    {
+        $fax = $this->fax->refresh();
+        return $fax->status;
+    }
 }
diff --git a/src/InterfaxFile.php b/src/InterfaxFile.php
@@ -7,8 +7,8 @@ class InterfaxFile extends \Interfax\File
     /**
      * File constructor.
      *
-     * @param $location
-     * @param  array  $params
+     * @param  resource|string $location
+     * @param  array<string, mixed>  $params
      *
      * @throws \InvalidArgumentException
      */
diff --git a/src/InterfaxMessage.php b/src/InterfaxMessage.php
@@ -6,12 +6,17 @@
 
 class InterfaxMessage
 {
+    /** @var array<int, InterfaxFile|string|array<string, mixed>> */
     protected array $files;
+
+    /** @var resource|false $stream */
     protected $stream;
     protected string $filename;
     protected string $method;
-    protected $statusCheck = false;
-    public $user;
+    protected bool $statusCheck = false;
+    public mixed $user;
+
+    /** @var array<string, mixed> */
     public array $metadata = [];
 
     const FILES = 'files';
@@ -20,16 +25,20 @@ class InterfaxMessage
     const POLLING_INTERVAL_DEFAULT = 15;
     const POLLING_INTERVAL_MINIMUM = 10;
 
-    protected static $DEFAULT_CHUNK_SIZE = 1048576;
+    protected static int $DEFAULT_CHUNK_SIZE = 1048576;
 
-    public function file(string $file)
+    public function file(string $file): InterfaxMessage
     {
         $this->files = Arr::wrap($file);
         $this->method = static::FILES;
 
         return $this;
     }
 
+    /**
+     * @param  array<int, array<string, mixed>>  $files
+     * @return InterfaxMessage
+     */
     public function files(array $files): InterfaxMessage
     {
         $this->files = $files;
@@ -38,6 +47,11 @@ public function files(array $files): InterfaxMessage
         return $this;
     }
 
+    /**
+     * @param  resource|false $stream
+     * @param  string $filename
+     * @return InterfaxMessage
+     */
     public function stream($stream, string $filename): InterfaxMessage
     {
         $this->stream = $stream;
@@ -47,10 +61,9 @@ public function stream($stream, string $filename): InterfaxMessage
         return $this;
     }
 
-    public function checkStatus(bool $shouldCheck = true)
+    public function checkStatus(bool $shouldCheck = true): InterfaxMessage
     {
         $this->statusCheck = $shouldCheck;
-
         return $this;
     }
 
@@ -68,14 +81,13 @@ public function shouldCheckStatus(): bool
     public function user($notifiable): InterfaxMessage
     {
         $this->user = $notifiable;
-
         return $this;
     }
 
     /**
      * Add metadata to the message for logging purposes.
      *
-     * @param  array  $data  The data to add to the metadata array
+     * @param  array<string, mixed>  $data  The data to add to the metadata array
      * @return InterfaxMessage
      */
     public function addMetadata(array $data): InterfaxMessage
@@ -87,6 +99,9 @@ public function addMetadata(array $data): InterfaxMessage
         return $this;
     }
 
+    /**
+     * @return array<int, InterfaxFile|array<string, mixed>>|array<int, array<int, mixed>>
+     */
     public function makeFiles(): array
     {
         if ($this->method === static::STREAM) {
@@ -102,7 +117,7 @@ public function makeFiles(): array
             ];
         }
 
-        return array_map('static::setChunkSize', $this->files);
+        return array_map(fn ($file) => static::setChunkSize($file), $this->files);
     }
 
     public function sleep(): void
@@ -111,7 +126,11 @@ public function sleep(): void
         sleep(max($interval, static::POLLING_INTERVAL_MINIMUM));
     }
 
-    protected static function setChunkSize($file)
+    /**
+     * @param InterfaxFile|string|array<string, mixed> $file
+     * @return InterfaxFile|array<string, mixed>
+     */
+    protected static function setChunkSize(InterfaxFile|string|array $file): InterfaxFile|array
     {
         $chunk_size = config('services.interfax.chunk_size', static::$DEFAULT_CHUNK_SIZE);
 
diff --git a/src/InterfaxServiceProvider.php b/src/InterfaxServiceProvider.php
@@ -7,7 +7,7 @@
 
 class InterfaxServiceProvider extends ServiceProvider
 {
-    public function boot()
+    public function boot(): void
     {
         $this->app->when(InterfaxChannel::class)
             ->needs(Client::class)
diff --git a/stubs/Resource.stub b/stubs/Resource.stub
@@ -0,0 +1,23 @@
+<?php
+
+/**
+ * Interfax
+ *
+ * (C) InterFAX, 2016
+ *
+ * @package interfax/interfax
+ * @author Interfax <dev@interfax.net>
+ * @author Mike Smith <mike.smith@camc-ltd.co.uk>
+ * @copyright Copyright (c) 2016, InterFAX
+ * @license MIT
+ */
+
+namespace Interfax;
+
+/**
+ * @property-read int $status
+ */
+abstract class Resource
+{
+
+}

Original file line number	Diff line number	Diff line change
`@@ -6,5 +6,9 @@`
`6`	`6`
`7`	`7`	`interface InterfaxNotificationContract`
`8`	`8`	`{`
	`9`	`+ /**`
	`10`	`+ * @param mixed $notifiable`
	`11`	`+ * @return InterfaxMessage`
	`12`	`+ */`
`9`	`13`	`public function toInterfax($notifiable): InterfaxMessage;`
`10`	`14`	`}`
Original file line number	Diff line number	Diff line change
`@@ -7,9 +7,18 @@`
`7`	`7`
`8`	`8`	`class CouldNotSendNotification extends Exception`
`9`	`9`	`{`
`10`		`- protected $interfaxMessage;`
`11`		`- protected $responseAttributes;`
	`10`	`+ protected InterfaxMessage $interfaxMessage;`
`12`	`11`
	`12`	`+ /** @var array<string, mixed> */`
	`13`	`+ protected array $responseAttributes;`
	`14`	`+`
	`15`	`+ /**`
	`16`	`+ * @param string $message`
	`17`	`+ * @param int $code`
	`18`	`+ * @param Exception\|null $previous`
	`19`	`+ * @param InterfaxMessage $interfaxMessage`
	`20`	`+ * @param array<string, mixed> $responseAttributes`
	`21`	`+ */`
`13`	`22`	`final public function __construct(string $message, int $code, Exception $previous = null, InterfaxMessage $interfaxMessage, array $responseAttributes)`
`14`	`23`	`{`
`15`	`24`	`parent::__construct($message, $code, $previous);`
`@@ -18,22 +27,37 @@ final public function __construct(string $message, int $code, Exception $previou`
`18`	`27`	`$this->responseAttributes = $responseAttributes;`
`19`	`28`	`}`
`20`	`29`
`21`		`- public static function serviceRespondedWithAnError($message, $responseAttributes, string $exceptionMessage = 'The fax failed to send via InterFAX.')`
	`30`	`+ /**`
	`31`	`+ * @param InterfaxMessage $message`
	`32`	`+ * @param array<string, mixed> $responseAttributes`
	`33`	`+ * @param string $exceptionMessage`
	`34`	`+ * @return CouldNotSendNotification`
	`35`	`+ */`
	`36`	`+ public static function serviceRespondedWithAnError(InterfaxMessage $message, array $responseAttributes, string $exceptionMessage = 'The fax failed to send via InterFAX.')`
`22`	`37`	`{`
`23`	`38`	`return new static($exceptionMessage, $responseAttributes['status'], null, $message, $responseAttributes);`
`24`	`39`	`}`
`25`	`40`
	`41`	`+ /**`
	`42`	`+ * @return mixed`
	`43`	`+ */`
`26`	`44`	`public function getUser()`
`27`	`45`	`{`
`28`	`46`	`return $this->interfaxMessage->user;`
`29`	`47`	`}`
`30`	`48`
`31`		`- public function getMetadata()`
	`49`	`+ /**`
	`50`	`+ * @return array<string, mixed>`
	`51`	`+ */`
	`52`	`+ public function getMetadata(): array`
`32`	`53`	`{`
`33`	`54`	`return $this->interfaxMessage->metadata;`
`34`	`55`	`}`
`35`	`56`
`36`		`- public function getAttributes()`
	`57`	`+ /**`
	`58`	`+ * @return array<string, mixed>`
	`59`	`+ */`
	`60`	`+ public function getAttributes(): array`
`37`	`61`	`{`
`38`	`62`	`return $this->responseAttributes;`
`39`	`63`	`}`
Original file line number	Diff line number	Diff line change
`@@ -8,13 +8,10 @@`
`8`	`8`
`9`	`9`	`class InterfaxChannel`
`10`	`10`	`{`
`11`		`- protected $client;`
	`11`	`+ /** @var \Interfax\Outbound\Fax $fax */`
`12`	`12`	`protected $fax;`
`13`	`13`
`14`		`- public function __construct(Client $client)`
`15`		`- {`
`16`		`- $this->client = $client;`
`17`		`- }`
	`14`	`+ public function __construct(protected Client $client) {}`
`18`	`15`
`19`	`16`	`/**`
`20`	`17`	`* Send the given notification.`
`@@ -24,7 +21,7 @@ public function __construct(Client $client)`
`24`	`21`	`*`
`25`	`22`	`* @throws \NotificationChannels\Interfax\Exceptions\CouldNotSendNotification`
`26`	`23`	`*/`
`27`		`- public function send($notifiable, InterfaxNotificationContract $notification)`
	`24`	`+ public function send($notifiable, InterfaxNotificationContract $notification): void`
`28`	`25`	`{`
`29`	`26`	`if (! $faxNumber = $notifiable->routeNotificationFor('interfax')) {`
`30`	`27`	`return;`
`@@ -41,11 +38,11 @@ public function send($notifiable, InterfaxNotificationContract $notification)`
`41`	`38`	`if ($message->shouldCheckStatus()) {`
`42`	`39`	`$message->sleep();`
`43`	`40`
`44`		`- while ($this->fax->refresh()->status < 0) {`
	`41`	`+ while ($this->getStatus() < 0) {`
`45`	`42`	`$message->sleep();`
`46`	`43`	`}`
`47`	`44`
`48`		`- if ($this->fax->refresh()->status > 0) {`
	`45`	`+ if ($this->getStatus() > 0) {`
`49`	`46`	`throw CouldNotSendNotification::serviceRespondedWithAnError($message, $this->fax->attributes());`
`50`	`47`	`}`
`51`	`48`	`}`
`@@ -56,4 +53,10 @@ public function send($notifiable, InterfaxNotificationContract $notification)`
`56`	`53`	`throw CouldNotSendNotification::serviceRespondedWithAnError($message, $attributes, $exceptionMessage);`
`57`	`54`	`}`
`58`	`55`	`}`
	`56`	`+`
	`57`	`+ protected function getStatus(): int`
	`58`	`+ {`
	`59`	`+ $fax = $this->fax->refresh();`
	`60`	`+ return $fax->status;`
	`61`	`+ }`
`59`	`62`	`}`
Original file line number	Diff line number	Diff line change
`@@ -7,8 +7,8 @@ class InterfaxFile extends \Interfax\File`
`7`	`7`	`/**`
`8`	`8`	`* File constructor.`
`9`	`9`	`*`
`10`		`- * @param $location`
`11`		`- * @param array $params`
	`10`	`+ * @param resource\|string $location`
	`11`	`+ * @param array<string, mixed> $params`
`12`	`12`	`*`
`13`	`13`	`* @throws \InvalidArgumentException`
`14`	`14`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -6,12 +6,17 @@`
`6`	`6`
`7`	`7`	`class InterfaxMessage`
`8`	`8`	`{`
	`9`	`+ /** @var array<int, InterfaxFile\|string\|array<string, mixed>> */`
`9`	`10`	`protected array $files;`
	`11`	`+`
	`12`	`+ /** @var resource\|false $stream */`
`10`	`13`	`protected $stream;`
`11`	`14`	`protected string $filename;`
`12`	`15`	`protected string $method;`
`13`		`- protected $statusCheck = false;`
`14`		`- public $user;`
	`16`	`+ protected bool $statusCheck = false;`
	`17`	`+ public mixed $user;`
	`18`	`+`
	`19`	`+ /** @var array<string, mixed> */`
`15`	`20`	`public array $metadata = [];`
`16`	`21`
`17`	`22`	`const FILES = 'files';`
`@@ -20,16 +25,20 @@ class InterfaxMessage`
`20`	`25`	`const POLLING_INTERVAL_DEFAULT = 15;`
`21`	`26`	`const POLLING_INTERVAL_MINIMUM = 10;`
`22`	`27`
`23`		`- protected static $DEFAULT_CHUNK_SIZE = 1048576;`
	`28`	`+ protected static int $DEFAULT_CHUNK_SIZE = 1048576;`
`24`	`29`
`25`		`- public function file(string $file)`
	`30`	`+ public function file(string $file): InterfaxMessage`
`26`	`31`	`{`
`27`	`32`	`$this->files = Arr::wrap($file);`
`28`	`33`	`$this->method = static::FILES;`
`29`	`34`
`30`	`35`	`return $this;`
`31`	`36`	`}`
`32`	`37`
	`38`	`+ /**`
	`39`	`+ * @param array<int, array<string, mixed>> $files`
	`40`	`+ * @return InterfaxMessage`
	`41`	`+ */`
`33`	`42`	`public function files(array $files): InterfaxMessage`
`34`	`43`	`{`
`35`	`44`	`$this->files = $files;`
`@@ -38,6 +47,11 @@ public function files(array $files): InterfaxMessage`
`38`	`47`	`return $this;`
`39`	`48`	`}`
`40`	`49`
	`50`	`+ /**`
	`51`	`+ * @param resource\|false $stream`
	`52`	`+ * @param string $filename`
	`53`	`+ * @return InterfaxMessage`
	`54`	`+ */`
`41`	`55`	`public function stream($stream, string $filename): InterfaxMessage`
`42`	`56`	`{`
`43`	`57`	`$this->stream = $stream;`
`@@ -47,10 +61,9 @@ public function stream($stream, string $filename): InterfaxMessage`
`47`	`61`	`return $this;`
`48`	`62`	`}`
`49`	`63`
`50`		`- public function checkStatus(bool $shouldCheck = true)`
	`64`	`+ public function checkStatus(bool $shouldCheck = true): InterfaxMessage`
`51`	`65`	`{`
`52`	`66`	`$this->statusCheck = $shouldCheck;`
`53`		`-`
`54`	`67`	`return $this;`
`55`	`68`	`}`
`56`	`69`
`@@ -68,14 +81,13 @@ public function shouldCheckStatus(): bool`
`68`	`81`	`public function user($notifiable): InterfaxMessage`
`69`	`82`	`{`
`70`	`83`	`$this->user = $notifiable;`
`71`		`-`
`72`	`84`	`return $this;`
`73`	`85`	`}`
`74`	`86`
`75`	`87`	`/**`
`76`	`88`	`* Add metadata to the message for logging purposes.`
`77`	`89`	`*`
`78`		`- * @param array $data The data to add to the metadata array`
	`90`	`+ * @param array<string, mixed> $data The data to add to the metadata array`
`79`	`91`	`* @return InterfaxMessage`
`80`	`92`	`*/`
`81`	`93`	`public function addMetadata(array $data): InterfaxMessage`
`@@ -87,6 +99,9 @@ public function addMetadata(array $data): InterfaxMessage`
`87`	`99`	`return $this;`
`88`	`100`	`}`
`89`	`101`
	`102`	`+ /**`
	`103`	`+ * @return array<int, InterfaxFile\|array<string, mixed>>\|array<int, array<int, mixed>>`
	`104`	`+ */`
`90`	`105`	`public function makeFiles(): array`
`91`	`106`	`{`
`92`	`107`	`if ($this->method === static::STREAM) {`
`@@ -102,7 +117,7 @@ public function makeFiles(): array`
`102`	`117`	`];`
`103`	`118`	`}`
`104`	`119`
`105`		`- return array_map('static::setChunkSize', $this->files);`
	`120`	`+ return array_map(fn ($file) => static::setChunkSize($file), $this->files);`
`106`	`121`	`}`
`107`	`122`
`108`	`123`	`public function sleep(): void`
`@@ -111,7 +126,11 @@ public function sleep(): void`
`111`	`126`	`sleep(max($interval, static::POLLING_INTERVAL_MINIMUM));`
`112`	`127`	`}`
`113`	`128`
`114`		`- protected static function setChunkSize($file)`
	`129`	`+ /**`
	`130`	`+ * @param InterfaxFile\|string\|array<string, mixed> $file`
	`131`	`+ * @return InterfaxFile\|array<string, mixed>`
	`132`	`+ */`
	`133`	`+ protected static function setChunkSize(InterfaxFile\|string\|array $file): InterfaxFile\|array`
`115`	`134`	`{`
`116`	`135`	`$chunk_size = config('services.interfax.chunk_size', static::$DEFAULT_CHUNK_SIZE);`
`117`	`136`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@`
`7`	`7`
`8`	`8`	`class InterfaxServiceProvider extends ServiceProvider`
`9`	`9`	`{`
`10`		`- public function boot()`
	`10`	`+ public function boot(): void`
`11`	`11`	`{`
`12`	`12`	`$this->app->when(InterfaxChannel::class)`
`13`	`13`	`->needs(Client::class)`