refactor: apply phpstan rules

README.md

@@ -94,7 +94,8 @@ To run the example, you need:
 
 - `composer install`
 - `cp .env.example .env`
-- `composer test`, be aware: tests are a little specials, they are requiring env vars
+- ~~`composer test`~~, for now we don't have unit tests.
+- run `vendor/bin/phpstan analyse src -l 6` to run the static analyzer.
 
 #### TODO
 

composer.json

@@ -37,7 +37,8 @@
   },
   "require-dev": {
     "phpunit/phpunit": "^8.2",
-    "vlucas/phpdotenv": "^3.4"
+    "vlucas/phpdotenv": "^3.4",
+    "phpstan/phpstan": "^1.10"
   },
   "autoload": {
     "psr-4": {

src/Config.php

@@ -17,6 +17,7 @@ class Config
 
     protected int $maxMessageLength = 255;
 
+    /** @var string[] **/
     protected array $webHooks = [];
 
     protected string $template = "**[{datetime}]** {name}.{subName}.__{levelName}__: {message}";
@@ -33,10 +34,6 @@ class Config
      */
     public function getClient(): Client
     {
-        if (!$this->client) {
-            $this->client = new Client();
-        }
-
         return $this->client;
     }
 
@@ -122,7 +119,7 @@ public function isMultiMsg(): bool
      * @see isMultiMsg()
      * @see setMaxMessageLength()
      */
-    public function setMultiMsg(int $multiMsg): self
+    public function setMultiMsg(bool $multiMsg): self
     {
         $this->multiMsg = $multiMsg;
 
@@ -136,7 +133,7 @@ public function setMultiMsg(int $multiMsg): self
      *
      * @see getMaxMessageLength()
      */
-    public function setMaxMessageLength(int $maxMessageLength): self
+    public function setMaxMessageLength(int|null $maxMessageLength): self
     {
         if (!is_null($maxMessageLength)) {
             if (!is_int($maxMessageLength)) {
@@ -182,15 +179,15 @@ public function getWebHooks(): array
     }
 
     /**
-     * @param string|string[] $webHooks
+     * @param string[] $webHooks
      *
      * @return Config
      *
      * @see getWebHooks()
      */
     public function setWebHooks(array $webHooks): self
     {
-        $this->webHooks = (array)$webHooks;
+        $this->webHooks = $webHooks;
 
         return $this;
     }

src/DiscordHandler.php

@@ -16,7 +16,7 @@ class DiscordHandler extends AbstractProcessingHandler
     /**
      * DiscordHandler constructor.
      *
-     * @param array|string $webHooks
+     * @param string[]|string $webHook
      * @param string $name
      * @param string $subName
      * @param Level $level
@@ -59,7 +59,7 @@ public function setConfig(Config $config): self
     }
 
     /**
-     * @param array $record
+     * @param LogRecord $record
      *
      * @throws GuzzleException
      * @return void
@@ -131,10 +131,11 @@ protected function splitMessage(string $content): array
 
     /**
      * @param string $webHook
-     * @param string $json
+     * @param array $json
      *
      * @throws GuzzleException
      */
+    /** @phpstan-ignore-next-line */
     protected function send(string $webHook, array $json): void
     {
         $this->config->getClient()->request('POST', $webHook, [