From 4ef5da80ad69865199fbc95e8498e3e38d522f04 Mon Sep 17 00:00:00 2001 From: Jordi Boggiano Date: Fri, 28 May 2021 22:07:02 +0200 Subject: [PATCH] Fix CS --- src/Monolog/Formatter/ElasticaFormatter.php | 2 +- src/Monolog/Formatter/MongoDBFormatter.php | 4 ++-- src/Monolog/Formatter/NormalizerFormatter.php | 2 +- src/Monolog/Formatter/ScalarFormatter.php | 2 +- src/Monolog/Handler/BrowserConsoleHandler.php | 2 +- src/Monolog/Handler/DynamoDbHandler.php | 2 +- src/Monolog/Handler/ElasticaHandler.php | 4 ++-- src/Monolog/Handler/ElasticsearchHandler.php | 4 ++-- src/Monolog/Handler/ErrorLogHandler.php | 4 ++-- src/Monolog/Handler/FirePHPHandler.php | 5 +++-- src/Monolog/Handler/IFTTTHandler.php | 4 ++-- src/Monolog/Handler/LogglyHandler.php | 2 +- src/Monolog/Handler/NativeMailerHandler.php | 6 +++--- src/Monolog/Handler/PHPConsoleHandler.php | 1 + src/Monolog/Handler/ProcessableHandlerInterface.php | 2 +- src/Monolog/Handler/RedisPubSubHandler.php | 4 ++-- src/Monolog/Handler/Slack/SlackRecord.php | 3 +++ src/Monolog/Handler/SyslogUdpHandler.php | 2 +- src/Monolog/Handler/TelegramBotHandler.php | 5 ++++- src/Monolog/Handler/TestHandler.php | 6 +++--- src/Monolog/Processor/WebProcessor.php | 2 +- src/Monolog/SignalHandler.php | 8 ++++---- tests/Monolog/Formatter/ElasticaFormatterTest.php | 2 +- tests/Monolog/Handler/ElasticaHandlerTest.php | 9 ++++----- tests/Monolog/Handler/MongoDBHandlerTest.php | 1 - tests/Monolog/Handler/TelegramBotHandlerTest.php | 3 +-- 26 files changed, 48 insertions(+), 43 deletions(-) diff --git a/src/Monolog/Formatter/ElasticaFormatter.php b/src/Monolog/Formatter/ElasticaFormatter.php index 4dcebda7..9504d89c 100644 --- a/src/Monolog/Formatter/ElasticaFormatter.php +++ b/src/Monolog/Formatter/ElasticaFormatter.php @@ -77,7 +77,7 @@ class ElasticaFormatter extends NormalizerFormatter { $document = new Document(); $document->setData($record); - if(method_exists($document, 'setType')) { + if (method_exists($document, 'setType')) { $document->setType($this->type); } $document->setIndex($this->index); diff --git a/src/Monolog/Formatter/MongoDBFormatter.php b/src/Monolog/Formatter/MongoDBFormatter.php index 0c1197ed..adf2ce1a 100644 --- a/src/Monolog/Formatter/MongoDBFormatter.php +++ b/src/Monolog/Formatter/MongoDBFormatter.php @@ -66,7 +66,7 @@ class MongoDBFormatter implements FormatterInterface } /** - * @param mixed[] $array + * @param mixed[] $array * @return mixed[]|string Array except when max nesting level is reached then a string "[...]" */ protected function formatArray(array $array, int $nestingLevel = 0) @@ -91,7 +91,7 @@ class MongoDBFormatter implements FormatterInterface } /** - * @param mixed $value + * @param mixed $value * @return mixed[]|string */ protected function formatObject($value, int $nestingLevel) diff --git a/src/Monolog/Formatter/NormalizerFormatter.php b/src/Monolog/Formatter/NormalizerFormatter.php index 29288543..9363b6c4 100644 --- a/src/Monolog/Formatter/NormalizerFormatter.php +++ b/src/Monolog/Formatter/NormalizerFormatter.php @@ -122,7 +122,7 @@ class NormalizerFormatter implements FormatterInterface } /** - * @param mixed $data + * @param mixed $data * @return scalar|array */ protected function normalize($data, int $depth = 0) diff --git a/src/Monolog/Formatter/ScalarFormatter.php b/src/Monolog/Formatter/ScalarFormatter.php index c8889b5b..f209ae5d 100644 --- a/src/Monolog/Formatter/ScalarFormatter.php +++ b/src/Monolog/Formatter/ScalarFormatter.php @@ -34,7 +34,7 @@ class ScalarFormatter extends NormalizerFormatter } /** - * @param mixed $value + * @param mixed $value * @return string|int|bool|null */ protected function normalizeValue($value) diff --git a/src/Monolog/Handler/BrowserConsoleHandler.php b/src/Monolog/Handler/BrowserConsoleHandler.php index 6245def4..4177046f 100644 --- a/src/Monolog/Handler/BrowserConsoleHandler.php +++ b/src/Monolog/Handler/BrowserConsoleHandler.php @@ -213,7 +213,7 @@ class BrowserConsoleHandler extends AbstractProcessingHandler } /** - * @param mixed[] $dict + * @param mixed[] $dict * @return mixed[] */ private static function dump(string $title, array $dict): array diff --git a/src/Monolog/Handler/DynamoDbHandler.php b/src/Monolog/Handler/DynamoDbHandler.php index 9973fc3b..ec3bf2d1 100644 --- a/src/Monolog/Handler/DynamoDbHandler.php +++ b/src/Monolog/Handler/DynamoDbHandler.php @@ -84,7 +84,7 @@ class DynamoDbHandler extends AbstractProcessingHandler } /** - * @param mixed[] $record + * @param mixed[] $record * @return mixed[] */ protected function filterEmptyFields(array $record): array diff --git a/src/Monolog/Handler/ElasticaHandler.php b/src/Monolog/Handler/ElasticaHandler.php index 26f2187c..170bccf6 100644 --- a/src/Monolog/Handler/ElasticaHandler.php +++ b/src/Monolog/Handler/ElasticaHandler.php @@ -47,8 +47,8 @@ class ElasticaHandler extends AbstractProcessingHandler protected $options = []; /** - * @param Client $client Elastica Client object - * @param mixed[] $options Handler configuration + * @param Client $client Elastica Client object + * @param mixed[] $options Handler configuration */ public function __construct(Client $client, array $options = [], $level = Logger::DEBUG, bool $bubble = true) { diff --git a/src/Monolog/Handler/ElasticsearchHandler.php b/src/Monolog/Handler/ElasticsearchHandler.php index 44787dbe..0995100c 100644 --- a/src/Monolog/Handler/ElasticsearchHandler.php +++ b/src/Monolog/Handler/ElasticsearchHandler.php @@ -54,8 +54,8 @@ class ElasticsearchHandler extends AbstractProcessingHandler protected $options = []; /** - * @param Client $client Elasticsearch Client object - * @param mixed[] $options Handler configuration + * @param Client $client Elasticsearch Client object + * @param mixed[] $options Handler configuration */ public function __construct(Client $client, array $options = [], $level = Logger::DEBUG, bool $bubble = true) { diff --git a/src/Monolog/Handler/ErrorLogHandler.php b/src/Monolog/Handler/ErrorLogHandler.php index 5b75b000..2b8d1a88 100644 --- a/src/Monolog/Handler/ErrorLogHandler.php +++ b/src/Monolog/Handler/ErrorLogHandler.php @@ -31,8 +31,8 @@ class ErrorLogHandler extends AbstractProcessingHandler protected $expandNewlines; /** - * @param int $messageType Says where the error should go. - * @param bool $expandNewlines If set to true, newlines in the message will be expanded to be take multiple log entries + * @param int $messageType Says where the error should go. + * @param bool $expandNewlines If set to true, newlines in the message will be expanded to be take multiple log entries */ public function __construct(int $messageType = self::OPERATING_SYSTEM, $level = Logger::DEBUG, bool $bubble = true, bool $expandNewlines = false) { diff --git a/src/Monolog/Handler/FirePHPHandler.php b/src/Monolog/Handler/FirePHPHandler.php index f57677c8..e37180ca 100644 --- a/src/Monolog/Handler/FirePHPHandler.php +++ b/src/Monolog/Handler/FirePHPHandler.php @@ -63,8 +63,9 @@ class FirePHPHandler extends AbstractProcessingHandler /** * Base header creation function used by init headers & record headers * - * @param array $meta Wildfire Plugin, Protocol & Structure Indexes - * @param string $message Log message + * @param array $meta Wildfire Plugin, Protocol & Structure Indexes + * @param string $message Log message + * * @return array Complete header string ready for the client as key and message as value */ protected function createHeader(array $meta, string $message): array diff --git a/src/Monolog/Handler/IFTTTHandler.php b/src/Monolog/Handler/IFTTTHandler.php index 502f8c3c..18ed8cee 100644 --- a/src/Monolog/Handler/IFTTTHandler.php +++ b/src/Monolog/Handler/IFTTTHandler.php @@ -33,8 +33,8 @@ class IFTTTHandler extends AbstractProcessingHandler private $secretKey; /** - * @param string $eventName The name of the IFTTT Maker event that should be triggered - * @param string $secretKey A valid IFTTT secret key + * @param string $eventName The name of the IFTTT Maker event that should be triggered + * @param string $secretKey A valid IFTTT secret key */ public function __construct(string $eventName, string $secretKey, $level = Logger::ERROR, bool $bubble = true) { diff --git a/src/Monolog/Handler/LogglyHandler.php b/src/Monolog/Handler/LogglyHandler.php index 27ab9dc0..6d13db37 100644 --- a/src/Monolog/Handler/LogglyHandler.php +++ b/src/Monolog/Handler/LogglyHandler.php @@ -44,7 +44,7 @@ class LogglyHandler extends AbstractProcessingHandler protected $tag = []; /** - * @param string $token API token supplied by Loggly + * @param string $token API token supplied by Loggly * * @throws MissingExtensionException If the curl extension is missing */ diff --git a/src/Monolog/Handler/NativeMailerHandler.php b/src/Monolog/Handler/NativeMailerHandler.php index 6f2f965b..0989184a 100644 --- a/src/Monolog/Handler/NativeMailerHandler.php +++ b/src/Monolog/Handler/NativeMailerHandler.php @@ -66,9 +66,9 @@ class NativeMailerHandler extends MailHandler /** * @param string|string[] $to The receiver of the mail - * @param string $subject The subject of the mail - * @param string $from The sender of the mail - * @param int $maxColumnWidth The maximum column width that the message lines will have + * @param string $subject The subject of the mail + * @param string $from The sender of the mail + * @param int $maxColumnWidth The maximum column width that the message lines will have */ public function __construct($to, string $subject, string $from, $level = Logger::ERROR, bool $bubble = true, int $maxColumnWidth = 70) { diff --git a/src/Monolog/Handler/PHPConsoleHandler.php b/src/Monolog/Handler/PHPConsoleHandler.php index 16edf101..6e209b19 100644 --- a/src/Monolog/Handler/PHPConsoleHandler.php +++ b/src/Monolog/Handler/PHPConsoleHandler.php @@ -86,6 +86,7 @@ class PHPConsoleHandler extends AbstractProcessingHandler /** * @param array $options + * * @return array */ private function initOptions(array $options): array diff --git a/src/Monolog/Handler/ProcessableHandlerInterface.php b/src/Monolog/Handler/ProcessableHandlerInterface.php index a7487617..3adec7a4 100644 --- a/src/Monolog/Handler/ProcessableHandlerInterface.php +++ b/src/Monolog/Handler/ProcessableHandlerInterface.php @@ -37,7 +37,7 @@ interface ProcessableHandlerInterface * * @psalm-return ProcessorInterface|callable(Record): Record $callback * - * @throws \LogicException In case the processor stack is empty + * @throws \LogicException In case the processor stack is empty * @return callable|ProcessorInterface */ public function popProcessor(): callable; diff --git a/src/Monolog/Handler/RedisPubSubHandler.php b/src/Monolog/Handler/RedisPubSubHandler.php index 45218b30..f9fede8e 100644 --- a/src/Monolog/Handler/RedisPubSubHandler.php +++ b/src/Monolog/Handler/RedisPubSubHandler.php @@ -34,8 +34,8 @@ class RedisPubSubHandler extends AbstractProcessingHandler private $channelKey; /** - * @param \Predis\Client|\Redis $redis The redis instance - * @param string $key The channel key to publish records to + * @param \Predis\Client|\Redis $redis The redis instance + * @param string $key The channel key to publish records to */ public function __construct($redis, string $key, $level = Logger::DEBUG, bool $bubble = true) { diff --git a/src/Monolog/Handler/Slack/SlackRecord.php b/src/Monolog/Handler/Slack/SlackRecord.php index 53f2e760..e2c849c1 100644 --- a/src/Monolog/Handler/Slack/SlackRecord.php +++ b/src/Monolog/Handler/Slack/SlackRecord.php @@ -316,6 +316,7 @@ class SlackRecord * Generates attachment field * * @param string|mixed[] $value + * * @return array{title: string, value: string, short: false} */ private function generateAttachmentField(string $title, $value): array @@ -335,6 +336,7 @@ class SlackRecord * Generates a collection of attachment fields from array * * @param mixed[] $data + * * @return array */ private function generateAttachmentFields(array $data): array @@ -351,6 +353,7 @@ class SlackRecord * Get a copy of record with fields excluded according to $this->excludeFields * * @phpstan-param FormattedRecord $record + * * @return mixed[] */ private function removeExcludedFields(array $record): array diff --git a/src/Monolog/Handler/SyslogUdpHandler.php b/src/Monolog/Handler/SyslogUdpHandler.php index d1821ca7..e6b7f77b 100644 --- a/src/Monolog/Handler/SyslogUdpHandler.php +++ b/src/Monolog/Handler/SyslogUdpHandler.php @@ -79,7 +79,7 @@ class SyslogUdpHandler extends AbstractSyslogHandler } /** - * @param string|string[] $message + * @param string|string[] $message * @return string[] */ private function splitMessageIntoLines($message): array diff --git a/src/Monolog/Handler/TelegramBotHandler.php b/src/Monolog/Handler/TelegramBotHandler.php index 78774ce8..51fb7396 100644 --- a/src/Monolog/Handler/TelegramBotHandler.php +++ b/src/Monolog/Handler/TelegramBotHandler.php @@ -38,7 +38,7 @@ class TelegramBotHandler extends AbstractProcessingHandler private const AVAILABLE_PARSE_MODES = [ 'HTML', 'MarkdownV2', - 'Markdown' // legacy mode without underline and strikethrough, use MarkdownV2 instead + 'Markdown', // legacy mode without underline and strikethrough, use MarkdownV2 instead ]; /** @@ -104,18 +104,21 @@ class TelegramBotHandler extends AbstractProcessingHandler } $this->parseMode = $parseMode; + return $this; } public function disableWebPagePreview(bool $disableWebPagePreview = null): self { $this->disableWebPagePreview = $disableWebPagePreview; + return $this; } public function disableNotification(bool $disableNotification = null): self { $this->disableNotification = $disableNotification; + return $this; } diff --git a/src/Monolog/Handler/TestHandler.php b/src/Monolog/Handler/TestHandler.php index 03b51cd6..e2e3905f 100644 --- a/src/Monolog/Handler/TestHandler.php +++ b/src/Monolog/Handler/TestHandler.php @@ -172,7 +172,7 @@ class TestHandler extends AbstractProcessingHandler } /** - * @param string|int $level Logging level value or name + * @param string|int $level Logging level value or name * @return bool * * @psalm-param callable(Record, int): mixed $predicate @@ -205,8 +205,8 @@ class TestHandler extends AbstractProcessingHandler } /** - * @param string $method - * @param mixed[] $args + * @param string $method + * @param mixed[] $args * @return bool */ public function __call($method, $args) diff --git a/src/Monolog/Processor/WebProcessor.php b/src/Monolog/Processor/WebProcessor.php index 155e8157..64d251d7 100644 --- a/src/Monolog/Processor/WebProcessor.php +++ b/src/Monolog/Processor/WebProcessor.php @@ -93,7 +93,7 @@ class WebProcessor implements ProcessorInterface } /** - * @param mixed[] $extra + * @param mixed[] $extra * @return mixed[] */ private function appendExtraFields(array $extra): array diff --git a/src/Monolog/SignalHandler.php b/src/Monolog/SignalHandler.php index b1fafc01..d730eea3 100644 --- a/src/Monolog/SignalHandler.php +++ b/src/Monolog/SignalHandler.php @@ -41,10 +41,10 @@ class SignalHandler } /** - * @param int|string $level Level or level name - * @param bool $callPrevious - * @param bool $restartSyscalls - * @param bool|null $async + * @param int|string $level Level or level name + * @param bool $callPrevious + * @param bool $restartSyscalls + * @param bool|null $async * @return $this * * @phpstan-param Level|LevelName|LogLevel::* $level diff --git a/tests/Monolog/Formatter/ElasticaFormatterTest.php b/tests/Monolog/Formatter/ElasticaFormatterTest.php index d42ca2a5..dc280fea 100644 --- a/tests/Monolog/Formatter/ElasticaFormatterTest.php +++ b/tests/Monolog/Formatter/ElasticaFormatterTest.php @@ -56,7 +56,7 @@ class ElasticaFormatterTest extends \PHPUnit\Framework\TestCase // Document parameters $this->assertEquals('my_index', $doc->getIndex()); - if(method_exists($doc, 'getType')) { + if (method_exists($doc, 'getType')) { $this->assertEquals('doc_type', $doc->getType()); } diff --git a/tests/Monolog/Handler/ElasticaHandlerTest.php b/tests/Monolog/Handler/ElasticaHandlerTest.php index b08bce2e..7fb9808e 100644 --- a/tests/Monolog/Handler/ElasticaHandlerTest.php +++ b/tests/Monolog/Handler/ElasticaHandlerTest.php @@ -263,7 +263,6 @@ class ElasticaHandlerTest extends TestCase $client->request("/{$this->options['index']}", Request::DELETE); } - /** * Return last created document id from ES response * @param Response $response Elastica Response object @@ -279,15 +278,15 @@ class ElasticaHandlerTest extends TestCase /** * Retrieve document by id from Elasticsearch - * @param Client $client Elastica client - * @param string $index + * @param Client $client Elastica client + * @param string $index * @param ?string $type - * @param string $documentId + * @param string $documentId * @return array */ protected function getDocSourceFromElastic(Client $client, $index, $type, $documentId) { - if($type === null) { + if ($type === null) { $path = "/{$index}/_doc/{$documentId}"; } else { $path = "/{$index}/{$type}/{$documentId}"; diff --git a/tests/Monolog/Handler/MongoDBHandlerTest.php b/tests/Monolog/Handler/MongoDBHandlerTest.php index 0a9a0bea..82be0d6f 100644 --- a/tests/Monolog/Handler/MongoDBHandlerTest.php +++ b/tests/Monolog/Handler/MongoDBHandlerTest.php @@ -13,7 +13,6 @@ namespace Monolog\Handler; use MongoDB\Driver\Manager; use Monolog\Test\TestCase; -use Monolog\Formatter\NormalizerFormatter; class MongoDBHandlerTest extends TestCase { diff --git a/tests/Monolog/Handler/TelegramBotHandlerTest.php b/tests/Monolog/Handler/TelegramBotHandlerTest.php index 55a96b83..6cb3c7d9 100644 --- a/tests/Monolog/Handler/TelegramBotHandlerTest.php +++ b/tests/Monolog/Handler/TelegramBotHandlerTest.php @@ -41,8 +41,7 @@ class TelegramBotHandlerTest extends TestCase string $parseMode = 'Markdown', bool $disableWebPagePreview = false, bool $disableNotification = true - ): void - { + ): void { $constructorArgs = [$apiKey, $channel, Logger::DEBUG, true, $parseMode, $disableWebPagePreview, $disableNotification]; $this->handler = $this->getMockBuilder(TelegramBotHandler::class)