Monolog\Handler\FingersCrossedHandler Class Reference

Buffers all records until a certain level is reached. More...

Inheritance diagram for Monolog\Handler\FingersCrossedHandler:

Collaboration diagram for Monolog\Handler\FingersCrossedHandler:

Public Member Functions
	__construct ($handler, $activationStrategy=null, $bufferSize=0, $bubble=true, $stopBuffering=true, $passthruLevel=null)
	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...
	activate ()
	Manually activate this logger regardless of the activation strategy. More...
	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...
	close ()
	{Closes the handler.This will be called automatically when the object is destroyed} More...
	reset ()
	clear ()
	Clears the buffer without flushing any messages down to the wrapped handler. More...
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 ()
	isHandling (array $record)
	Checks whether the given record will be handled by this handler. More...
	handle (array $record)
	Handles a record. More...
	handleBatch (array $records)
	Handles a set of records at once. More...
	pushProcessor ($callback)
	Adds a processor in the stack. More...
	popProcessor ()
	Removes the processor on top of the stack and returns it. More...
	setFormatter (FormatterInterface $formatter)
	Sets the formatter. More...
	getFormatter ()
	Gets the formatter. More...
	reset ()

Protected Attributes
	$handler
	$activationStrategy
	$buffering = true
	$bufferSize
	$buffer = array()
	$stopBuffering
	$passthruLevel
Protected Attributes inherited from Monolog\Handler\AbstractHandler
	$level = Logger::DEBUG
	$bubble = true
	$formatter
	$processors = array()

Private Member Functions
	flushBuffer ()
	Resets the state of the handler. More...

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

Detailed Description

Buffers all records until a certain level is reached.

The advantage of this approach is that you don't get any clutter in your log files. Only requests which actually trigger an error (or whatever your actionLevel is) will be in the logs, but they will contain all records, not only those above the level threshold.

You can find the various activation strategies in the Monolog\Handler\FingersCrossed\ namespace.

Author

Jordi Boggiano j.bog.nosp@m.gian.nosp@m.o@sel.nosp@m.d.be

Definition at line 31 of file FingersCrossedHandler.php.

Constructor & Destructor Documentation

__construct()

Monolog\Handler\FingersCrossedHandler::__construct	(		$handler,
			$activationStrategy = null,
			$bufferSize = 0,
			$bubble = true,
			$stopBuffering = true,
			$passthruLevel = null
	)

Parameters

callable | HandlerInterface	$handler	Handler or factory callable($record, $fingersCrossedHandler).
int | ActivationStrategyInterface	$activationStrategy	Strategy which determines when this handler takes action
int	$bufferSize	How many entries should be buffered at most, beyond that the oldest items are removed from the buffer.
bool	$bubble	Whether the messages that are handled can bubble up the stack or not
bool	$stopBuffering	Whether the handler should stop buffering after being triggered (default true)
int	$passthruLevel	Minimum level to always flush to handler on close, even if strategy not triggered

Definition at line 49 of file FingersCrossedHandler.php.

    {
        if (null === $activationStrategy) {
            $activationStrategy = new ErrorLevelActivationStrategy(Logger::WARNING);
        }
 
        // convert simple int activationStrategy to an object
        if (!$activationStrategy instanceof ActivationStrategyInterface) {
            $activationStrategy = new ErrorLevelActivationStrategy($activationStrategy);
        }
 
        $this->handler = $handler;
        $this->activationStrategy = $activationStrategy;
        $this->bufferSize = $bufferSize;
        $this->bubble = $bubble;
        $this->stopBuffering = $stopBuffering;
 
        if ($passthruLevel !== null) {
            $this->passthruLevel = Logger::toMonologLevel($passthruLevel);
        }
 
        if (!$this->handler instanceof HandlerInterface && !is_callable($this->handler)) {
            throw new \RuntimeException("The given handler (".json_encode($this->handler).") is not a callable nor a Monolog\Handler\HandlerInterface object");
        }
    }

References Monolog\Handler\FingersCrossedHandler\$activationStrategy, Monolog\Handler\AbstractHandler\$bubble, Monolog\Handler\FingersCrossedHandler\$bufferSize, Monolog\Handler\FingersCrossedHandler\$handler, Monolog\Handler\FingersCrossedHandler\$passthruLevel, Monolog\Handler\FingersCrossedHandler\$stopBuffering, Monolog\Logger\toMonologLevel(), and Monolog\Logger\WARNING.

Here is the call graph for this function:

Member Function Documentation

activate()

Monolog\Handler\FingersCrossedHandler::activate

(

)

Manually activate this logger regardless of the activation strategy.

