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
Table of Contents
- $bubble : mixed
- $buffer : mixed
- $bufferLimit : mixed
- $bufferSize : mixed
- $flushOnOverflow : mixed
- $formatter : FormatterInterface
- $handler : mixed
- $initialized : mixed
- $level : mixed
- $processors : mixed
- __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() : mixed
- {@inheritdoc}
- 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
$bubble
protected
mixed
$bubble
= true
$buffer
protected
mixed
$buffer
= array()
$bufferLimit
protected
mixed
$bufferLimit
$bufferSize
protected
mixed
$bufferSize
= 0
$flushOnOverflow
protected
mixed
$flushOnOverflow
$formatter
protected
FormatterInterface
$formatter
$handler
protected
mixed
$handler
$initialized
protected
mixed
$initialized
= false
$level
protected
mixed
$level
= MonologLogger::DEBUG
$processors
protected
mixed
$processors
= array()
Methods
__construct()
public
__construct(HandlerInterface $handler, int $bufferLimit[, int $level = Logger::DEBUG ][, bool $bubble = true ][, bool $flushOnOverflow = false ]) : mixed
Parameters
- $handler : HandlerInterface
-
Handler.
- $bufferLimit : int
-
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
Return values
mixed —__destruct()
public
__destruct() : mixed
Return values
mixed —clear()
Clears the buffer without flushing any messages down to the wrapped handler.
public
clear() : mixed
Return values
mixed —close()
Closes the handler.
public
close() : mixed
Return values
mixed —flush()
public
flush() : mixed
Return values
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.
getFormatter()
Gets the formatter.
public
getFormatter() : FormatterInterface
Return values
FormatterInterface —getLevel()
Gets minimum logging level at which this handler will be triggered.
public
getLevel() : int
Return values
int —handle()
{@inheritdoc}
public
handle(array<string|int, mixed> $record) : mixed
Parameters
- $record : array<string|int, mixed>
Return values
mixed —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)
Return values
mixed —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 —reset()
public
reset() : mixed
Return values
mixed —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 —setFormatter()
Sets the formatter.
public
setFormatter(FormatterInterface $formatter) : self
Parameters
- $formatter : FormatterInterface
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 —getDefaultFormatter()
Gets the default formatter.
protected
getDefaultFormatter() : FormatterInterface