LoggerInterface Interface Reference

Inheritance diagram for LoggerInterface:

Public Member Functions
	emergency ($message, array $context=array())
	alert ($message, array $context=array())
	critical ($message, array $context=array())
	error ($message, array $context=array())
	warning ($message, array $context=array())
	notice ($message, array $context=array())
	info ($message, array $context=array())
	debug ($message, array $context=array())
	log ($level, $message, array $context=array())

Detailed Description

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.

Definition at line 20 of file LoggerInterface.php.

Member Function Documentation

alert	(		$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.

Parameters

string	$message
array	$context

Returns

null

Implemented in Logger, and AbstractLogger.

critical	(		$message,
		array	$context = array()
	)

Critical conditions.

Example: Application component unavailable, unexpected exception.

Parameters

string	$message
array	$context

Returns

null

Implemented in Logger, and AbstractLogger.

debug	(		$message,
		array	$context = array()
	)

Detailed debug information.

Parameters

string	$message
array	$context

Returns

null

Implemented in Logger, and AbstractLogger.

emergency	(		$message,
		array	$context = array()
	)

System is unusable.

Parameters

string	$message
array	$context

Returns

null

Implemented in Logger, and AbstractLogger.

error	(		$message,
		array	$context = array()
	)

Runtime errors that do not require immediate action but should typically be logged and monitored.

Parameters

string	$message
array	$context

Returns

null

Implemented in Logger, and AbstractLogger.

info	(		$message,
		array	$context = array()
	)

Interesting events.

Example: User logs in, SQL logs.

Parameters

string	$message
array	$context

Returns

null

Implemented in Logger, and AbstractLogger.

log	(		$level,
			$message,
		array	$context = array()
	)

Logs with an arbitrary level.

Parameters

mixed	$level
string	$message
array	$context

Returns

null

Implemented in ConsoleLogger, and NullLogger.

Referenced by AbstractLogger\alert(), Logger\alert(), AbstractLogger\critical(), Logger\critical(), AbstractLogger\debug(), Logger\debug(), AbstractLogger\emergency(), Logger\emergency(), AbstractLogger\error(), Logger\error(), AbstractLogger\info(), Logger\info(), AbstractLogger\notice(), Logger\notice(), AbstractLogger\warning(), and Logger\warning().

notice	(		$message,
		array	$context = array()
	)

Normal but significant events.

Parameters

string	$message
array	$context

Returns

null

Implemented in Logger, and AbstractLogger.

warning	(		$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.

Parameters

string	$message
array	$context

Returns

null

Implemented in Logger, and AbstractLogger.