<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* Logger Interface

[2] Fix | Delete

*

[3] Fix | Delete

* @version 3.0.0

[4] Fix | Delete

* @package WooCommerce\Interface

[5] Fix | Delete

*/

[6] Fix | Delete

[7] Fix | Delete

/**

[8] Fix | Delete

* WC Logger Interface

[9] Fix | Delete

*

[10] Fix | Delete

* Functions that must be defined to correctly fulfill logger API.

[11] Fix | Delete

*

[12] Fix | Delete

* @version 3.0.0

[13] Fix | Delete

*/

[14] Fix | Delete

interface WC_Logger_Interface {

[15] Fix | Delete

[16] Fix | Delete

/**

[17] Fix | Delete

* Add a log entry.

[18] Fix | Delete

*

[19] Fix | Delete

* This is not the preferred method for adding log messages. Please use log() or any one of

[20] Fix | Delete

* the level methods (debug(), info(), etc.). This method may be deprecated in the future.

[21] Fix | Delete

*

[22] Fix | Delete

* @param string $handle File handle.

[23] Fix | Delete

* @param string $message Log message.

[24] Fix | Delete

* @param string $level Log level.

[25] Fix | Delete

*

[26] Fix | Delete

* @return bool True if log was added, otherwise false.

[27] Fix | Delete

*/

[28] Fix | Delete

public function add( $handle, $message, $level = WC_Log_Levels::NOTICE );

[29] Fix | Delete

[30] Fix | Delete

/**

[31] Fix | Delete

* Add a log entry.

[32] Fix | Delete

*

[33] Fix | Delete

* @param string $level One of the following:

[34] Fix | Delete

* 'emergency': System is unusable.

[35] Fix | Delete

* 'alert': Action must be taken immediately.

[36] Fix | Delete

* 'critical': Critical conditions.

[37] Fix | Delete

* 'error': Error conditions.

[38] Fix | Delete

* 'warning': Warning conditions.

[39] Fix | Delete

* 'notice': Normal but significant condition.

[40] Fix | Delete

* 'info': Informational messages.

[41] Fix | Delete

* 'debug': Debug-level messages.

[42] Fix | Delete

* @param string $message Log message.

[43] Fix | Delete

* @param array $context Optional. Additional information for log handlers.

[44] Fix | Delete

*/

[45] Fix | Delete

public function log( $level, $message, $context = array() );

[46] Fix | Delete

[47] Fix | Delete

/**

[48] Fix | Delete

* Adds an emergency level message.

[49] Fix | Delete

*

[50] Fix | Delete

* System is unusable.

[51] Fix | Delete

*

[52] Fix | Delete

* @param string $message Log message.

[53] Fix | Delete

* @param array $context Optional. Additional information for log handlers.

[54] Fix | Delete

*/

[55] Fix | Delete

public function emergency( $message, $context = array() );

[56] Fix | Delete

[57] Fix | Delete

/**

[58] Fix | Delete

* Adds an alert level message.

[59] Fix | Delete

*

[60] Fix | Delete

* Action must be taken immediately.

[61] Fix | Delete

* Example: Entire website down, database unavailable, etc.

[62] Fix | Delete

*

[63] Fix | Delete

* @param string $message Log message.

[64] Fix | Delete

* @param array $context Optional. Additional information for log handlers.

[65] Fix | Delete

*/

[66] Fix | Delete

public function alert( $message, $context = array() );

[67] Fix | Delete

[68] Fix | Delete

/**

[69] Fix | Delete

* Adds a critical level message.

[70] Fix | Delete

*

[71] Fix | Delete

* Critical conditions.

[72] Fix | Delete

* Example: Application component unavailable, unexpected exception.

[73] Fix | Delete

*

[74] Fix | Delete

* @param string $message Log message.

[75] Fix | Delete

* @param array $context Optional. Additional information for log handlers.

[76] Fix | Delete

*/

[77] Fix | Delete

public function critical( $message, $context = array() );

[78] Fix | Delete

[79] Fix | Delete

/**

[80] Fix | Delete

* Adds an error level message.

[81] Fix | Delete

*

[82] Fix | Delete

* Runtime errors that do not require immediate action but should typically be logged

[83] Fix | Delete

* and monitored.

[84] Fix | Delete

*

[85] Fix | Delete

* @param string $message Log message.

[86] Fix | Delete

* @param array $context Optional. Additional information for log handlers.

[87] Fix | Delete

*/

[88] Fix | Delete

public function error( $message, $context = array() );

[89] Fix | Delete

[90] Fix | Delete

/**

[91] Fix | Delete

* Adds a warning level message.

[92] Fix | Delete

*

[93] Fix | Delete

* Exceptional occurrences that are not errors.

[94] Fix | Delete

*

[95] Fix | Delete

* Example: Use of deprecated APIs, poor use of an API, undesirable things that are not

[96] Fix | Delete

* necessarily wrong.

[97] Fix | Delete

*

[98] Fix | Delete

* @param string $message Log message.

[99] Fix | Delete

* @param array $context Optional. Additional information for log handlers.

[100] Fix | Delete

*/

[101] Fix | Delete

public function warning( $message, $context = array() );

[102] Fix | Delete

[103] Fix | Delete

/**

[104] Fix | Delete

* Adds a notice level message.

[105] Fix | Delete

*

[106] Fix | Delete

* Normal but significant events.

[107] Fix | Delete

*

[108] Fix | Delete

* @param string $message Log message.

[109] Fix | Delete

* @param array $context Optional. Additional information for log handlers.

[110] Fix | Delete

*/

[111] Fix | Delete

public function notice( $message, $context = array() );

[112] Fix | Delete

[113] Fix | Delete

/**

[114] Fix | Delete

* Adds a info level message.

[115] Fix | Delete

*

[116] Fix | Delete

* Interesting events.

[117] Fix | Delete

* Example: User logs in, SQL logs.

[118] Fix | Delete

*

[119] Fix | Delete

* @param string $message Log message.

[120] Fix | Delete

* @param array $context Optional. Additional information for log handlers.

[121] Fix | Delete

*/

[122] Fix | Delete

public function info( $message, $context = array() );

[123] Fix | Delete

[124] Fix | Delete

/**

[125] Fix | Delete

* Adds a debug level message.

[126] Fix | Delete

*

[127] Fix | Delete

* Detailed debug information.

[128] Fix | Delete

*

[129] Fix | Delete

* @param string $message Log message.

[130] Fix | Delete

* @param array $context Optional. Additional information for log handlers.

[131] Fix | Delete

*/

[132] Fix | Delete

public function debug( $message, $context = array() );

[133] Fix | Delete

}

[134] Fix | Delete

[135] Fix | Delete