Logger
extends Logger
in package
This class wraps the BaseLogger class to allow for log verbosity
Tags
Table of Contents
- $debugNeeded : bool
- Is debug logging enabled?
- $userIpReader : UserIpReader
- User IP address reader
- __construct() : mixed
- Constructor
- debugNeeded() : bool
- Is one of the log writers listening for debug messages? (This is useful to know, since some code can save time that would be otherwise wasted generating debug messages if we know that no one is listening).
- log() : Logger
- Add a message as a log entry
- logException() : void
- Log an exception triggered by the framework for administrative purposes.
- removeWriter() : void
- Remove a writer.
- argumentToString() : string
- Convert function argument to a loggable string
- getSeverityFromException() : int
- Given an exception, return a severity level for logging purposes.
Properties
$debugNeeded
Is debug logging enabled?
protected
bool
$debugNeeded
= false
$userIpReader
User IP address reader
protected
UserIpReader
$userIpReader
Methods
__construct()
Constructor
public
__construct(UserIpReader $userIpReader[, array<string|int, mixed>|Traversable $options = null ]) : mixed
Set options for a logger. Accepted options are:
- writers: array of writers to add to this logger
- exceptionhandler: if true register this logger as exceptionhandler
- errorhandler: if true register this logger as errorhandler
Parameters
- $userIpReader : UserIpReader
-
User IP reader
- $options : array<string|int, mixed>|Traversable = null
-
Configuration options
Tags
Return values
mixed —debugNeeded()
Is one of the log writers listening for debug messages? (This is useful to know, since some code can save time that would be otherwise wasted generating debug messages if we know that no one is listening).
public
debugNeeded([bool $newState = null ]) : bool
Parameters
- $newState : bool = null
-
New state (omit to leave current state unchanged)
Return values
bool —log()
Add a message as a log entry
public
log(int $priority, mixed $message[, array<string|int, mixed>|Traversable $extra = [] ]) : Logger
Parameters
- $priority : int
-
Priority
- $message : mixed
-
Message
- $extra : array<string|int, mixed>|Traversable = []
-
Extras
Return values
Logger —logException()
Log an exception triggered by the framework for administrative purposes.
public
logException(Exception $error, Parameters $server) : void
Parameters
- $error : Exception
-
Exception to log
- $server : Parameters
-
Server metadata
Return values
void —removeWriter()
Remove a writer.
public
removeWriter(WriterInterface $writer) : void
Parameters
- $writer : WriterInterface
-
Writer to remove
Return values
void —argumentToString()
Convert function argument to a loggable string
protected
argumentToString(mixed $arg) : string
Parameters
- $arg : mixed
-
Argument
Return values
string —getSeverityFromException()
Given an exception, return a severity level for logging purposes.
protected
getSeverityFromException(Exception $error) : int
Parameters
- $error : Exception
-
Exception to analyze