Interface WC_Logger_Interface

WC Logger Interface

Functions that must be defined to correctly fulfill logger API.

Direct known implementers

Category: Interface
Author: WooThemes
Version: 1.0.0
Located at interfaces/class-wc-logger-interface.php

Methods summary

`public boolean`	# `add( string $handle, string $message, string $level = WC_Log_Levels::NOTICE )` Add a log entry. Add a log entry. This is not the preferred method for adding log messages. Please use log() or any one of the level methods (debug(), info(), etc.). This method may be deprecated in the future. Parameters `$handle` `$message` `$level` Returns boolean True if log was added, otherwise false.
`public`	# `log( string $level, string $message, array $context = array() )` Add a log entry. Add a log entry. Parameters `$level` One of the following: 'emergency': System is unusable. 'alert': Action must be taken immediately. 'critical': Critical conditions. 'error': Error conditions. 'warning': Warning conditions. 'notice': Normal but significant condition. 'info': Informational messages. 'debug': Debug-level messages. `$message` Log message. `$context` Optional. Additional information for log handlers.
`public`	# `emergency( string $message, array $context = array() )` Adds an emergency level message. Adds an emergency level message. System is unusable. Parameters `$message` Log message. `$context` Optional. Additional information for log handlers.
`public`	# `alert( string $message, array $context = array() )` Adds an alert level message. Adds an alert level message. Action must be taken immediately. Example: Entire website down, database unavailable, etc. Parameters `$message` Log message. `$context` Optional. Additional information for log handlers.
`public`	# `critical( string $message, array $context = array() )` Adds a critical level message. Adds a critical level message. Critical conditions. Example: Application component unavailable, unexpected exception. Parameters `$message` Log message. `$context` Optional. Additional information for log handlers.
`public`	# `error( string $message, array $context = array() )` Adds an error level message. Adds an error level message. Runtime errors that do not require immediate action but should typically be logged and monitored. Parameters `$message` Log message. `$context` Optional. Additional information for log handlers.
`public`	# `warning( string $message, array $context = array() )` Adds a warning level message. Adds a warning level message. Exceptional occurrences that are not errors. Example: Use of deprecated APIs, poor use of an API, undesirable things that are not necessarily wrong. Parameters `$message` Log message. `$context` Optional. Additional information for log handlers.
`public`	# `notice( string $message, array $context = array() )` Adds a notice level message. Adds a notice level message. Normal but significant events. Parameters `$message` Log message. `$context` Optional. Additional information for log handlers.
`public`	# `info( string $message, array $context = array() )` Adds a info level message. Adds a info level message. Interesting events. Example: User logs in, SQL logs. Parameters `$message` Log message. `$context` Optional. Additional information for log handlers.
`public`	# `debug( string $message, array $context = array() )` Adds a debug level message. Adds a debug level message. Detailed debug information. Parameters `$message` Log message. `$context` Optional. Additional information for log handlers.