MockHandler
extends BaseHandler
in package
Uses
SetOptionsTrait
Tags
Table of Contents
- $check : mixed
- Check variables used for testing
- $events : array<string|int, LogMessage>
- Log events.
- $shutdown : bool
- Was shutdown called?
- $filters : array<string|int, LogFilter>
- List of filters relevant only to this handler.
- $formatters : array<string|int, LogFormatter>
- Formatters for this handler
- $options : Options
- __construct() : mixed
- 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.
- shutdown() : void
- Record shutdown
- write() : bool
- Write a message to the log.
Properties
$check
Check variables used for testing
public
mixed
$check
@var mixed;
$events
Log events.
public
array<string|int, LogMessage>
$events
= []
$shutdown
Was shutdown called?
public
bool
$shutdown
= false
$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
= []
$options
private
Options
$options
Methods
__construct()
public
__construct([Options $options = null ]) : mixed
Parameters
- $options : Options = 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.
shutdown()
Record shutdown
public
shutdown() : void
Return values
void —write()
Write a message to the log.
public
write(LogMessage $event) : bool
Parameters
- $event : LogMessage
-
Event data.