Merge pull request #21875 from nextcloud/techdebt/deprecate-ilogger

Deprecate ILogger in favor of the PSR-3 logger

2 files changed, 52 insertions, 0 deletions

diff --git a/lib/private/AppFramework/Logger.php b/lib/private/AppFramework/Logger.php
index 94b79139b82..062a705efc4 100644
--- a/lib/private/AppFramework/Logger.php
+++ b/lib/private/AppFramework/Logger.php
@@ -28,6 +28,9 @@ namespace OC\AppFramework;
 
 use OCP\ILogger;
 
+/**
+ * @deprecated
+ */
 class Logger implements ILogger {
 
 	/** @var ILogger */
@@ -36,6 +39,9 @@ class Logger implements ILogger {
 	/** @var string */
 	private $appName;
 
+	/**
+	 * @deprecated
+	 */
 	public function __construct(ILogger $logger, string $appName) {
 		$this->logger = $logger;
 		$this->appName = $appName;
@@ -49,42 +55,72 @@ class Logger implements ILogger {
 		return $context;
 	}
 
+	/**
+	 * @deprecated
+	 */
 	public function emergency(string $message, array $context = []) {
 		$this->logger->emergency($message, $this->extendContext($context));
 	}
 
+	/**
+	 * @deprecated
+	 */
 	public function alert(string $message, array $context = []) {
 		$this->logger->alert($message, $this->extendContext($context));
 	}
 
+	/**
+	 * @deprecated
+	 */
 	public function critical(string $message, array $context = []) {
 		$this->logger->critical($message, $this->extendContext($context));
 	}
 
+	/**
+	 * @deprecated
+	 */
 	public function error(string $message, array $context = []) {
 		$this->logger->emergency($message, $this->extendContext($context));
 	}
 
+	/**
+	 * @deprecated
+	 */
 	public function warning(string $message, array $context = []) {
 		$this->logger->warning($message, $this->extendContext($context));
 	}
 
+	/**
+	 * @deprecated
+	 */
 	public function notice(string $message, array $context = []) {
 		$this->logger->notice($message, $this->extendContext($context));
 	}
 
+	/**
+	 * @deprecated
+	 */
 	public function info(string $message, array $context = []) {
 		$this->logger->info($message, $this->extendContext($context));
 	}
 
+	/**
+	 * @deprecated
+	 */
 	public function debug(string $message, array $context = []) {
 		$this->logger->debug($message, $this->extendContext($context));
 	}
 
+	/**
+	 * @deprecated
+	 */
 	public function log(int $level, string $message, array $context = []) {
 		$this->logger->log($level, $message, $this->extendContext($context));
 	}
 
+	/**
+	 * @deprecated
+	 */
 	public function logException(\Throwable $exception, array $context = []) {
 		$this->logger->logException($exception, $this->extendContext($context));
 	}
diff --git a/lib/public/ILogger.php b/lib/public/ILogger.php
index 067e4152115..dc0bf7b0dd7 100644
--- a/lib/public/ILogger.php
+++ b/lib/public/ILogger.php
@@ -39,26 +39,32 @@ namespace OCP;
  *
  * This logger interface follows the design guidelines of PSR-3
  * https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-3-logger-interface.md#3-psrlogloggerinterface
+ * @deprecated 20.0.0 use the PSR-3 logger \Psr\Log\LoggerInterface
  */
 interface ILogger {
 	/**
 	 * @since 14.0.0
+	 * @deprecated 20.0.0
 	 */
 	public const DEBUG=0;
 	/**
 	 * @since 14.0.0
+	 * @deprecated 20.0.0
 	 */
 	public const INFO=1;
 	/**
 	 * @since 14.0.0
+	 * @deprecated 20.0.0
 	 */
 	public const WARN=2;
 	/**
 	 * @since 14.0.0
+	 * @deprecated 20.0.0
 	 */
 	public const ERROR=3;
 	/**
 	 * @since 14.0.0
+	 * @deprecated 20.0.0
 	 */
 	public const FATAL=4;
 
@@ -69,6 +75,7 @@ interface ILogger {
 	 * @param array $context
 	 * @return null
 	 * @since 7.0.0
+	 * @deprecated 20.0.0 use \Psr\Log\LoggerInterface::emergency
 	 */
 	public function emergency(string $message, array $context = []);
 
@@ -79,6 +86,7 @@ interface ILogger {
 	 * @param array $context
 	 * @return null
 	 * @since 7.0.0
+	 * @deprecated 20.0.0 use \Psr\Log\LoggerInterface::alert
 	 */
 	public function alert(string $message, array $context = []);
 
@@ -89,6 +97,7 @@ interface ILogger {
 	 * @param array $context
 	 * @return null
 	 * @since 7.0.0
+	 * @deprecated 20.0.0 use \Psr\Log\LoggerInterface::critical
 	 */
 	public function critical(string $message, array $context = []);
 
@@ -100,6 +109,7 @@ interface ILogger {
 	 * @param array $context
 	 * @return null
 	 * @since 7.0.0
+	 * @deprecated 20.0.0 use \Psr\Log\LoggerInterface::error
 	 */
 	public function error(string $message, array $context = []);
 
@@ -110,6 +120,7 @@ interface ILogger {
 	 * @param array $context
 	 * @return null
 	 * @since 7.0.0
+	 * @deprecated 20.0.0 use \Psr\Log\LoggerInterface::warning
 	 */
 	public function warning(string $message, array $context = []);
 
@@ -120,6 +131,7 @@ interface ILogger {
 	 * @param array $context
 	 * @return null
 	 * @since 7.0.0
+	 * @deprecated 20.0.0 use \Psr\Log\LoggerInterface::notice
 	 */
 	public function notice(string $message, array $context = []);
 
@@ -130,6 +142,7 @@ interface ILogger {
 	 * @param array $context
 	 * @return null
 	 * @since 7.0.0
+	 * @deprecated 20.0.0 use \Psr\Log\LoggerInterface::info
 	 */
 	public function info(string $message, array $context = []);
 
@@ -140,6 +153,7 @@ interface ILogger {
 	 * @param array $context
 	 * @return null
 	 * @since 7.0.0
+	 * @deprecated 20.0.0 use \Psr\Log\LoggerInterface::debug
 	 */
 	public function debug(string $message, array $context = []);
 
@@ -151,6 +165,7 @@ interface ILogger {
 	 * @param array $context
 	 * @return mixed
 	 * @since 7.0.0
+	 * @deprecated 20.0.0 use \Psr\Log\LoggerInterface::log
 	 */
 	public function log(int $level, string $message, array $context = []);
 
@@ -169,6 +184,7 @@ interface ILogger {
 	 * @param array $context
 	 * @return void
 	 * @since 8.2.0
+	 * @deprecated 20.0.0 use the `exception` entry in the context of any method in \Psr\Log\LoggerInterface
 	 */
 	public function logException(\Throwable $exception, array $context = []);
 }