Monolog\Handler\BufferHandler Class Reference

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

Inheritance diagram for Monolog\Handler\BufferHandler:

Collaboration diagram for Monolog\Handler\BufferHandler:

Public Member Functions
	__construct (HandlerInterface $handler, $bufferLimit=0, $level=Logger::DEBUG, $bubble=true, $flushOnOverflow=false)
	handle (array $record)
	{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. Parameters array $record The record to handle Returns 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. } More...
	flush ()
	__destruct ()
	close ()
	{} More...
	clear ()
	Clears the buffer without flushing any messages down to the wrapped handler. More...
	reset ()
Public Member Functions inherited from Monolog\Handler\AbstractHandler
	__construct ($level=Logger::DEBUG, $bubble=true)
	isHandling (array $record)
	{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. Parameters array $record Partial log record containing only a level key Returns bool } More...
	handleBatch (array $records)
	{Handles a set of records at once. Parameters array $records The records to handle (an array of record arrays) } More...
	close ()
	Closes the handler. More...
	pushProcessor ($callback)
	{Adds a processor in the stack. Parameters callable $callback Returns self } More...
	popProcessor ()
	{Removes the processor on top of the stack and returns it. Returns callable } More...
	setFormatter (FormatterInterface $formatter)
	{Sets the formatter. Parameters FormatterInterface $formatter Returns self } More...
	getFormatter ()
	{Gets the formatter. Returns FormatterInterface } More...
	setLevel ($level)
	Sets minimum logging level at which this handler will be triggered. More...
	getLevel ()
	Gets minimum logging level at which this handler will be triggered. More...
	setBubble ($bubble)
	Sets the bubbling behavior. More...
	getBubble ()
	Gets the bubbling behavior. More...
	__destruct ()
	reset ()

Protected Attributes
	$handler
	$bufferSize = 0
	$bufferLimit
	$flushOnOverflow
	$buffer = array()
	$initialized = false
Protected Attributes inherited from Monolog\Handler\AbstractHandler
	$level = Logger::DEBUG
	$bubble = true
	$formatter
	$processors = array()

Additional Inherited Members
Protected Member Functions inherited from Monolog\Handler\AbstractHandler
	getDefaultFormatter ()
	Gets the default formatter. More...

Detailed Description

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.

Author

Christophe Coevoet stof@.nosp@m.notk.nosp@m..org

Definition at line 25 of file BufferHandler.php.

Constructor & Destructor Documentation

__construct()

Monolog\Handler\BufferHandler::__construct	(	HandlerInterface	$handler,
			$bufferLimit = 0,
			$level = Logger::DEBUG,
			$bubble = true,
			$flushOnOverflow = false
	)

Parameters

HandlerInterface	$handler	Handler.
int	$bufferLimit	How many entries should be buffered at most, beyond that the oldest items are removed from the buffer.
int	$level	The minimum logging level at which this handler will be triggered
bool	$bubble	Whether the messages that are handled can bubble up the stack or not
bool	$flushOnOverflow	If true, the buffer is flushed when the max size has been reached, by default oldest entries are discarded

Definition at line 41 of file BufferHandler.php.

References Monolog\Handler\AbstractHandler\$bubble, Monolog\Handler\BufferHandler\$bufferLimit, Monolog\Handler\BufferHandler\$flushOnOverflow, Monolog\Handler\BufferHandler\$handler, and Monolog\Handler\AbstractHandler\$level.

    {
        parent::__construct($level, $bubble);
        $this->handler = $handler;
        $this->bufferLimit = (int) $bufferLimit;
        $this->flushOnOverflow = $flushOnOverflow;
    }

__destruct()

Monolog\Handler\BufferHandler::__destruct

(

)

Definition at line 95 of file BufferHandler.php.

    {
        // suppress the parent behavior since we already have register_shutdown_function()
        // to call close(), and the reference contained there will prevent this from being
        // GC'd until the end of the request
    }

Member Function Documentation

clear()

Monolog\Handler\BufferHandler::clear

(

)

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

Definition at line 113 of file BufferHandler.php.

Referenced by Monolog\Handler\DeduplicationHandler\flush(), and Monolog\Handler\BufferHandler\flush().

    {
        $this->bufferSize = 0;
        $this->buffer = array();
    }

Here is the caller graph for this function:

close()

Monolog\Handler\BufferHandler::close

(

)

{}

Definition at line 105 of file BufferHandler.php.

References Monolog\Handler\BufferHandler\flush().

    {
        $this->flush();
    }

Here is the call graph for this function:

flush()

Monolog\Handler\BufferHandler::flush

(

)

Definition at line 85 of file BufferHandler.php.

References Monolog\Handler\BufferHandler\clear().

Referenced by Monolog\Handler\BufferHandler\close(), Monolog\Handler\BufferHandler\handle(), and Monolog\Handler\BufferHandler\reset().

    {
        if ($this->bufferSize === 0) {
            return;
        }

        $this->handler->handleBatch($this->buffer);
        $this->clear();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

handle()

Monolog\Handler\BufferHandler::handle

(

array

$record

)

{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.

Parameters

array

$record

The record to handle

Returns

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.

}

Implements Monolog\Handler\HandlerInterface.

Definition at line 52 of file BufferHandler.php.

References Monolog\Handler\AbstractHandler\$bubble, and Monolog\Handler\BufferHandler\flush().

    {
        if ($record['level'] < $this->level) {
            return false;
        }

        if (!$this->initialized) {
            // __destructor() doesn't get called on Fatal errors
            register_shutdown_function(array($this, 'close'));
            $this->initialized = true;
        }

        if ($this->bufferLimit > 0 && $this->bufferSize === $this->bufferLimit) {
            if ($this->flushOnOverflow) {
                $this->flush();
            } else {
                array_shift($this->buffer);
                $this->bufferSize--;
            }
        }

        if ($this->processors) {
            foreach ($this->processors as $processor) {
                $record = call_user_func($processor, $record);
            }
        }

        $this->buffer[] = $record;
        $this->bufferSize++;

        return false === $this->bubble;
    }

Here is the call graph for this function:

reset()

Monolog\Handler\BufferHandler::reset

(

)

Implements Monolog\ResettableInterface.

Definition at line 119 of file BufferHandler.php.

References Monolog\Handler\BufferHandler\flush().

    {
        $this->flush();

        parent::reset();

        if ($this->handler instanceof ResettableInterface) {
            $this->handler->reset();
        }
    }

Here is the call graph for this function:

Field Documentation

$buffer

Monolog\Handler\BufferHandler::$buffer = array()

protected

Definition at line 31 of file BufferHandler.php.

$bufferLimit

Monolog\Handler\BufferHandler::$bufferLimit

protected

Definition at line 29 of file BufferHandler.php.

Referenced by Monolog\Handler\BufferHandler\__construct().

$bufferSize

Monolog\Handler\BufferHandler::$bufferSize = 0

protected

Definition at line 28 of file BufferHandler.php.

$flushOnOverflow

Monolog\Handler\BufferHandler::$flushOnOverflow

protected

Definition at line 30 of file BufferHandler.php.

Referenced by Monolog\Handler\BufferHandler\__construct().

$handler

Monolog\Handler\BufferHandler::$handler

protected

Definition at line 27 of file BufferHandler.php.

Referenced by Monolog\Handler\BufferHandler\__construct().

$initialized

Monolog\Handler\BufferHandler::$initialized = false

protected

Definition at line 32 of file BufferHandler.php.

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/monolog/monolog/src/Monolog/Handler/BufferHandler.php