Documentation

BaseHandler
in package
implements LogHandler

Tags
author

Mike Naberezny mike@maintainable.com

author

Chuck Hagenbuch chuck@horde.org

category

Horde

license

http://www.horde.org/licenses/bsd BSD

subpackage

Handlers

Interfaces, Classes, Traits and Enums

LogHandler
interface of a Log Handler.

Table of Contents

$filters  : array<string|int, LogFilter>
List of filters relevant only to this handler.
$formatters  : array<string|int, LogFormatter>
Formatters for this handler
addFilter()  : void
Add a filter specific to this handler.
log()  : void
Log a message to this handler.
write()  : bool
Buffer a message to be stored in the storage.

Properties

$filters

List of filters relevant only to this handler.

protected array<string|int, LogFilter> $filters = []

Methods

addFilter()

Add a filter specific to this handler.

public addFilter(LogFilter $filter) : void

Handlers cannot undo the filtering at logger level

Parameters
$filter : LogFilter

Filter to add.

Return values
void

log()

Log a message to this handler.

public log(LogMessage $event) : void

Check all filters and expand it before delegating to the write method

Parameters
$event : LogMessage

Log event.

Return values
void

write()

Buffer a message to be stored in the storage.

public abstract write(LogMessage $event) : bool
Parameters
$event : LogMessage

Log event.

Return values
bool

Search results