HandlerWrapper
in package
implements
HandlerInterface, ProcessableHandlerInterface, FormattableHandlerInterface, ResettableInterface
This simple wrapper class can be used to extend handlers functionality.
Example: A custom filtering that can be applied to any handler.
Inherit from this class and override handle() like this:
public function handle(LogRecord $record) { if ($record meets certain conditions) { return false; } return $this->handler->handle($record); }
Tags
Table of Contents
Interfaces
- HandlerInterface
- Interface that all Monolog Handlers must implement
- ProcessableHandlerInterface
- Interface to describe loggers that have processors
- FormattableHandlerInterface
- Interface to describe loggers that have a formatter
- ResettableInterface
- Handler or Processor implementing this interface will be reset when Logger::reset() is called.
Properties
Methods
- __construct() : mixed
- close() : void
- Closes the handler.
- getFormatter() : FormatterInterface
- Gets the formatter.
- handle() : bool
- Handles a record.
- handleBatch() : void
- Handles a set of records at once.
- isHandling() : bool
- Checks whether the given record will be handled by this handler.
- popProcessor() : callable|ProcessorInterface
- Removes the processor on top of the stack and returns it.
- pushProcessor() : HandlerInterface
- Adds a processor in the stack.
- reset() : void
- setFormatter() : HandlerInterface
- Sets the formatter.
Properties
$handler
protected
HandlerInterface
$handler
Methods
__construct()
public
__construct(HandlerInterface $handler) : mixed
Parameters
- $handler : HandlerInterface
close()
Closes the handler.
public
close() : void
Tags
getFormatter()
Gets the formatter.
public
getFormatter() : FormatterInterface
Tags
Return values
FormatterInterfacehandle()
Handles a record.
public
handle(LogRecord $record) : bool
Parameters
- $record : LogRecord
-
The record to handle
Tags
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) : void
Parameters
- $records : array<string|int, mixed>
-
The records to handle
Tags
isHandling()
Checks whether the given record will be handled by this handler.
public
isHandling(LogRecord $record) : bool
Parameters
- $record : LogRecord
-
Partial log record having only a level initialized
Tags
Return values
boolpopProcessor()
Removes the processor on top of the stack and returns it.
public
popProcessor() : callable|ProcessorInterface
Tags
Return values
callable|ProcessorInterfacepushProcessor()
Adds a processor in the stack.
public
pushProcessor(callable $callback) : HandlerInterface
Parameters
- $callback : callable
Tags
Return values
HandlerInterface —self
reset()
public
reset() : void
setFormatter()
Sets the formatter.
public
setFormatter(FormatterInterface $formatter) : HandlerInterface
Parameters
- $formatter : FormatterInterface
Tags
Return values
HandlerInterface —self