Deprecate ILogger
The logger service was always intended to follow the PSR-3 interface. It's time to embrace this and switch over to the "official" API, hence this custom interface can be slowly phased out. With Nextcloud 20 the logger also got support for * App id filled out automatically * Exceptions handling (as replacement for logException) Signed-off-by: Christoph Wurst <christoph@winzerhof-wurst.at>
This commit is contained in:
parent
684a7200ac
commit
8a433a7226
|
@ -28,6 +28,9 @@ namespace OC\AppFramework;
|
||||||
|
|
||||||
use OCP\ILogger;
|
use OCP\ILogger;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @deprecated
|
||||||
|
*/
|
||||||
class Logger implements ILogger {
|
class Logger implements ILogger {
|
||||||
|
|
||||||
/** @var ILogger */
|
/** @var ILogger */
|
||||||
|
@ -36,6 +39,9 @@ class Logger implements ILogger {
|
||||||
/** @var string */
|
/** @var string */
|
||||||
private $appName;
|
private $appName;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @deprecated
|
||||||
|
*/
|
||||||
public function __construct(ILogger $logger, string $appName) {
|
public function __construct(ILogger $logger, string $appName) {
|
||||||
$this->logger = $logger;
|
$this->logger = $logger;
|
||||||
$this->appName = $appName;
|
$this->appName = $appName;
|
||||||
|
@ -49,42 +55,72 @@ class Logger implements ILogger {
|
||||||
return $context;
|
return $context;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @deprecated
|
||||||
|
*/
|
||||||
public function emergency(string $message, array $context = []) {
|
public function emergency(string $message, array $context = []) {
|
||||||
$this->logger->emergency($message, $this->extendContext($context));
|
$this->logger->emergency($message, $this->extendContext($context));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @deprecated
|
||||||
|
*/
|
||||||
public function alert(string $message, array $context = []) {
|
public function alert(string $message, array $context = []) {
|
||||||
$this->logger->alert($message, $this->extendContext($context));
|
$this->logger->alert($message, $this->extendContext($context));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @deprecated
|
||||||
|
*/
|
||||||
public function critical(string $message, array $context = []) {
|
public function critical(string $message, array $context = []) {
|
||||||
$this->logger->critical($message, $this->extendContext($context));
|
$this->logger->critical($message, $this->extendContext($context));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @deprecated
|
||||||
|
*/
|
||||||
public function error(string $message, array $context = []) {
|
public function error(string $message, array $context = []) {
|
||||||
$this->logger->emergency($message, $this->extendContext($context));
|
$this->logger->emergency($message, $this->extendContext($context));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @deprecated
|
||||||
|
*/
|
||||||
public function warning(string $message, array $context = []) {
|
public function warning(string $message, array $context = []) {
|
||||||
$this->logger->warning($message, $this->extendContext($context));
|
$this->logger->warning($message, $this->extendContext($context));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @deprecated
|
||||||
|
*/
|
||||||
public function notice(string $message, array $context = []) {
|
public function notice(string $message, array $context = []) {
|
||||||
$this->logger->notice($message, $this->extendContext($context));
|
$this->logger->notice($message, $this->extendContext($context));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @deprecated
|
||||||
|
*/
|
||||||
public function info(string $message, array $context = []) {
|
public function info(string $message, array $context = []) {
|
||||||
$this->logger->info($message, $this->extendContext($context));
|
$this->logger->info($message, $this->extendContext($context));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @deprecated
|
||||||
|
*/
|
||||||
public function debug(string $message, array $context = []) {
|
public function debug(string $message, array $context = []) {
|
||||||
$this->logger->debug($message, $this->extendContext($context));
|
$this->logger->debug($message, $this->extendContext($context));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @deprecated
|
||||||
|
*/
|
||||||
public function log(int $level, string $message, array $context = []) {
|
public function log(int $level, string $message, array $context = []) {
|
||||||
$this->logger->log($level, $message, $this->extendContext($context));
|
$this->logger->log($level, $message, $this->extendContext($context));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @deprecated
|
||||||
|
*/
|
||||||
public function logException(\Throwable $exception, array $context = []) {
|
public function logException(\Throwable $exception, array $context = []) {
|
||||||
$this->logger->logException($exception, $this->extendContext($context));
|
$this->logger->logException($exception, $this->extendContext($context));
|
||||||
}
|
}
|
||||||
|
|
|
@ -39,26 +39,32 @@ namespace OCP;
|
||||||
*
|
*
|
||||||
* This logger interface follows the design guidelines of PSR-3
|
* 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
|
* 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 {
|
interface ILogger {
|
||||||
/**
|
/**
|
||||||
* @since 14.0.0
|
* @since 14.0.0
|
||||||
|
* @deprecated 20.0.0
|
||||||
*/
|
*/
|
||||||
public const DEBUG=0;
|
public const DEBUG=0;
|
||||||
/**
|
/**
|
||||||
* @since 14.0.0
|
* @since 14.0.0
|
||||||
|
* @deprecated 20.0.0
|
||||||
*/
|
*/
|
||||||
public const INFO=1;
|
public const INFO=1;
|
||||||
/**
|
/**
|
||||||
* @since 14.0.0
|
* @since 14.0.0
|
||||||
|
* @deprecated 20.0.0
|
||||||
*/
|
*/
|
||||||
public const WARN=2;
|
public const WARN=2;
|
||||||
/**
|
/**
|
||||||
* @since 14.0.0
|
* @since 14.0.0
|
||||||
|
* @deprecated 20.0.0
|
||||||
*/
|
*/
|
||||||
public const ERROR=3;
|
public const ERROR=3;
|
||||||
/**
|
/**
|
||||||
* @since 14.0.0
|
* @since 14.0.0
|
||||||
|
* @deprecated 20.0.0
|
||||||
*/
|
*/
|
||||||
public const FATAL=4;
|
public const FATAL=4;
|
||||||
|
|
||||||
|
@ -69,6 +75,7 @@ interface ILogger {
|
||||||
* @param array $context
|
* @param array $context
|
||||||
* @return null
|
* @return null
|
||||||
* @since 7.0.0
|
* @since 7.0.0
|
||||||
|
* @deprecated 20.0.0 use \Psr\Log\LoggerInterface::emergency
|
||||||
*/
|
*/
|
||||||
public function emergency(string $message, array $context = []);
|
public function emergency(string $message, array $context = []);
|
||||||
|
|
||||||
|
@ -79,6 +86,7 @@ interface ILogger {
|
||||||
* @param array $context
|
* @param array $context
|
||||||
* @return null
|
* @return null
|
||||||
* @since 7.0.0
|
* @since 7.0.0
|
||||||
|
* @deprecated 20.0.0 use \Psr\Log\LoggerInterface::alert
|
||||||
*/
|
*/
|
||||||
public function alert(string $message, array $context = []);
|
public function alert(string $message, array $context = []);
|
||||||
|
|
||||||
|
@ -89,6 +97,7 @@ interface ILogger {
|
||||||
* @param array $context
|
* @param array $context
|
||||||
* @return null
|
* @return null
|
||||||
* @since 7.0.0
|
* @since 7.0.0
|
||||||
|
* @deprecated 20.0.0 use \Psr\Log\LoggerInterface::critical
|
||||||
*/
|
*/
|
||||||
public function critical(string $message, array $context = []);
|
public function critical(string $message, array $context = []);
|
||||||
|
|
||||||
|
@ -100,6 +109,7 @@ interface ILogger {
|
||||||
* @param array $context
|
* @param array $context
|
||||||
* @return null
|
* @return null
|
||||||
* @since 7.0.0
|
* @since 7.0.0
|
||||||
|
* @deprecated 20.0.0 use \Psr\Log\LoggerInterface::error
|
||||||
*/
|
*/
|
||||||
public function error(string $message, array $context = []);
|
public function error(string $message, array $context = []);
|
||||||
|
|
||||||
|
@ -110,6 +120,7 @@ interface ILogger {
|
||||||
* @param array $context
|
* @param array $context
|
||||||
* @return null
|
* @return null
|
||||||
* @since 7.0.0
|
* @since 7.0.0
|
||||||
|
* @deprecated 20.0.0 use \Psr\Log\LoggerInterface::warning
|
||||||
*/
|
*/
|
||||||
public function warning(string $message, array $context = []);
|
public function warning(string $message, array $context = []);
|
||||||
|
|
||||||
|
@ -120,6 +131,7 @@ interface ILogger {
|
||||||
* @param array $context
|
* @param array $context
|
||||||
* @return null
|
* @return null
|
||||||
* @since 7.0.0
|
* @since 7.0.0
|
||||||
|
* @deprecated 20.0.0 use \Psr\Log\LoggerInterface::notice
|
||||||
*/
|
*/
|
||||||
public function notice(string $message, array $context = []);
|
public function notice(string $message, array $context = []);
|
||||||
|
|
||||||
|
@ -130,6 +142,7 @@ interface ILogger {
|
||||||
* @param array $context
|
* @param array $context
|
||||||
* @return null
|
* @return null
|
||||||
* @since 7.0.0
|
* @since 7.0.0
|
||||||
|
* @deprecated 20.0.0 use \Psr\Log\LoggerInterface::info
|
||||||
*/
|
*/
|
||||||
public function info(string $message, array $context = []);
|
public function info(string $message, array $context = []);
|
||||||
|
|
||||||
|
@ -140,6 +153,7 @@ interface ILogger {
|
||||||
* @param array $context
|
* @param array $context
|
||||||
* @return null
|
* @return null
|
||||||
* @since 7.0.0
|
* @since 7.0.0
|
||||||
|
* @deprecated 20.0.0 use \Psr\Log\LoggerInterface::debug
|
||||||
*/
|
*/
|
||||||
public function debug(string $message, array $context = []);
|
public function debug(string $message, array $context = []);
|
||||||
|
|
||||||
|
@ -151,6 +165,7 @@ interface ILogger {
|
||||||
* @param array $context
|
* @param array $context
|
||||||
* @return mixed
|
* @return mixed
|
||||||
* @since 7.0.0
|
* @since 7.0.0
|
||||||
|
* @deprecated 20.0.0 use \Psr\Log\LoggerInterface::log
|
||||||
*/
|
*/
|
||||||
public function log(int $level, string $message, array $context = []);
|
public function log(int $level, string $message, array $context = []);
|
||||||
|
|
||||||
|
@ -169,6 +184,7 @@ interface ILogger {
|
||||||
* @param array $context
|
* @param array $context
|
||||||
* @return void
|
* @return void
|
||||||
* @since 8.2.0
|
* @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 = []);
|
public function logException(\Throwable $exception, array $context = []);
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in New Issue