Interface LoggerInterface

Summary

Fully Qualified Name: Psr\Log\LoggerInterface

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.

Methods

Name Description Defined By
alert() Action must be taken immediately. LoggerInterface
critical() Critical conditions. LoggerInterface
debug() Detailed debug information. LoggerInterface
emergency() System is unusable. LoggerInterface
error() Runtime errors that do not require immediate action but should typically be logged and monitored. LoggerInterface
info() Interesting events. LoggerInterface
log() Logs with an arbitrary level. LoggerInterface
notice() Normal but significant events. LoggerInterface
warning() Exceptional occurrences that are not errors. LoggerInterface

Method Details

alert()

Action must be taken immediately.

Example: Entire website down, database unavailable, etc. This should trigger the SMS alerts and wake you up.

Parameter Name Type Description
$message string
$context array

Returns: null

critical()

Critical conditions.

Example: Application component unavailable, unexpected exception.

Parameter Name Type Description
$message string
$context array

Returns: null

debug()

Detailed debug information.

Parameter Name Type Description
$message string
$context array

Returns: null

emergency()

System is unusable.

Parameter Name Type Description
$message string
$context array

Returns: null

error()

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

Parameter Name Type Description
$message string
$context array

Returns: null

info()

Interesting events.

Example: User logs in, SQL logs.

Parameter Name Type Description
$message string
$context array

Returns: null

log()

Logs with an arbitrary level.

Parameter Name Type Description
$level mixed
$message string
$context array

Returns: null

notice()

Normal but significant events.

Parameter Name Type Description
$message string
$context array

Returns: null

warning()

Exceptional occurrences that are not errors.

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

Parameter Name Type Description
$message string
$context array

Returns: null

Top