Monolog\Handler\AbstractProcessingHandler Class Reference

Base Handler class providing the Handler structure. More...

Inheritance diagram for Monolog\Handler\AbstractProcessingHandler:

Collaboration diagram for Monolog\Handler\AbstractProcessingHandler:

Public Member Functions
	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 Boolean 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...
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 Boolean } 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 ()

Protected Member Functions
	write (array $record)
	Writes the record down to the log of the implementing handler. More...
	processRecord (array $record)
	Processes a record. More...
Protected Member Functions inherited from Monolog\Handler\AbstractHandler
	getDefaultFormatter ()
	Gets the default formatter. More...

Additional Inherited Members
Protected Attributes inherited from Monolog\Handler\AbstractHandler
	$level = Logger::DEBUG
	$bubble = true
	$formatter
	$processors = array()

Detailed Description

Base Handler class providing the Handler structure.

Classes extending it should (in most cases) only implement write($record)

Author

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

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

Definition at line 22 of file AbstractProcessingHandler.php.

Member Function Documentation

handle()

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

Boolean 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 27 of file AbstractProcessingHandler.php.

References Monolog\Handler\AbstractHandler\$bubble, array, Monolog\Handler\AbstractHandler\getFormatter(), Monolog\Handler\AbstractHandler\isHandling(), Monolog\Handler\AbstractProcessingHandler\processRecord(), and Monolog\Handler\AbstractProcessingHandler\write().

Referenced by Monolog\Handler\RavenHandler\handleBatch(), Monolog\Handler\StreamHandlerTest\testWriteNonExistingAndNotCreatableFileResource(), Monolog\Handler\StreamHandlerTest\testWriteNonExistingAndNotCreatablePath(), Monolog\Handler\StreamHandlerTest\testWriteNonExistingFileResource(), and Monolog\Handler\StreamHandlerTest\testWriteNonExistingPath().

    {
        if (!$this->isHandling($record)) {
            return false;
        }

        $record = $this->processRecord($record);

        $record['formatted'] = $this->getFormatter()->format($record);

        $this->write($record);

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

Here is the call graph for this function:

Here is the caller graph for this function:

processRecord()

Monolog\Handler\AbstractProcessingHandler::processRecord ( array  $record )

protected

Processes a record.

Parameters

array

$record

Returns

array

Definition at line 56 of file AbstractProcessingHandler.php.

Referenced by Monolog\Handler\HipChatHandler\combineRecords(), Monolog\Handler\AbstractProcessingHandler\handle(), Monolog\Handler\MailHandler\handleBatch(), Monolog\Handler\RavenHandler\handleBatch(), Monolog\Handler\ChromePHPHandler\handleBatch(), and Monolog\Handler\AmqpHandler\handleBatch().

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

        return $record;
    }

Here is the caller graph for this function:

write()

Monolog\Handler\AbstractProcessingHandler::write ( array  $record )

abstractprotected

Writes the record down to the log of the implementing handler.

Parameters

array

$record

Returns

void

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

Here is the caller graph for this function:

---

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

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