LogHandler
in
interface of a Log Handler.
Tags
Table of Contents
- 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
- Buffer a message to be stored in the storage.
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 —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()
Buffer a message to be stored in the storage.
public
write(LogMessage $event) : bool
Parameters
- $event : LogMessage
-
Log event.