PHP Class Neos\Flow\Log\Logger

Inheritance: implements SystemLoggerInterface, implements Neos\Flow\Log\ThrowableLoggerInterface, implements SecurityLoggerInterface
显示文件 Open project: neos/flow-development-collection Class Usage Examples

Protected Properties

Property Type Description
$backends SplObjectStorage

Public Methods

Method Description
__construct ( ) Constructs the logger
addBackend ( Neos\Flow\Log\Backend\BackendInterface $backend ) : void Adds the backend to which the logger sends the logging data
log ( string $message, integer $severity = LOG_INFO, mixed $additionalData = null, string $packageKey = null, string $className = null, string $methodName = null ) : void Writes the given message along with the additional information into the log.
logException ( Exception $exception, array $additionalData = [] ) : void
logThrowable ( Throwable $throwable, array $additionalData = [] ) : void
removeBackend ( Neos\Flow\Log\Backend\BackendInterface $backend ) : void Runs the close() method of a backend and removes the backend from the logger.
setBackend ( Neos\Flow\Log\Backend\BackendInterface $backend ) : void Sets the given backend as the only backend for this Logger.
shutdownObject ( ) : void Cleanly closes all registered backends before destructing this Logger

Protected Methods

Method Description
getErrorLogMessage ( object $error ) : string
logError ( object $error, array $additionalData = [] ) : void Writes information about the given exception into the log.
renderBacktrace ( string $message, array $backTrace ) : string Renders background information about the circumstances of the exception.
renderErrorInfo ( object $error ) : string Get current error post mortem informations with support for error chaining
renderRequestInfo ( ) : string Render information about the current request, if possible

Method Details

__construct() public method

Constructs the logger
public __construct ( )

addBackend() public method

Adds the backend to which the logger sends the logging data
public addBackend ( Neos\Flow\Log\Backend\BackendInterface $backend ) : void
$backend Neos\Flow\Log\Backend\BackendInterface A backend implementation
return void

getErrorLogMessage() protected method

protected getErrorLogMessage ( object $error ) : string
$error object \Exception or \Throwable
return string

log() public method

Writes the given message along with the additional information into the log.
public log ( string $message, integer $severity = LOG_INFO, mixed $additionalData = null, string $packageKey = null, string $className = null, string $methodName = null ) : void
$message string The message to log
$severity integer An integer value, one of the LOG_* constants
$additionalData mixed A variable containing more information about the event to be logged
$packageKey string Key of the package triggering the log (determined automatically if not specified)
$className string Name of the class triggering the log (determined automatically if not specified)
$methodName string Name of the method triggering the log (determined automatically if not specified)
return void

logError() protected method

Writes information about the given exception into the log.
protected logError ( object $error, array $additionalData = [] ) : void
$error object \Exception or \Throwable
$additionalData array Additional data to log
return void

logException() public method

public logException ( Exception $exception, array $additionalData = [] ) : void
$exception Exception The exception to log
$additionalData array Additional data to log
return void

logThrowable() public method

public logThrowable ( Throwable $throwable, array $additionalData = [] ) : void
$throwable Throwable The throwable to log
$additionalData array Additional data to log
return void

removeBackend() public method

Runs the close() method of a backend and removes the backend from the logger.
public removeBackend ( Neos\Flow\Log\Backend\BackendInterface $backend ) : void
$backend Neos\Flow\Log\Backend\BackendInterface The backend to remove
return void

renderBacktrace() protected method

Renders background information about the circumstances of the exception.
protected renderBacktrace ( string $message, array $backTrace ) : string
$message string
$backTrace array
return string

renderErrorInfo() protected method

Get current error post mortem informations with support for error chaining
protected renderErrorInfo ( object $error ) : string
$error object \Exception or \Throwable
return string

renderRequestInfo() protected method

Render information about the current request, if possible
protected renderRequestInfo ( ) : string
return string

setBackend() public method

This method allows for conveniently injecting a backend through some Objects.yaml configuration.
public setBackend ( Neos\Flow\Log\Backend\BackendInterface $backend ) : void
$backend Neos\Flow\Log\Backend\BackendInterface A backend implementation
return void

shutdownObject() public method

Cleanly closes all registered backends before destructing this Logger
public shutdownObject ( ) : void
return void

Property Details

$backends protected_oe property

protected SplObjectStorage $backends
return SplObjectStorage