Use @return $this where applicable (#1828)

Seldaek · Aug 3, 2023 · 9546d94 · 9546d94
1 parent e239236
commit 9546d94
Show file tree

Hide file tree

Showing 20 changed files with 132 additions and 6 deletions.
diff --git a/src/Monolog/ErrorHandler.php b/src/Monolog/ErrorHandler.php
@@ -63,7 +63,7 @@ public function __construct(
      * @param  array<int, LogLevel::*>|false          $errorLevelMap     an array of E_* constant to LogLevel::* constant mapping, or false to disable error handling
      * @param  array<class-string, LogLevel::*>|false $exceptionLevelMap an array of class name to LogLevel::* constant mapping, or false to disable exception handling
      * @param  LogLevel::*|null|false                 $fatalLevel        a LogLevel::* constant, null to use the default LogLevel::ALERT or false to disable fatal error handling
-     * @return ErrorHandler
+     * @return static
      */
     public static function register(LoggerInterface $logger, $errorLevelMap = [], $exceptionLevelMap = [], $fatalLevel = null): self
     {
@@ -126,6 +126,7 @@ public function registerErrorHandler(array $levelMap = [], bool $callPrevious =
     /**
      * @param LogLevel::*|null $level              a LogLevel::* constant, null to use the default LogLevel::ALERT
      * @param int              $reservedMemorySize Amount of KBs to reserve in memory so that it can be freed when handling fatal errors giving Monolog some room in memory to get its job done
+     * @return $this
      */
     public function registerFatalHandler($level = null, int $reservedMemorySize = 20): self
     {

diff --git a/src/Monolog/Formatter/JsonFormatter.php b/src/Monolog/Formatter/JsonFormatter.php
@@ -107,6 +107,9 @@ public function formatBatch(array $records): string
         };
     }
 
+    /**
+     * @return $this
+     */
     public function includeStacktraces(bool $include = true): self
     {
         $this->includeStacktraces = $include;

diff --git a/src/Monolog/Formatter/LineFormatter.php b/src/Monolog/Formatter/LineFormatter.php
@@ -49,6 +49,9 @@ public function __construct(?string $format = null, ?string $dateFormat = null,
         parent::__construct($dateFormat);
     }
 
+    /**
+     * @return $this
+     */
     public function includeStacktraces(bool $include = true, ?Closure $parser = null): self
     {
         $this->includeStacktraces = $include;
@@ -60,13 +63,19 @@ public function includeStacktraces(bool $include = true, ?Closure $parser = null
         return $this;
     }
 
+    /**
+     * @return $this
+     */
     public function allowInlineLineBreaks(bool $allow = true): self
     {
         $this->allowInlineLineBreaks = $allow;
 
         return $this;
     }
 
+    /**
+     * @return $this
+     */
     public function ignoreEmptyContextAndExtra(bool $ignore = true): self
     {
         $this->ignoreEmptyContextAndExtra = $ignore;

diff --git a/src/Monolog/Formatter/LogmaticFormatter.php b/src/Monolog/Formatter/LogmaticFormatter.php
@@ -26,13 +26,19 @@ class LogmaticFormatter extends JsonFormatter
 
     protected string $appName = '';
 
+    /**
+     * @return $this
+     */
     public function setHostname(string $hostname): self
     {
         $this->hostname = $hostname;
 
         return $this;
     }
 
+    /**
+     * @return $this
+     */
     public function setAppName(string $appName): self
     {
         $this->appName = $appName;

diff --git a/src/Monolog/Formatter/MongoDBFormatter.php b/src/Monolog/Formatter/MongoDBFormatter.php
@@ -154,7 +154,6 @@ private function legacyGetMongoDbDateTime(\DateTimeInterface $value): UTCDateTim
             ? (int) $milliseconds
             : (string) $milliseconds;
 
-        // @phpstan-ignore-next-line
         return new UTCDateTime($milliseconds);
     }
 }
diff --git a/src/Monolog/Formatter/NormalizerFormatter.php b/src/Monolog/Formatter/NormalizerFormatter.php
@@ -78,6 +78,9 @@ public function getDateFormat(): string
         return $this->dateFormat;
     }
 
+    /**
+     * @return $this
+     */
     public function setDateFormat(string $dateFormat): self
     {
         $this->dateFormat = $dateFormat;
@@ -93,6 +96,9 @@ public function getMaxNormalizeDepth(): int
         return $this->maxNormalizeDepth;
     }
 
+    /**
+     * @return $this
+     */
     public function setMaxNormalizeDepth(int $maxNormalizeDepth): self
     {
         $this->maxNormalizeDepth = $maxNormalizeDepth;
@@ -108,6 +114,9 @@ public function getMaxNormalizeItemCount(): int
         return $this->maxNormalizeItemCount;
     }
 
+    /**
+     * @return $this
+     */
     public function setMaxNormalizeItemCount(int $maxNormalizeItemCount): self
     {
         $this->maxNormalizeItemCount = $maxNormalizeItemCount;
@@ -117,6 +126,8 @@ public function setMaxNormalizeItemCount(int $maxNormalizeItemCount): self
 
     /**
      * Enables `json_encode` pretty print.
+     *
+     * @return $this
      */
     public function setJsonPrettyPrint(bool $enable): self
     {
@@ -289,13 +300,19 @@ protected function formatDate(\DateTimeInterface $date): string
         return $date->format($this->dateFormat);
     }
 
+    /**
+     * @return $this
+     */
     public function addJsonEncodeOption(int $option): self
     {
         $this->jsonEncodeOptions |= $option;
 
         return $this;
     }
 
+    /**
+     * @return $this
+     */
     public function removeJsonEncodeOption(int $option): self
     {
         $this->jsonEncodeOptions &= ~$option;

diff --git a/src/Monolog/Handler/AbstractHandler.php b/src/Monolog/Handler/AbstractHandler.php
@@ -51,6 +51,7 @@ public function isHandling(LogRecord $record): bool
      * Sets minimum logging level at which this handler will be triggered.
      *
      * @param Level|LogLevel::* $level Level or level name
+     * @return $this
      *
      * @phpstan-param value-of<Level::VALUES>|value-of<Level::NAMES>|Level|LogLevel::* $level
      */
@@ -74,6 +75,7 @@ public function getLevel(): Level
      *
      * @param bool $bubble true means that this handler allows bubbling.
      *                     false means that bubbling is not permitted.
+     * @return $this
      */
     public function setBubble(bool $bubble): self
     {

diff --git a/src/Monolog/Handler/FilterHandler.php b/src/Monolog/Handler/FilterHandler.php
@@ -80,6 +80,7 @@ public function getAcceptedLevels(): array
     /**
      * @param int|string|Level|LogLevel::*|array<int|string|Level|LogLevel::*> $minLevelOrList A list of levels to accept or a minimum level or level name if maxLevel is provided
      * @param int|string|Level|LogLevel::*                                               $maxLevel       Maximum level or level name to accept, only used if $minLevelOrList is not an array
+     * @return $this
      *
      * @phpstan-param value-of<Level::VALUES>|value-of<Level::NAMES>|Level|LogLevel::*|array<value-of<Level::VALUES>|value-of<Level::NAMES>|Level|LogLevel::*> $minLevelOrList
      * @phpstan-param value-of<Level::VALUES>|value-of<Level::NAMES>|Level|LogLevel::* $maxLevel

diff --git a/src/Monolog/Handler/LogglyHandler.php b/src/Monolog/Handler/LogglyHandler.php
@@ -89,6 +89,7 @@ private function loadCurlHandle(string $endpoint): CurlHandle
 
     /**
      * @param string[]|string $tag
+     * @return $this
      */
     public function setTag(string|array $tag): self
     {
@@ -103,6 +104,7 @@ public function setTag(string|array $tag): self
 
     /**
      * @param string[]|string $tag
+     * @return $this
      */
     public function addTag(string|array $tag): self
     {

diff --git a/src/Monolog/Handler/NativeMailerHandler.php b/src/Monolog/Handler/NativeMailerHandler.php
@@ -79,6 +79,7 @@ public function __construct(string|array $to, string $subject, string $from, int
      * Add headers to the message
      *
      * @param string|string[] $headers Custom added headers
+     * @return $this
      */
     public function addHeader($headers): self
     {
@@ -96,6 +97,7 @@ public function addHeader($headers): self
      * Add parameters to the message
      *
      * @param string|string[] $parameters Custom added parameters
+     * @return $this
      */
     public function addParameter($parameters): self
     {
@@ -142,6 +144,7 @@ public function getEncoding(): string
 
     /**
      * @param string $contentType The content type of the email - Defaults to text/plain. Use text/html for HTML messages.
+     * @return $this
      */
     public function setContentType(string $contentType): self
     {
@@ -154,6 +157,9 @@ public function setContentType(string $contentType): self
         return $this;
     }
 
+    /**
+     * @return $this
+     */
     public function setEncoding(string $encoding): self
     {
         if (strpos($encoding, "\n") !== false || strpos($encoding, "\r") !== false) {

diff --git a/src/Monolog/Handler/PushoverHandler.php b/src/Monolog/Handler/PushoverHandler.php
@@ -208,6 +208,7 @@ protected function write(LogRecord $record): void
 
     /**
      * @param int|string|Level|LogLevel::* $level
+     * @return $this
      *
      * @phpstan-param value-of<Level::VALUES>|value-of<Level::NAMES>|Level|LogLevel::* $level
      */
@@ -220,6 +221,7 @@ public function setHighPriorityLevel(int|string|Level $level): self
 
     /**
      * @param int|string|Level|LogLevel::* $level
+     * @return $this
      *
      * @phpstan-param value-of<Level::VALUES>|value-of<Level::NAMES>|Level|LogLevel::* $level
      */
@@ -232,6 +234,8 @@ public function setEmergencyLevel(int|string|Level $level): self
 
     /**
      * Use the formatted message?
+     *
+     * @return $this
      */
     public function useFormattedMessage(bool $useFormattedMessage): self
     {

diff --git a/src/Monolog/Handler/RotatingFileHandler.php b/src/Monolog/Handler/RotatingFileHandler.php
@@ -77,6 +77,9 @@ public function reset(): void
         }
     }
 
+    /**
+     * @return $this
+     */
     public function setFilenameFormat(string $filenameFormat, string $dateFormat): self
     {
         $this->setDateFormat($dateFormat);

diff --git a/src/Monolog/Handler/Slack/SlackRecord.php b/src/Monolog/Handler/Slack/SlackRecord.php
@@ -221,8 +221,7 @@ public function stringify(array $fields): string
      * Channel used by the bot when posting
      *
      * @param ?string $channel
-     *
-     * @return static
+     * @return $this
      */
     public function setChannel(?string $channel = null): self
     {
@@ -235,8 +234,7 @@ public function setChannel(?string $channel = null): self
      * Username used by the bot when posting
      *
      * @param ?string $username
-     *
-     * @return static
+     * @return $this
      */
     public function setUsername(?string $username = null): self
     {
@@ -245,13 +243,19 @@ public function setUsername(?string $username = null): self
         return $this;
     }
 
+    /**
+     * @return $this
+     */
     public function useAttachment(bool $useAttachment = true): self
     {
         $this->useAttachment = $useAttachment;
 
         return $this;
     }
 
+    /**
+     * @return $this
+     */
     public function setUserIcon(?string $userIcon = null): self
     {
         $this->userIcon = $userIcon;
@@ -263,13 +267,19 @@ public function setUserIcon(?string $userIcon = null): self
         return $this;
     }
 
+    /**
+     * @return $this
+     */
     public function useShortAttachment(bool $useShortAttachment = false): self
     {
         $this->useShortAttachment = $useShortAttachment;
 
         return $this;
     }
 
+    /**
+     * @return $this
+     */
     public function includeContextAndExtra(bool $includeContextAndExtra = false): self
     {
         $this->includeContextAndExtra = $includeContextAndExtra;
@@ -283,6 +293,7 @@ public function includeContextAndExtra(bool $includeContextAndExtra = false): se
 
     /**
      * @param string[] $excludeFields
+     * @return $this
      */
     public function excludeFields(array $excludeFields = []): self
     {
@@ -291,6 +302,9 @@ public function excludeFields(array $excludeFields = []): self
         return $this;
     }
 
+    /**
+     * @return $this
+     */
     public function setFormatter(?FormatterInterface $formatter = null): self
     {
         $this->formatter = $formatter;

diff --git a/src/Monolog/Handler/SlackHandler.php b/src/Monolog/Handler/SlackHandler.php
@@ -192,6 +192,8 @@ public function getFormatter(): FormatterInterface
 
     /**
      * Channel used by the bot when posting
+     *
+     * @return $this
      */
     public function setChannel(string $channel): self
     {
@@ -202,6 +204,8 @@ public function setChannel(string $channel): self
 
     /**
      * Username used by the bot when posting
+     *
+     * @return $this
      */
     public function setUsername(string $username): self
     {
@@ -210,27 +214,39 @@ public function setUsername(string $username): self
         return $this;
     }
 
+    /**
+     * @return $this
+     */
     public function useAttachment(bool $useAttachment): self
     {
         $this->slackRecord->useAttachment($useAttachment);
 
         return $this;
     }
 
+    /**
+     * @return $this
+     */
     public function setIconEmoji(string $iconEmoji): self
     {
         $this->slackRecord->setUserIcon($iconEmoji);
 
         return $this;
     }
 
+    /**
+     * @return $this
+     */
     public function useShortAttachment(bool $useShortAttachment): self
     {
         $this->slackRecord->useShortAttachment($useShortAttachment);
 
         return $this;
     }
 
+    /**
+     * @return $this
+     */
     public function includeContextAndExtra(bool $includeContextAndExtra): self
     {
         $this->slackRecord->includeContextAndExtra($includeContextAndExtra);
@@ -240,6 +256,7 @@ public function includeContextAndExtra(bool $includeContextAndExtra): self
 
     /**
      * @param string[] $excludeFields
+     * @return $this
      */
     public function excludeFields(array $excludeFields): self
     {