diff options
author | Jordi Boggiano <j.boggiano@seld.be> | 2016-09-25 22:00:12 +0200 |
---|---|---|
committer | Jordi Boggiano <j.boggiano@seld.be> | 2016-09-25 22:11:37 +0200 |
commit | 5ce1c921ad972c2f883e56220fadbdbda944c3f6 (patch) | |
tree | e426a32b0148f606a46a94b34bfbfdfae1f67e18 /src | |
parent | 85792c881869dc8e7edaf479138e44795e4e055f (diff) | |
download | monolog-5ce1c921ad972c2f883e56220fadbdbda944c3f6.zip monolog-5ce1c921ad972c2f883e56220fadbdbda944c3f6.tar.gz monolog-5ce1c921ad972c2f883e56220fadbdbda944c3f6.tar.bz2 |
Fix type errors, thanks phan
Diffstat (limited to 'src')
-rw-r--r-- | src/Monolog/ErrorHandler.php | 2 | ||||
-rw-r--r-- | src/Monolog/Handler/ChromePHPHandler.php | 6 | ||||
-rw-r--r-- | src/Monolog/Handler/FirePHPHandler.php | 6 | ||||
-rw-r--r-- | src/Monolog/Handler/FlowdockHandler.php | 2 | ||||
-rw-r--r-- | src/Monolog/Handler/GelfHandler.php | 2 | ||||
-rw-r--r-- | src/Monolog/Handler/ProcessHandler.php | 18 | ||||
-rw-r--r-- | src/Monolog/Handler/RavenHandler.php | 4 | ||||
-rw-r--r-- | src/Monolog/Handler/RedisHandler.php | 4 | ||||
-rw-r--r-- | src/Monolog/Handler/SocketHandler.php | 13 | ||||
-rw-r--r-- | src/Monolog/Handler/StreamHandler.php | 2 | ||||
-rw-r--r-- | src/Monolog/Handler/SyslogUdp/UdpSocket.php | 2 | ||||
-rw-r--r-- | src/Monolog/Logger.php | 27 | ||||
-rw-r--r-- | src/Monolog/Processor/MercurialProcessor.php | 2 | ||||
-rw-r--r-- | src/Monolog/Test/TestCase.php | 8 |
14 files changed, 43 insertions, 55 deletions
diff --git a/src/Monolog/ErrorHandler.php b/src/Monolog/ErrorHandler.php index 783cea5..18c783f 100644 --- a/src/Monolog/ErrorHandler.php +++ b/src/Monolog/ErrorHandler.php @@ -188,7 +188,7 @@ class ErrorHandler */ public function handleFatalError() { - $this->reservedMemory = null; + $this->reservedMemory = ''; $lastError = error_get_last(); if ($lastError && in_array($lastError['type'], self::$fatalErrors, true)) { diff --git a/src/Monolog/Handler/ChromePHPHandler.php b/src/Monolog/Handler/ChromePHPHandler.php index 31573ad..5dc5d5c 100644 --- a/src/Monolog/Handler/ChromePHPHandler.php +++ b/src/Monolog/Handler/ChromePHPHandler.php @@ -174,16 +174,14 @@ class ChromePHPHandler extends AbstractProcessingHandler /** * Verifies if the headers are accepted by the current user agent - * - * @return Boolean */ - protected function headersAccepted() + protected function headersAccepted(): bool { if (empty($_SERVER['HTTP_USER_AGENT'])) { return false; } - return preg_match(self::USER_AGENT_REGEX, $_SERVER['HTTP_USER_AGENT']); + return preg_match(self::USER_AGENT_REGEX, $_SERVER['HTTP_USER_AGENT']) === 1; } /** diff --git a/src/Monolog/Handler/FirePHPHandler.php b/src/Monolog/Handler/FirePHPHandler.php index 42c78f6..9a9acb5 100644 --- a/src/Monolog/Handler/FirePHPHandler.php +++ b/src/Monolog/Handler/FirePHPHandler.php @@ -61,7 +61,7 @@ class FirePHPHandler extends AbstractProcessingHandler * @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, $message) + protected function createHeader(array $meta, string $message): array { $header = sprintf('%s-%s', self::HEADER_PREFIX, join('-', $meta)); @@ -72,10 +72,8 @@ class FirePHPHandler extends AbstractProcessingHandler * Creates message header from record * * @see createHeader() - * @param array $record - * @return string */ - protected function createRecordHeader(array $record) + protected function createRecordHeader(array $record): array { // Wildfire is extensible to support multiple protocols & plugins in a single request, // but we're not taking advantage of that (yet), so we're using "1" for simplicity's sake. diff --git a/src/Monolog/Handler/FlowdockHandler.php b/src/Monolog/Handler/FlowdockHandler.php index b3fc9b4..c9e97cf 100644 --- a/src/Monolog/Handler/FlowdockHandler.php +++ b/src/Monolog/Handler/FlowdockHandler.php @@ -64,8 +64,6 @@ class FlowdockHandler extends SocketHandler /** * Gets the default formatter. - * - * @return FormatterInterface */ protected function getDefaultFormatter(): FormatterInterface { diff --git a/src/Monolog/Handler/GelfHandler.php b/src/Monolog/Handler/GelfHandler.php index 4a6c0f8..b5c3a8c 100644 --- a/src/Monolog/Handler/GelfHandler.php +++ b/src/Monolog/Handler/GelfHandler.php @@ -25,7 +25,7 @@ use Monolog\Formatter\FormatterInterface; class GelfHandler extends AbstractProcessingHandler { /** - * @var Publisher the publisher object that sends the message to the server + * @var PublisherInterface|null the publisher object that sends the message to the server */ protected $publisher; diff --git a/src/Monolog/Handler/ProcessHandler.php b/src/Monolog/Handler/ProcessHandler.php index 9c135f8..8cf6087 100644 --- a/src/Monolog/Handler/ProcessHandler.php +++ b/src/Monolog/Handler/ProcessHandler.php @@ -29,7 +29,7 @@ class ProcessHandler extends AbstractProcessingHandler /** * Holds the process to receive data on its STDIN. * - * @var resource + * @var resource|bool|null */ private $process; @@ -58,20 +58,20 @@ class ProcessHandler extends AbstractProcessingHandler ]; /** - * @param int $command Command for the process to start. Absolute paths are recommended, + * @param string $command Command for the process to start. Absolute paths are recommended, * especially if you do not use the $cwd parameter. - * @param bool|int $level The minimum logging level at which this handler will be triggered. - * @param bool|true $bubble Whether the messages that are handled can bubble up the stack or not. - * @param string|null $cwd "Current working directory" (CWD) for the process to be executed in. + * @param string|int $level The minimum logging level at which this handler will be triggered. + * @param bool $bubble Whether the messages that are handled can bubble up the stack or not. + * @param string $cwd "Current working directory" (CWD) for the process to be executed in. * @throws \InvalidArgumentException */ - public function __construct($command, $level = Logger::DEBUG, $bubble = true, $cwd = null) + public function __construct(string $command, $level = Logger::DEBUG, bool $bubble = true, string $cwd = null) { - if (empty($command) || is_string($command) === false) { + if ($command === '') { throw new \InvalidArgumentException('The command argument must be a non-empty string.'); } - if ($cwd !== null && (empty($cwd) || is_string($cwd) === false)) { - throw new \InvalidArgumentException('The optional CWD argument must be a non-empty string, if any.'); + if ($cwd === '') { + throw new \InvalidArgumentException('The optional CWD argument must be a non-empty string or null.'); } parent::__construct($level, $bubble); diff --git a/src/Monolog/Handler/RavenHandler.php b/src/Monolog/Handler/RavenHandler.php index 08d1e7a..3047e39 100644 --- a/src/Monolog/Handler/RavenHandler.php +++ b/src/Monolog/Handler/RavenHandler.php @@ -133,6 +133,7 @@ class RavenHandler extends AbstractProcessingHandler */ protected function write(array $record) { + /** @var bool|null|array This is false, unless set below to null or an array of data, when we read the current user context */ $previousUserContext = false; $options = []; $options['level'] = $this->logLevels[$record['level']]; @@ -186,7 +187,8 @@ class RavenHandler extends AbstractProcessingHandler $this->ravenClient->captureMessage($record['formatted'], [], $options); } - if ($previousUserContext !== false) { + // restore the user context if it was modified + if (!is_bool($previousUserContext)) { $this->ravenClient->user_context($previousUserContext); } } diff --git a/src/Monolog/Handler/RedisHandler.php b/src/Monolog/Handler/RedisHandler.php index f77d4fd..e7ddb44 100644 --- a/src/Monolog/Handler/RedisHandler.php +++ b/src/Monolog/Handler/RedisHandler.php @@ -37,9 +37,9 @@ class RedisHandler extends AbstractProcessingHandler * @param string $key The key name to push records to * @param int $level The minimum logging level at which this handler will be triggered * @param bool $bubble Whether the messages that are handled can bubble up the stack or not - * @param int $capSize Number of entries to limit list size to + * @param int $capSize Number of entries to limit list size to, 0 = unlimited */ - public function __construct($redis, $key, $level = Logger::DEBUG, $bubble = true, $capSize = false) + public function __construct($redis, string $key, $level = Logger::DEBUG, bool $bubble = true, int $capSize = 0) { if (!(($redis instanceof \Predis\Client) || ($redis instanceof \Redis))) { throw new \InvalidArgumentException('Predis\Client or Redis instance required'); diff --git a/src/Monolog/Handler/SocketHandler.php b/src/Monolog/Handler/SocketHandler.php index 06a2019..e2161ff 100644 --- a/src/Monolog/Handler/SocketHandler.php +++ b/src/Monolog/Handler/SocketHandler.php @@ -23,8 +23,11 @@ class SocketHandler extends AbstractProcessingHandler { private $connectionString; private $connectionTimeout; + /** @var resource|null */ private $resource; + /** @var float */ private $timeout = 0; + /** @var float */ private $writingTimeout = 10; private $lastSentBytes = null; private $persistent = false; @@ -149,20 +152,16 @@ class SocketHandler extends AbstractProcessingHandler /** * Get current connection timeout setting - * - * @return float */ - public function getConnectionTimeout() + public function getConnectionTimeout(): float { return $this->connectionTimeout; } /** * Get current in-transfer timeout - * - * @return float */ - public function getTimeout() + public function getTimeout(): float { return $this->timeout; } @@ -172,7 +171,7 @@ class SocketHandler extends AbstractProcessingHandler * * @return float */ - public function getWritingTimeout() + public function getWritingTimeout(): float { return $this->writingTimeout; } diff --git a/src/Monolog/Handler/StreamHandler.php b/src/Monolog/Handler/StreamHandler.php index 4a7433c..661e164 100644 --- a/src/Monolog/Handler/StreamHandler.php +++ b/src/Monolog/Handler/StreamHandler.php @@ -22,8 +22,10 @@ use Monolog\Logger; */ class StreamHandler extends AbstractProcessingHandler { + /** @var resource|null */ protected $stream; protected $url; + /** @var string|null */ private $errorMessage; protected $filePermission; protected $useLocking; diff --git a/src/Monolog/Handler/SyslogUdp/UdpSocket.php b/src/Monolog/Handler/SyslogUdp/UdpSocket.php index f54ac4e..0c703c8 100644 --- a/src/Monolog/Handler/SyslogUdp/UdpSocket.php +++ b/src/Monolog/Handler/SyslogUdp/UdpSocket.php @@ -17,6 +17,8 @@ class UdpSocket protected $ip; protected $port; + + /** @var resource|null */ protected $socket; public function __construct($ip, $port = 514) diff --git a/src/Monolog/Logger.php b/src/Monolog/Logger.php index c5a5c56..438c770 100644 --- a/src/Monolog/Logger.php +++ b/src/Monolog/Logger.php @@ -393,13 +393,12 @@ class Logger implements LoggerInterface * @param mixed $level The log level * @param string $message The log message * @param array $context The log context - * @return Boolean Whether the record has been processed */ public function log($level, $message, array $context = []) { $level = static::toMonologLevel($level); - return $this->addRecord($level, (string) $message, $context); + $this->addRecord($level, (string) $message, $context); } /** @@ -409,11 +408,10 @@ class Logger implements LoggerInterface * * @param string $message The log message * @param array $context The log context - * @return Boolean Whether the record has been processed */ public function debug($message, array $context = []) { - return $this->addRecord(static::DEBUG, (string) $message, $context); + $this->addRecord(static::DEBUG, (string) $message, $context); } /** @@ -423,11 +421,10 @@ class Logger implements LoggerInterface * * @param string $message The log message * @param array $context The log context - * @return Boolean Whether the record has been processed */ public function info($message, array $context = []) { - return $this->addRecord(static::INFO, (string) $message, $context); + $this->addRecord(static::INFO, (string) $message, $context); } /** @@ -437,11 +434,10 @@ class Logger implements LoggerInterface * * @param string $message The log message * @param array $context The log context - * @return Boolean Whether the record has been processed */ public function notice($message, array $context = []) { - return $this->addRecord(static::NOTICE, (string) $message, $context); + $this->addRecord(static::NOTICE, (string) $message, $context); } /** @@ -451,11 +447,10 @@ class Logger implements LoggerInterface * * @param string $message The log message * @param array $context The log context - * @return Boolean Whether the record has been processed */ public function warning($message, array $context = []) { - return $this->addRecord(static::WARNING, (string) $message, $context); + $this->addRecord(static::WARNING, (string) $message, $context); } /** @@ -465,11 +460,10 @@ class Logger implements LoggerInterface * * @param string $message The log message * @param array $context The log context - * @return Boolean Whether the record has been processed */ public function error($message, array $context = []) { - return $this->addRecord(static::ERROR, (string) $message, $context); + $this->addRecord(static::ERROR, (string) $message, $context); } /** @@ -479,11 +473,10 @@ class Logger implements LoggerInterface * * @param string $message The log message * @param array $context The log context - * @return Boolean Whether the record has been processed */ public function critical($message, array $context = []) { - return $this->addRecord(static::CRITICAL, (string) $message, $context); + $this->addRecord(static::CRITICAL, (string) $message, $context); } /** @@ -493,11 +486,10 @@ class Logger implements LoggerInterface * * @param string $message The log message * @param array $context The log context - * @return Boolean Whether the record has been processed */ public function alert($message, array $context = []) { - return $this->addRecord(static::ALERT, (string) $message, $context); + $this->addRecord(static::ALERT, (string) $message, $context); } /** @@ -507,11 +499,10 @@ class Logger implements LoggerInterface * * @param string $message The log message * @param array $context The log context - * @return Boolean Whether the record has been processed */ public function emergency($message, array $context = []) { - return $this->addRecord(static::EMERGENCY, (string) $message, $context); + $this->addRecord(static::EMERGENCY, (string) $message, $context); } /** diff --git a/src/Monolog/Processor/MercurialProcessor.php b/src/Monolog/Processor/MercurialProcessor.php index 2848c13..72ce6ca 100644 --- a/src/Monolog/Processor/MercurialProcessor.php +++ b/src/Monolog/Processor/MercurialProcessor.php @@ -28,7 +28,7 @@ class MercurialProcessor $this->level = Logger::toMonologLevel($level); } - public function __invoke(array $record): arra + public function __invoke(array $record): array { // return if the level is not high enough if ($record['level'] < $this->level) { diff --git a/src/Monolog/Test/TestCase.php b/src/Monolog/Test/TestCase.php index 4ac9172..32a0b23 100644 --- a/src/Monolog/Test/TestCase.php +++ b/src/Monolog/Test/TestCase.php @@ -13,6 +13,7 @@ namespace Monolog\Test; use Monolog\Logger; use Monolog\DateTimeImmutable; +use Monolog\Formatter\FormatterInterface; /** * Lets you easily generate log records and a dummy formatter for testing purposes @@ -51,12 +52,9 @@ class TestCase extends \PHPUnit_Framework_TestCase ]; } - /** - * @return Monolog\Formatter\FormatterInterface - */ - protected function getIdentityFormatter() + protected function getIdentityFormatter(): FormatterInterface { - $formatter = $this->createMock('Monolog\\Formatter\\FormatterInterface'); + $formatter = $this->createMock(FormatterInterface::class); $formatter->expects($this->any()) ->method('format') ->will($this->returnCallback(function ($record) { |