Merge pull request #13480 from Raroun/fix_13457

[friendica.git] / src / Core / Logger.php

diff --git a/src/Core/Logger.php b/src/Core/Logger.php
index 2a62e5513f60424fb1d6dd38f24ec01d9b20a5b8..db809904bcb0dc7e9e0caacd02847c360ae4c6a9 100644 (file)
--- a/src/Core/Logger.php
+++ b/src/Core/Logger.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * @copyright Copyright (C) 2010-2022, the Friendica project
+ * @copyright Copyright (C) 2010-2023, the Friendica project
  *
  * @license GNU AGPL version 3 or any later version
  *
@@ -36,7 +36,7 @@ class Logger
         */
        const TYPE_LOGGER = LoggerInterface::class;
        /**
-        * @var WorkerLogger A specific worker logger type, which can be anabled
+        * @var WorkerLogger A specific worker logger type, which can be enabled
         */
        const TYPE_WORKER = WorkerLogger::class;
        /**
@@ -47,7 +47,7 @@ class Logger
        /**
         * @return LoggerInterface
         */
-       private static function getWorker()
+       private static function getInstance()
        {
                if (self::$type === self::TYPE_LOGGER) {
                        return DI::logger();
@@ -66,7 +66,7 @@ class Logger
        public static function enableWorker(string $functionName)
        {
                self::$type = self::TYPE_WORKER;
-               self::getWorker()->setFunctionName($functionName);
+               self::getInstance()->setFunctionName($functionName);
        }
 
        /**
@@ -82,15 +82,14 @@ class Logger
         *
         * @see LoggerInterface::emergency()
         *
-        * @param string $message
-        * @param array  $context
-        *
+        * @param string $message Message to log
+        * @param array  $context Optional variables
         * @return void
         * @throws \Exception
         */
-       public static function emergency($message, $context = [])
+       public static function emergency(string $message, array $context = [])
        {
-               self::getWorker()->emergency($message, $context);
+               self::getInstance()->emergency($message, $context);
        }
 
        /**
@@ -100,15 +99,14 @@ class Logger
         * Example: Entire website down, database unavailable, etc. This should
         * trigger the SMS alerts and wake you up.
         *
-        * @param string $message
-        * @param array  $context
-        *
+        * @param string $message Message to log
+        * @param array  $context Optional variables
         * @return void
         * @throws \Exception
         */
-       public static function alert($message, $context = [])
+       public static function alert(string $message, array $context = [])
        {
-               self::getWorker()->alert($message, $context);
+               self::getInstance()->alert($message, $context);
        }
 
        /**
@@ -117,15 +115,14 @@ class Logger
         *
         * Example: Application component unavailable, unexpected exception.
         *
-        * @param string $message
-        * @param array  $context
-        *
+        * @param string $message Message to log
+        * @param array  $context Optional variables
         * @return void
         * @throws \Exception
         */
-       public static function critical($message, $context = [])
+       public static function critical(string $message, array $context = [])
        {
-               self::getWorker()->critical($message, $context);
+               self::getInstance()->critical($message, $context);
        }
 
        /**
@@ -133,15 +130,14 @@ class Logger
         * be logged and monitored.
         * @see LoggerInterface::error()
         *
-        * @param string $message
-        * @param array  $context
-        *
+        * @param string $message Message to log
+        * @param array  $context Optional variables
         * @return void
         * @throws \Exception
         */
-       public static function error($message, $context = [])
+       public static function error(string $message, array $context = [])
        {
-               self::getWorker()->error($message, $context);
+               self::getInstance()->error($message, $context);
        }
 
        /**
@@ -151,30 +147,28 @@ class Logger
         * Example: Use of deprecated APIs, poor use of an API, undesirable things
         * that are not necessarily wrong.
         *
-        * @param string $message
-        * @param array  $context
-        *
+        * @param string $message Message to log
+        * @param array  $context Optional variables
         * @return void
         * @throws \Exception
         */
-       public static function warning($message, $context = [])
+       public static function warning(string $message, array $context = [])
        {
-               self::getWorker()->warning($message, $context);
+               self::getInstance()->warning($message, $context);
        }
 
        /**
         * Normal but significant events.
         * @see LoggerInterface::notice()
         *
-        * @param string $message
-        * @param array  $context
-        *
+        * @param string $message Message to log
+        * @param array  $context Optional variables
         * @return void
         * @throws \Exception
         */
-       public static function notice($message, $context = [])
+       public static function notice(string $message, array $context = [])
        {
-               self::getWorker()->notice($message, $context);
+               self::getInstance()->notice($message, $context);
        }
 
        /**
@@ -189,39 +183,39 @@ class Logger
         * @return void
         * @throws \Exception
         */
-       public static function info($message, $context = [])
+       public static function info(string $message, array $context = [])
        {
-               self::getWorker()->info($message, $context);
+               self::getInstance()->info($message, $context);
        }
 
        /**
         * Detailed debug information.
         * @see LoggerInterface::debug()
         *
-        * @param string $message
-        * @param array  $context
-        *
+        * @param string $message Message to log
+        * @param array  $context Optional variables
         * @return void
         * @throws \Exception
         */
-       public static function debug($message, $context = [])
+       public static function debug(string $message, array $context = [])
        {
-               self::getWorker()->debug($message, $context);
+               self::getInstance()->debug($message, $context);
        }
 
        /**
         * An alternative logger for development.
         *
         * Works largely as log() but allows developers
-        * to isolate particular elements they are targetting
+        * to isolate particular elements they are targeting
         * personally without background noise
         *
-        * @param string $msg
-        * @param string $level
+        * @param string $message Message to log
+        * @param string $level Logging level
+        * @return void
         * @throws \Exception
         */
-       public static function devLog($msg, $level = LogLevel::DEBUG)
+       public static function devLog(string $message, string $level = LogLevel::DEBUG)
        {
-               DI::devLogger()->log($level, $msg);
+               DI::devLogger()->log($level, $message);
        }
 }