woocommerce/includes/class-wc-logger.php

200 lines
4.3 KiB
PHP
Raw Normal View History

<?php
2015-11-06 09:22:19 +00:00
if ( ! defined( 'ABSPATH' ) ) {
exit; // Exit if accessed directly
}
/**
* Provides logging capabilities for debugging purposes.
*
* @class WC_Logger
* @version 2.0.0
* @package WooCommerce/Classes
* @category Class
* @author WooThemes
*/
2012-01-27 16:38:39 +00:00
class WC_Logger {
2012-08-14 19:42:38 +00:00
2012-08-15 17:08:42 +00:00
/**
* Log Levels
*
* @see @link {https://tools.ietf.org/html/rfc5424}
*/
const DEBUG = 'debug';
const INFO = 'info';
const NOTICE = 'notice';
const WARNING = 'warning';
const ERROR = 'error';
const CRITICAL = 'critical';
const ALERT = 'alert';
const EMERGENCY = 'emergency';
/**
* Stores registered log handlers.
*
* @var array
2012-08-15 17:08:42 +00:00
* @access private
*/
private $handlers;
2012-08-14 19:42:38 +00:00
private static $valid_levels = array(
self::DEBUG,
self::INFO,
self::NOTICE,
self::WARNING,
self::ERROR,
self::CRITICAL,
self::ALERT,
self::EMERGENCY,
);
2012-08-14 19:42:38 +00:00
/**
2012-08-15 17:08:42 +00:00
* Constructor for the logger.
2012-08-14 19:42:38 +00:00
*/
2012-12-14 21:44:43 +00:00
public function __construct() {
$handlers = apply_filters( 'woocommerce_register_log_handlers', array() );
$this->handlers = $handlers;
}
2012-08-14 19:42:38 +00:00
/**
* Add a log entry.
*
* @deprecated since 2.0.0
*
* @param string $handle
* @param string $message
*
* @return bool
2012-08-14 19:42:38 +00:00
*/
public function add( $handle, $message ) {
_deprecated_function( 'WC_Logger::add', '2.8', 'WC_Logger::log' );
$message = apply_filters( 'woocommerce_logger_add_message', $message, $handle );
$this->log( self::INFO, $message, array( 'tag' => $handle, '_legacy' => true ) );
wc_do_deprecated_action( 'woocommerce_log_add', array( $handle, $message ), '2.8', 'This action has been deprecated with no alternative.' );
return true;
}
2012-08-14 19:42:38 +00:00
/**
* Add a log entry.
2012-08-14 19:42:38 +00:00
*
* @param int $timestamp Log timestamp.
* @param string $level emergency|alert|critical|error|warning|notice|info|debug
* @param string $message Log message.
* @param array $context Optional. Additional information for log handlers.
*/
public function log( $level, $message, $context = array() ) {
if ( ! in_array( $level, self::$valid_levels ) ) {
$class = __CLASS__;
$method = __FUNCTION__;
_doing_it_wrong( "{$class}::{$method}", sprintf( __( 'WC_Logger::log was called with an invalid level "%s".', 'woocommerce' ), $level ), '2.8' );
}
$timestamp = current_time( 'timestamp' );
2012-08-14 19:42:38 +00:00
foreach ( $this->handlers as $handler ) {
$continue = $handler->handle( $timestamp, $level, $message, $context );
if ( false === $continue ) {
break;
}
2016-09-12 22:37:02 +00:00
}
}
2012-08-14 19:42:38 +00:00
2016-04-19 15:56:41 +00:00
/**
* Adds an emergency level message.
*
* @see WC_Logger::log
2016-04-19 15:56:41 +00:00
*/
public function emergency( $message, $context = array() ) {
$this->log( self::EMERGENCY, $message, $context );
2016-04-19 15:56:41 +00:00
}
/**
* Adds an alert level message.
2012-08-14 19:42:38 +00:00
*
* @see WC_Logger::log
*/
public function alert( $message, $context = array() ) {
$this->log( self::ALERT, $message, $context );
}
2012-08-14 19:42:38 +00:00
/**
* Adds a critical level message.
*
* @see WC_Logger::log
*/
public function critical( $message, $context = array() ) {
$this->log( self::CRITICAL, $message, $context );
}
2012-08-14 19:42:38 +00:00
/**
* Adds an error level message.
2012-08-14 19:42:38 +00:00
*
* @see WC_Logger::log
*/
public function error( $message, $context = array() ) {
$this->log( self::ERROR, $message, $context );
}
2015-07-16 19:55:48 +00:00
/**
* Adds a warning level message.
*
* @see WC_Logger::log
*/
public function warning( $message, $context = array() ) {
$this->log( self::WARNING, $message, $context );
}
/**
* Adds a notice level message.
*
* @see WC_Logger::log
*/
public function notice( $message, $context = array() ) {
$this->log( self::NOTICE, $message, $context );
}
2012-11-27 16:22:47 +00:00
/**
* Adds a info level message.
*
* @see WC_Logger::log
*/
public function info( $message, $context = array() ) {
$this->log( self::INFO, $message, $context );
}
/**
* Adds a debug level message.
*
* @see WC_Logger::log
*/
public function debug( $message, $context = array() ) {
$this->log( self::DEBUG, $message, $context );
}
/**
* Clear entries from chosen file.
*
* @deprecated since 2.0.0
*
* @return bool
*/
2016-11-14 20:55:21 +00:00
public function clear() {
_deprecated_function( 'WC_Logger::clear', '2.8' );
return false;
}
/**
* Remove/delete the chosen file.
*
* @deprecated since 2.0.0
*
* @return bool
*/
2016-11-14 20:55:21 +00:00
public function remove() {
_deprecated_function( 'WC_Logger::remove', '2.8' );
return false;
}
2016-08-02 13:42:27 +00:00
}