From caa286acef1809b0afe7a78e90eeb3434202cdac Mon Sep 17 00:00:00 2001 From: Vasil Rangelov Date: Wed, 30 Mar 2022 10:25:18 +0300 Subject: [PATCH] Fixed doc comments of logger, and added type hints where applicable. --- src/Logging/ConsoleLogger.php | 2 +- src/Logging/Logger.php | 79 ++++++++++++++++++----------------- 2 files changed, 41 insertions(+), 40 deletions(-) diff --git a/src/Logging/ConsoleLogger.php b/src/Logging/ConsoleLogger.php index 3fe2c66..391daed 100644 --- a/src/Logging/ConsoleLogger.php +++ b/src/Logging/ConsoleLogger.php @@ -17,7 +17,7 @@ class ConsoleLogger extends AbstractLogger * @param mixed $level * @param string $message * @param array $context - * @return null + * @return void */ public function log($level, $message, array $context = []) : void { diff --git a/src/Logging/Logger.php b/src/Logging/Logger.php index ecca609..b9fd92d 100644 --- a/src/Logging/Logger.php +++ b/src/Logging/Logger.php @@ -15,20 +15,21 @@ class Logger /** * @param LoggerInterface $logger + * @return void */ - public static function set(LoggerInterface $logger) + public static function set(LoggerInterface $logger): void { static::$logger = $logger; } /** - * @param null $object - * @param $level - * @param $message + * @param null|object $object + * @param mixed $level + * @param mixed $message * @param array $context - * @return null + * @return void */ - public static function log($object, $level, $message, $context = []) + public static function log($object, $level, $message, array $context = []): void { if (is_object($object)) { $className = get_class($object); @@ -44,96 +45,96 @@ public static function log($object, $level, $message, $context = []) } /** - * @param null $object - * @param null $object - * @param $message + * @param null|object $object + * @param mixed $message * @param array $context - * @return null + * @return void */ - public static function alert($object, $message, $context = []) + public static function alert($object, $message, array $context = []): void { static::log($object, LogLevel::ALERT, $message, $context); } /** - * @param null $object - * @param $message + * @param null|object $object + * @param mixed $message * @param array $context - * @return null + * @return void */ - public static function critical($object, $message, $context = []) + public static function critical($object, $message, array $context = []): void { static::log($object, LogLevel::CRITICAL, $message, $context); } /** - * @param null $object - * @param $message + * @param null|object $object + * @param mixed $message * @param array $context - * @return null + * @return void */ - public static function debug($object, $message, $context = []) + public static function debug($object, $message, array $context = []): void { static::log($object, LogLevel::DEBUG, $message, $context); } /** - * @param null $object - * @param $message + * @param null|object $object + * @param mixed $message * @param array $context - * @return null + * @return void */ - public static function emergency($object, $message, $context = []) + public static function emergency($object, $message, array $context = []): void { static::log($object, LogLevel::EMERGENCY, $message, $context); } /** - * @param null $object - * @param $message + * @param null|object $object + * @param mixed $message * @param array $context - * @return null + * @return void */ - public static function error($object, $message, $context = []) + public static function error($object, $message, array $context = []): void { static::log($object, LogLevel::ERROR, $message, $context); } /** - * @param null $object - * @param $message + * @param null|object $object + * @param mixed $message * @param array $context - * @return null + * @return void */ - public static function info($object, $message, $context = []) + public static function info($object, $message, array $context = []): void { static::log($object, LogLevel::INFO, $message, $context); } /** - * @param null $object - * @param $message + * @param null|object $object + * @param mixed $message * @param array $context - * @return null + * @return void */ - public static function notice($object, $message, $context = []) + public static function notice($object, $message, array $context = []): void { static::log($object, LogLevel::NOTICE, $message, $context); } /** - * @param $message + * @param null|object $object + * @param mixed $message * @param array $context - * @return null + * @return void */ - public static function warning($object, $message, $context = []) + public static function warning($object, $message, array $context = []): void { static::log($object, LogLevel::WARNING, $message, $context); } /** * Protected constructor to prevent creating a new instance of the - * *Singleton* via the `new` operator from outside of this class. + * *Singleton* via the `new` operator from outside this class. */ protected function __construct() {