116 lines
2.8 KiB
PHP
116 lines
2.8 KiB
PHP
|
<?php
|
||
|
|
|
||
|
|
if (!defined('ABSPATH')) die('No direct access allowed');
|
||
|
|
|
||
|
|
if (class_exists('Updraft_Logger_Interface')) return false;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Describes a logger instance
|
||
|
|
*
|
||
|
|
* The message MUST be a string or object implementing __toString().
|
||
|
|
*
|
||
|
|
* The message MAY contain placeholders in the form: {foo} where foo
|
||
|
|
* will be replaced by the context data in key "foo".
|
||
|
|
*
|
||
|
|
* The context array can contain arbitrary data, the only assumption that
|
||
|
|
* can be made by implementors is that if an Exception instance is given
|
||
|
|
* to produce a stack trace, it MUST be in a key named "exception".
|
||
|
|
*
|
||
|
|
* See https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-3-logger-interface.md
|
||
|
|
* for the full interface specification.
|
||
|
|
*/
|
||
|
|
interface Updraft_Logger_Interface {
|
||
|
|
/**
|
||
|
|
* System is unusable.
|
||
|
|
*
|
||
|
|
* @param string $message
|
||
|
|
* @param array $context
|
||
|
|
* @return null
|
||
|
|
*/
|
||
|
|
public function emergency($message, array $context = array());
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Action must be taken immediately.
|
||
|
|
*
|
||
|
|
* Example: Entire website down, database unavailable, etc. This should
|
||
|
|
* trigger the SMS alerts and wake you up.
|
||
|
|
*
|
||
|
|
* @param string $message
|
||
|
|
* @param array $context
|
||
|
|
* @return null
|
||
|
|
*/
|
||
|
|
public function alert($message, array $context = array());
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Critical conditions.
|
||
|
|
*
|
||
|
|
* Example: Application component unavailable, unexpected exception.
|
||
|
|
*
|
||
|
|
* @param string $message
|
||
|
|
* @param array $context
|
||
|
|
* @return null
|
||
|
|
*/
|
||
|
|
public function critical($message, array $context = array());
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Runtime errors that do not require immediate action but should typically
|
||
|
|
* be logged and monitored.
|
||
|
|
*
|
||
|
|
* @param string $message
|
||
|
|
* @param array $context
|
||
|
|
* @return null
|
||
|
|
*/
|
||
|
|
public function error($message, array $context = array());
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Exceptional occurrences that are not errors.
|
||
|
|
*
|
||
|
|
* Example: Use of deprecated APIs, poor use of an API, undesirable things
|
||
|
|
* that are not necessarily wrong.
|
||
|
|
*
|
||
|
|
* @param string $message
|
||
|
|
* @param array $context
|
||
|
|
* @return null
|
||
|
|
*/
|
||
|
|
public function warning($message, array $context = array());
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Normal but significant events.
|
||
|
|
*
|
||
|
|
* @param string $message
|
||
|
|
* @param array $context
|
||
|
|
* @return null
|
||
|
|
*/
|
||
|
|
public function notice($message, array $context = array());
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Interesting events.
|
||
|
|
*
|
||
|
|
* Example: User logs in, SQL logs.
|
||
|
|
*
|
||
|
|
* @param string $message
|
||
|
|
* @param array $context
|
||
|
|
* @return null
|
||
|
|
*/
|
||
|
|
public function info($message, array $context = array());
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Detailed debug information.
|
||
|
|
*
|
||
|
|
* @param string $message
|
||
|
|
* @param array $context
|
||
|
|
* @return null
|
||
|
|
*/
|
||
|
|
public function debug($message, array $context = array());
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Logs with an arbitrary level.
|
||
|
|
*
|
||
|
|
* @param string $message
|
||
|
|
* @param mixed $level
|
||
|
|
* @param array $context
|
||
|
|
* @return null
|
||
|
|
*/
|
||
|
|
public function log($message, $level, array $context = array());
|
||
|
|
}
|