$handler
$handler : \Monolog\Handler\HandlerInterface
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(array $record) { if ($record meets certain conditions) { return false; } return $this->handler->handle($record); }
$handler : \Monolog\Handler\HandlerInterface
__construct(\Monolog\Handler\HandlerInterface $handler)
| \Monolog\Handler\HandlerInterface | $handler |
isHandling(array $record) : boolean
Checks whether the given record will be handled by this handler.
This is mostly done for performance reasons, to avoid calling processors for nothing.
Handlers should still check the record levels within handle(), returning false in isHandling() is no guarantee that handle() will not be called, and isHandling() might not be called for a given record.
| array | $record | Partial log record containing only a level key |
handle(array $record) : boolean
Handles a record.
All records may be passed to this method, and the handler should discard those that it does not want to handle.
The return value of this function controls the bubbling process of the handler stack. Unless the bubbling is interrupted (by returning true), the Logger class will keep on calling further handlers in the stack with a given log record.
| array | $record | The record to handle |
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.
close()
Closes the handler.
Ends a log cycle and frees all resources used by the handler.
Closing a Handler means flushing all buffers and freeing any open resources/handles.
Implementations have to be idempotent (i.e. it should be possible to call close several times without breakage) and ideally handlers should be able to reopen themselves on handle() after they have been closed.
This is useful at the end of a request and will be called automatically when the object is destroyed if you extend Monolog\Handler\Handler.
If you are thinking of calling this method yourself, most likely you should be calling ResettableInterface::reset instead. Have a look.
pushProcessor(callable $callback) : \Monolog\Handler\HandlerInterface
Adds a processor in the stack.
| callable | $callback |
self
setFormatter(\Monolog\Formatter\FormatterInterface $formatter) : \Monolog\Handler\HandlerInterface
Sets the formatter.
| \Monolog\Formatter\FormatterInterface | $formatter |
self
getFormatter() : \Monolog\Formatter\FormatterInterface
Gets the formatter.