ScribeHandler
extends BaseHandler
in package
Uses
SetOptionsTrait
Tags
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
- $scribe : Horde_Scribe_Client
- Scribe client.
- $options : ScribeOptions
- __construct() : mixed
- Constructor.
- addFilter() : void
- Add a filter specific to this handler.
- log() : void
- Log a message to this handler.
- setOption() : bool
- Sets an option specific to the implementation of the log handler.
- write() : bool
- Write a message to the log.
Properties
$filters
List of filters relevant only to this handler.
protected
array<string|int, LogFilter>
$filters
= []
$formatters
Formatters for this handler
protected
array<string|int, LogFormatter>
$formatters
= []
$scribe
Scribe client.
protected
Horde_Scribe_Client
$scribe
$options
private
ScribeOptions
$options
Methods
__construct()
Constructor.
public
__construct(Horde_Scribe_Client $scribe[, array<string|int, LogFormatter> $formatters = null ][, ScribeOptions $options = null ]) : mixed
Parameters
- $scribe : Horde_Scribe_Client
-
Scribe client.
- $formatters : array<string|int, LogFormatter> = null
-
Log formatter.
- $options : ScribeOptions = null
Return values
mixed —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 —setOption()
Sets an option specific to the implementation of the log handler.
public
setOption(string $optionKey, mixed $optionValue) : bool
Parameters
- $optionKey : string
-
Key name for the option to be changed. Keys are handler-specific.
- $optionValue : mixed
-
New value to assign to the option
Tags
Return values
bool —True.
write()
Write a message to the log.
public
write(LogMessage $event) : bool
Parameters
- $event : LogMessage
-
Log event.
Return values
bool —True.