Documentation

FilterHandler extends AbstractHandler
in package

Simple handler wrapper that filters records based on a list of levels

It can be configured with an exact list of levels to allow, or a min/max level.

Tags
author

Hennadiy Verkh

author

Jordi Boggiano j.boggiano@seld.be

Table of Contents

Properties

$acceptedLevels  : array<string|int, int>
Minimum level for logs that are passed to handler
$bubble  : bool
Whether the messages that are handled can bubble up the stack or not
$formatter  : FormatterInterface
$handler  : callable|HandlerInterface
Handler or factory callable($record, $this)
$level  : mixed
$processors  : mixed

Methods

__construct()  : mixed
__destruct()  : mixed
close()  : mixed
Closes the handler.
getAcceptedLevels()  : array<string|int, mixed>
getBubble()  : bool
Gets the bubbling behavior.
getFormatter()  : FormatterInterface
Gets the formatter.
getHandler()  : HandlerInterface
Return the nested handler
getLevel()  : int
Gets minimum logging level at which this handler will be triggered.
handle()  : bool
Handles a record.
handleBatch()  : mixed
Handles a set of records at once.
isHandling()  : bool
Checks whether the given record will be handled by this handler.
popProcessor()  : callable
Removes the processor on top of the stack and returns it.
pushProcessor()  : self
Adds a processor in the stack.
reset()  : mixed
setAcceptedLevels()  : mixed
setBubble()  : self
Sets the bubbling behavior.
setFormatter()  : self
Sets the formatter.
setLevel()  : self
Sets minimum logging level at which this handler will be triggered.
getDefaultFormatter()  : FormatterInterface
Gets the default formatter.

Properties

$acceptedLevels

Minimum level for logs that are passed to handler

protected array<string|int, int> $acceptedLevels

$bubble

Whether the messages that are handled can bubble up the stack or not

protected bool $bubble

Methods

__construct()

public __construct(callable|HandlerInterface $handler[, int|array<string|int, mixed> $minLevelOrList = Logger::DEBUG ][, int $maxLevel = Logger::EMERGENCY ][, bool $bubble = true ]) : mixed
Parameters
$handler : callable|HandlerInterface

Handler or factory callable($record|null, $filterHandler).

$minLevelOrList : int|array<string|int, mixed> = Logger::DEBUG

A list of levels to accept or a minimum level if maxLevel is provided

$maxLevel : int = Logger::EMERGENCY

Maximum level to accept, only used if $minLevelOrList is not an array

$bubble : bool = true

Whether the messages that are handled can bubble up the stack or not

close()

Closes the handler.

public close() : mixed

This will be called automatically when the object is destroyed

getAcceptedLevels()

public getAcceptedLevels() : array<string|int, mixed>
Return values
array<string|int, mixed>

getBubble()

Gets the bubbling behavior.

public getBubble() : bool
Return values
bool —

true means that this handler allows bubbling. false means that bubbling is not permitted.

getHandler()

Return the nested handler

public getHandler([array<string|int, mixed> $record = null ]) : HandlerInterface

If the handler was provided as a factory callable, this will trigger the handler's instantiation.

Parameters
$record : array<string|int, mixed> = null
Return values
HandlerInterface

getLevel()

Gets minimum logging level at which this handler will be triggered.

public getLevel() : int
Return values
int

handle()

Handles a record.

public handle(array<string|int, mixed> $record) : bool
Parameters
$record : array<string|int, mixed>

The record to handle

Return values
bool —

true means that this handler handled the record, and that bubbling is not permitted. false means the record was either not processed or that this handler allows bubbling.

handleBatch()

Handles a set of records at once.

public handleBatch(array<string|int, mixed> $records) : mixed
Parameters
$records : array<string|int, mixed>

The records to handle (an array of record arrays)

isHandling()

Checks whether the given record will be handled by this handler.

public isHandling(array<string|int, mixed> $record) : bool
Parameters
$record : array<string|int, mixed>

Partial log record containing only a level key

Return values
bool

popProcessor()

Removes the processor on top of the stack and returns it.

public popProcessor() : callable
Return values
callable

pushProcessor()

Adds a processor in the stack.

public pushProcessor(mixed $callback) : self
Parameters
$callback : mixed
Return values
self

setAcceptedLevels()

public setAcceptedLevels([int|string|array<string|int, mixed> $minLevelOrList = Logger::DEBUG ][, int|string $maxLevel = Logger::EMERGENCY ]) : mixed
Parameters
$minLevelOrList : int|string|array<string|int, mixed> = Logger::DEBUG

A list of levels to accept or a minimum level or level name if maxLevel is provided

$maxLevel : int|string = Logger::EMERGENCY

Maximum level or level name to accept, only used if $minLevelOrList is not an array

setBubble()

Sets the bubbling behavior.

public setBubble(bool $bubble) : self
Parameters
$bubble : bool

true means that this handler allows bubbling. false means that bubbling is not permitted.

Return values
self

setLevel()

Sets minimum logging level at which this handler will be triggered.

public setLevel(int|string $level) : self
Parameters
$level : int|string

Level or level name

Return values
self 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results