You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
169 lines
3.7 KiB
169 lines
3.7 KiB
<?php |
|
declare(strict_types=1); |
|
/** |
|
* @copyright Copyright (c) 2016, ownCloud, Inc. |
|
* |
|
* @author Bernhard Posselt <dev@bernhard-posselt.com> |
|
* @author Jan-Christoph Borchardt <hey@jancborchardt.net> |
|
* @author Lukas Reschke <lukas@statuscode.ch> |
|
* @author Morris Jobke <hey@morrisjobke.de> |
|
* @author Thomas Müller <thomas.mueller@tmit.eu> |
|
* |
|
* @license AGPL-3.0 |
|
* |
|
* This code is free software: you can redistribute it and/or modify |
|
* it under the terms of the GNU Affero General Public License, version 3, |
|
* as published by the Free Software Foundation. |
|
* |
|
* This program is distributed in the hope that it will be useful, |
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|
* GNU Affero General Public License for more details. |
|
* |
|
* You should have received a copy of the GNU Affero General Public License, version 3, |
|
* along with this program. If not, see <http://www.gnu.org/licenses/> |
|
* |
|
*/ |
|
|
|
namespace OCP; |
|
|
|
/** |
|
* Interface ILogger |
|
* @package OCP |
|
* @since 7.0.0 |
|
* |
|
* 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 |
|
*/ |
|
interface ILogger { |
|
/** |
|
* @since 14.0.0 |
|
*/ |
|
const DEBUG=0; |
|
/** |
|
* @since 14.0.0 |
|
*/ |
|
const INFO=1; |
|
/** |
|
* @since 14.0.0 |
|
*/ |
|
const WARN=2; |
|
/** |
|
* @since 14.0.0 |
|
*/ |
|
const ERROR=3; |
|
/** |
|
* @since 14.0.0 |
|
*/ |
|
const FATAL=4; |
|
|
|
/** |
|
* System is unusable. |
|
* |
|
* @param string $message |
|
* @param array $context |
|
* @return null |
|
* @since 7.0.0 |
|
*/ |
|
public function emergency(string $message, array $context = []); |
|
|
|
/** |
|
* Action must be taken immediately. |
|
* |
|
* @param string $message |
|
* @param array $context |
|
* @return null |
|
* @since 7.0.0 |
|
*/ |
|
public function alert(string $message, array $context = []); |
|
|
|
/** |
|
* Critical conditions. |
|
* |
|
* @param string $message |
|
* @param array $context |
|
* @return null |
|
* @since 7.0.0 |
|
*/ |
|
public function critical(string $message, array $context = []); |
|
|
|
/** |
|
* Runtime errors that do not require immediate action but should typically |
|
* be logged and monitored. |
|
* |
|
* @param string $message |
|
* @param array $context |
|
* @return null |
|
* @since 7.0.0 |
|
*/ |
|
public function error(string $message, array $context = []); |
|
|
|
/** |
|
* Exceptional occurrences that are not errors. |
|
* |
|
* @param string $message |
|
* @param array $context |
|
* @return null |
|
* @since 7.0.0 |
|
*/ |
|
public function warning(string $message, array $context = []); |
|
|
|
/** |
|
* Normal but significant events. |
|
* |
|
* @param string $message |
|
* @param array $context |
|
* @return null |
|
* @since 7.0.0 |
|
*/ |
|
public function notice(string $message, array $context = []); |
|
|
|
/** |
|
* Interesting events. |
|
* |
|
* @param string $message |
|
* @param array $context |
|
* @return null |
|
* @since 7.0.0 |
|
*/ |
|
public function info(string $message, array $context = []); |
|
|
|
/** |
|
* Detailed debug information. |
|
* |
|
* @param string $message |
|
* @param array $context |
|
* @return null |
|
* @since 7.0.0 |
|
*/ |
|
public function debug(string $message, array $context = []); |
|
|
|
/** |
|
* Logs with an arbitrary level. |
|
* |
|
* @param int $level |
|
* @param string $message |
|
* @param array $context |
|
* @return mixed |
|
* @since 7.0.0 |
|
*/ |
|
public function log(int $level, string $message, array $context = []); |
|
|
|
/** |
|
* Logs an exception very detailed |
|
* An additional message can we written to the log by adding it to the |
|
* context. |
|
* |
|
* <code> |
|
* $logger->logException($ex, [ |
|
* 'message' => 'Exception during background job execution' |
|
* ]); |
|
* </code> |
|
* |
|
* @param \Exception|\Throwable $exception |
|
* @param array $context |
|
* @return void |
|
* @since 8.2.0 |
|
*/ |
|
public function logException(\Throwable $exception, array $context = []); |
|
}
|
|
|