Documentation

BufferHandler extends AbstractHandler
in package

Buffers all records until closing the handler and then pass them as batch.

This is useful for a MailHandler to send only one mail per request instead of sending one per log message.

Tags
author

Christophe Coevoet stof@notk.org

Table of Contents

Properties

$bubble  : mixed
$buffer  : mixed
$bufferLimit  : mixed
$bufferSize  : mixed
$flushOnOverflow  : mixed
$formatter  : FormatterInterface
$handler  : mixed
$initialized  : mixed
$level  : mixed
$processors  : mixed

Methods

__construct()  : mixed
__destruct()  : mixed
clear()  : mixed
Clears the buffer without flushing any messages down to the wrapped handler.
close()  : mixed
Closes the handler.
flush()  : mixed
getBubble()  : bool
Gets the bubbling behavior.
getFormatter()  : FormatterInterface
Gets the formatter.
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
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

Methods

__construct()

public __construct(HandlerInterface $handler[, int $bufferLimit = 0 ][, int $level = Logger::DEBUG ][, bool $bubble = true ][, bool $flushOnOverflow = false ]) : mixed
Parameters
$handler : HandlerInterface

Handler.

$bufferLimit : int = 0

How many entries should be buffered at most, beyond that the oldest items are removed from the buffer.

$level : int = Logger::DEBUG

The minimum logging level at which this handler will be triggered

$bubble : bool = true

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

$flushOnOverflow : bool = false

If true, the buffer is flushed when the max size has been reached, by default oldest entries are discarded

clear()

Clears the buffer without flushing any messages down to the wrapped handler.

public clear() : 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.

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

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