Definition at line 86 of file FingersCrossedHandler.php.

    {
        if ($this->stopBuffering) {
            $this->buffering = false;
        }
        if (!$this->handler instanceof HandlerInterface) {
            $record = end($this->buffer) ?: null;
 
            $this->handler = call_user_func($this->handler, $record, $this);
            if (!$this->handler instanceof HandlerInterface) {
                throw new \RuntimeException("The factory callable should return a HandlerInterface");
            }
        }
        $this->handler->handleBatch($this->buffer);
        $this->buffer = array();
    }

Referenced by Monolog\Handler\FingersCrossedHandler\handle().

Here is the caller graph for this function:

clear()

Monolog\Handler\FingersCrossedHandler::clear

(

)

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

It also resets the handler to its initial buffering state.

Definition at line 153 of file FingersCrossedHandler.php.

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

References Monolog\Handler\FingersCrossedHandler\reset().

Here is the call graph for this function:

close()

Monolog\Handler\FingersCrossedHandler::close

(

)

{Closes the handler.This will be called automatically when the object is destroyed}

Reimplemented from Monolog\Handler\AbstractHandler.

Definition at line 132 of file FingersCrossedHandler.php.

    {
        $this->flushBuffer();
    }

References Monolog\Handler\FingersCrossedHandler\flushBuffer().

Here is the call graph for this function:

flushBuffer()

Monolog\Handler\FingersCrossedHandler::flushBuffer ( )

private

Resets the state of the handler.

Stops forwarding records to the wrapped handler.

Definition at line 162 of file FingersCrossedHandler.php.

    {
        if (null !== $this->passthruLevel) {
            $level = $this->passthruLevel;
            $this->buffer = array_filter($this->buffer, function ($record) use ($level) {
                return $record['level'] >= $level;
            });
            if (count($this->buffer) > 0) {
                $this->handler->handleBatch($this->buffer);
            }
        }
 
        $this->buffer = array();
        $this->buffering = true;
    }

References Monolog\Handler\AbstractHandler\$level, and Monolog\Handler\FingersCrossedHandler\$passthruLevel.

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

Here is the caller graph for this function:

handle()

Monolog\Handler\FingersCrossedHandler::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 106 of file FingersCrossedHandler.php.

    {
        if ($this->processors) {
            foreach ($this->processors as $processor) {
                $record = call_user_func($processor, $record);
            }
        }
 
        if ($this->buffering) {
            $this->buffer[] = $record;
            if ($this->bufferSize > 0 && count($this->buffer) > $this->bufferSize) {
                array_shift($this->buffer);
            }
            if ($this->activationStrategy->isHandlerActivated($record)) {
                $this->activate();
            }
        } else {
            $this->handler->handle($record);
        }
 
        return false === $this->bubble;
    }

References Monolog\Handler\AbstractHandler\$bubble, and Monolog\Handler\FingersCrossedHandler\activate().

Here is the call graph for this function:

isHandling()

Monolog\Handler\FingersCrossedHandler::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

}}

Reimplemented from Monolog\Handler\AbstractHandler.

Definition at line 78 of file FingersCrossedHandler.php.

    {
        return true;
    }

reset()

Monolog\Handler\FingersCrossedHandler::reset

(

)

Reimplemented from Monolog\Handler\AbstractHandler.

Definition at line 137 of file FingersCrossedHandler.php.

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

References Monolog\Handler\FingersCrossedHandler\flushBuffer().

Referenced by Monolog\Handler\FingersCrossedHandler\clear().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$activationStrategy

Monolog\Handler\FingersCrossedHandler::$activationStrategy

protected

Definition at line 34 of file FingersCrossedHandler.php.

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

$buffer

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

protected

Definition at line 37 of file FingersCrossedHandler.php.

$buffering

Monolog\Handler\FingersCrossedHandler::$buffering = true

protected

Definition at line 35 of file FingersCrossedHandler.php.

$bufferSize

Monolog\Handler\FingersCrossedHandler::$bufferSize

protected

Definition at line 36 of file FingersCrossedHandler.php.

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

$handler

Monolog\Handler\FingersCrossedHandler::$handler

protected

Definition at line 33 of file FingersCrossedHandler.php.

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

$passthruLevel

Monolog\Handler\FingersCrossedHandler::$passthruLevel

protected

Definition at line 39 of file FingersCrossedHandler.php.

Referenced by Monolog\Handler\FingersCrossedHandler\__construct(), and Monolog\Handler\FingersCrossedHandler\flushBuffer().

$stopBuffering

Monolog\Handler\FingersCrossedHandler::$stopBuffering

protected

Definition at line 38 of file FingersCrossedHandler.php.

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

---

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

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