Monolog\Handler\AbstractHandler Class Reference

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

Inheritance diagram for Monolog\Handler\AbstractHandler:

Collaboration diagram for Monolog\Handler\AbstractHandler:

Public Member Functions
	__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 ()
Public Member Functions inherited from Monolog\Handler\HandlerInterface
	handle (array $record)
	Handles a record. More...

Protected Member Functions
	getDefaultFormatter ()
	Gets the default formatter. More...

Protected Attributes
	$level = Logger::DEBUG
	$bubble = true
	$formatter
	$processors = array()

Detailed Description

Base Handler class providing the Handler structure.

Author

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

Definition at line 24 of file AbstractHandler.php.

Constructor & Destructor Documentation

__construct()

Monolog\Handler\AbstractHandler::__construct	(		$level = Logger::DEBUG,
			$bubble = true
	)

Parameters

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

Definition at line 39 of file AbstractHandler.php.

References Monolog\Handler\AbstractHandler\$bubble, Monolog\Handler\AbstractHandler\$level, and Monolog\Handler\AbstractHandler\setLevel().

    {
        $this->setLevel($level);
        $this->bubble = $bubble;
    }

Here is the call graph for this function:

__destruct()

Monolog\Handler\AbstractHandler::__destruct

(

)

Definition at line 167 of file AbstractHandler.php.

References Monolog\Handler\AbstractHandler\close().

    {
        try {
            $this->close();
        } catch (\Exception $e) {
            // do nothing
        } catch (\Throwable $e) {
            // do nothing
        }
    }

Here is the call graph for this function:

Member Function Documentation

close()

Monolog\Handler\AbstractHandler::close

(

)

Closes the handler.

This will be called automatically when the object is destroyed

Definition at line 68 of file AbstractHandler.php.

Referenced by Monolog\Handler\AbstractHandler\__destruct().

    {
    }

Here is the caller graph for this function:

getBubble()

Monolog\Handler\AbstractHandler::getBubble

(

)

Gets the bubbling behavior.

Returns

bool true means that this handler allows bubbling. false means that bubbling is not permitted.

Definition at line 162 of file AbstractHandler.php.

References Monolog\Handler\AbstractHandler\$bubble.

    {
        return $this->bubble;
    }

getDefaultFormatter()

Monolog\Handler\AbstractHandler::getDefaultFormatter ( )

protected

Gets the default formatter.

Returns

FormatterInterface

Definition at line 192 of file AbstractHandler.php.

Referenced by Monolog\Handler\AbstractHandler\getFormatter().

    {
        return new LineFormatter();
    }

Here is the caller graph for this function:

getFormatter()

Monolog\Handler\AbstractHandler::getFormatter

(

)

{Gets the formatter.

Returns

FormatterInterface

}

Implements Monolog\Handler\HandlerInterface.

Definition at line 110 of file AbstractHandler.php.

References Monolog\Handler\AbstractHandler\$formatter, and Monolog\Handler\AbstractHandler\getDefaultFormatter().

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

    {
        if (!$this->formatter) {
            $this->formatter = $this->getDefaultFormatter();
        }

        return $this->formatter;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getLevel()

Monolog\Handler\AbstractHandler::getLevel

(

)

Gets minimum logging level at which this handler will be triggered.

Returns

int

Definition at line 137 of file AbstractHandler.php.

References Monolog\Handler\AbstractHandler\$level.

    {
        return $this->level;
    }

handleBatch()

Monolog\Handler\AbstractHandler::handleBatch

(

array

$records

)

{Handles a set of records at once.

Parameters

array

$records

The records to handle (an array of record arrays)

}

Implements Monolog\Handler\HandlerInterface.

Definition at line 56 of file AbstractHandler.php.

References Monolog\Handler\HandlerInterface\handle().

    {
        foreach ($records as $record) {
            $this->handle($record);
        }
    }

Here is the call graph for this function:

isHandling()

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

}

Implements Monolog\Handler\HandlerInterface.

Definition at line 48 of file AbstractHandler.php.

References Monolog\Handler\AbstractHandler\$level.

Referenced by Monolog\Handler\AbstractProcessingHandler\handle(), Monolog\Handler\PsrHandler\handle(), Monolog\Handler\AmqpHandler\handleBatch(), and Monolog\Handler\HipChatHandler\handleBatch().

    {
        return $record['level'] >= $this->level;
    }

Here is the caller graph for this function:

popProcessor()

Monolog\Handler\AbstractHandler::popProcessor

(

)

{Removes the processor on top of the stack and returns it.

Returns

callable

}

Implements Monolog\Handler\HandlerInterface.

Definition at line 88 of file AbstractHandler.php.

    {
        if (!$this->processors) {
            throw new \LogicException('You tried to pop from an empty processor stack.');
        }

        return array_shift($this->processors);
    }

pushProcessor()

Monolog\Handler\AbstractHandler::pushProcessor

(

$callback

)

{Adds a processor in the stack.

Parameters

callable

$callback

Returns

self

}

Implements Monolog\Handler\HandlerInterface.

Definition at line 75 of file AbstractHandler.php.

Referenced by Monolog\LoggerTest\testProcessorsAreExecuted().

    {
        if (!is_callable($callback)) {
            throw new \InvalidArgumentException('Processors must be valid callables (callback or object with an __invoke method), '.var_export($callback, true).' given');
        }
        array_unshift($this->processors, $callback);

        return $this;
    }

Here is the caller graph for this function:

reset()

Monolog\Handler\AbstractHandler::reset

(

)

Implements Monolog\ResettableInterface.

Definition at line 178 of file AbstractHandler.php.

    {
        foreach ($this->processors as $processor) {
            if ($processor instanceof ResettableInterface) {
                $processor->reset();
            }
        }
    }

setBubble()

Monolog\Handler\AbstractHandler::setBubble

(

$bubble

)

Sets the bubbling behavior.

Parameters

bool

$bubble

true means that this handler allows bubbling. false means that bubbling is not permitted.

Returns

self

Definition at line 149 of file AbstractHandler.php.

References Monolog\Handler\AbstractHandler\$bubble.

    {
        $this->bubble = $bubble;

        return $this;
    }

setFormatter()

Monolog\Handler\AbstractHandler::setFormatter

(

FormatterInterface

$formatter

)

{Sets the formatter.

Parameters

FormatterInterface

$formatter

Returns

self

}

Implements Monolog\Handler\HandlerInterface.

Definition at line 100 of file AbstractHandler.php.

References Monolog\Handler\AbstractHandler\$formatter.

Referenced by Monolog\Handler\FirePHPHandlerTest\testConcurrentHandlers().

    {
        $this->formatter = $formatter;

        return $this;
    }

Here is the caller graph for this function:

setLevel()

Monolog\Handler\AbstractHandler::setLevel

(

$level

)

Sets minimum logging level at which this handler will be triggered.

Parameters

int | string

$level

Level or level name

Returns

self

Definition at line 125 of file AbstractHandler.php.

References Monolog\Handler\AbstractHandler\$level, and Monolog\Logger\toMonologLevel().

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

    {
        $this->level = Logger::toMonologLevel($level);

        return $this;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$bubble

Monolog\Handler\AbstractHandler::$bubble = true

protected

Definition at line 27 of file AbstractHandler.php.

Referenced by Monolog\Handler\CouchDBHandler\__construct(), Monolog\Handler\DoctrineCouchDBHandler\__construct(), Monolog\Handler\GroupHandler\__construct(), Monolog\Handler\MandrillHandler\__construct(), Monolog\Handler\MongoDBHandler\__construct(), Monolog\Handler\LogglyHandler\__construct(), Monolog\Handler\LogEntriesHandler\__construct(), Monolog\Handler\SwiftMailerHandler\__construct(), Monolog\Handler\SyslogUdpHandler\__construct(), Monolog\Handler\PsrHandler\__construct(), Monolog\Handler\ErrorLogHandler\__construct(), Monolog\Handler\AmqpHandler\__construct(), Monolog\Handler\CubeHandler\__construct(), Monolog\Handler\IFTTTHandler\__construct(), Monolog\Handler\InsightOpsHandler\__construct(), Monolog\Handler\GelfHandler\__construct(), Monolog\Handler\AbstractHandler\__construct(), Monolog\Handler\RedisHandler\__construct(), Monolog\Handler\SocketHandler\__construct(), Monolog\Handler\SyslogHandler\__construct(), Monolog\Handler\BufferHandler\__construct(), Monolog\Handler\StreamHandler\__construct(), Monolog\Handler\FlowdockHandler\__construct(), Monolog\Handler\RotatingFileHandler\__construct(), Monolog\Handler\ZendMonitorHandler\__construct(), Monolog\Handler\FleepHookHandler\__construct(), Monolog\Handler\FingersCrossedHandler\__construct(), Monolog\Handler\SlackbotHandler\__construct(), Monolog\Handler\SlackWebhookHandler\__construct(), Monolog\Handler\SlackHandler\__construct(), Monolog\Handler\ElasticSearchHandler\__construct(), Monolog\Handler\DynamoDbHandler\__construct(), Monolog\Handler\NewRelicHandler\__construct(), Monolog\Handler\AbstractSyslogHandler\__construct(), Monolog\Handler\RavenHandler\__construct(), Monolog\Handler\ChromePHPHandler\__construct(), Monolog\Handler\DeduplicationHandler\__construct(), Monolog\Handler\RollbarHandler\__construct(), Monolog\Handler\NativeMailerHandler\__construct(), Monolog\Handler\PHPConsoleHandler\__construct(), Monolog\Handler\PushoverHandler\__construct(), Monolog\Handler\HipChatHandler\__construct(), Monolog\Handler\AbstractHandler\getBubble(), Monolog\Handler\WhatFailureGroupHandler\handle(), Monolog\Handler\AbstractProcessingHandler\handle(), Monolog\Handler\PsrHandler\handle(), Monolog\Handler\BufferHandler\handle(), Monolog\Handler\GroupHandler\handle(), Monolog\Handler\SamplingHandler\handle(), Monolog\Handler\FingersCrossedHandler\handle(), Monolog\Handler\PHPConsoleHandler\handle(), Monolog\Handler\HipChatHandler\handleBatch(), and Monolog\Handler\AbstractHandler\setBubble().

$formatter

Monolog\Handler\AbstractHandler::$formatter

protected

Definition at line 32 of file AbstractHandler.php.

Referenced by Monolog\Handler\AbstractHandler\getFormatter(), Monolog\Handler\SlackWebhookHandler\getFormatter(), Monolog\Handler\SlackHandler\getFormatter(), Monolog\Handler\RavenHandler\setBatchFormatter(), and Monolog\Handler\AbstractHandler\setFormatter().

$level

Monolog\Handler\AbstractHandler::$level = Logger::DEBUG

protected

Definition at line 26 of file AbstractHandler.php.

Referenced by Monolog\Handler\TestHandler\__call(), Monolog\Handler\CouchDBHandler\__construct(), Monolog\Handler\DoctrineCouchDBHandler\__construct(), Monolog\Handler\NullHandler\__construct(), Monolog\Handler\MandrillHandler\__construct(), Monolog\Handler\MongoDBHandler\__construct(), Monolog\Handler\LogEntriesHandler\__construct(), Monolog\Handler\LogglyHandler\__construct(), Monolog\Handler\SwiftMailerHandler\__construct(), Monolog\Handler\SyslogUdpHandler\__construct(), Monolog\Handler\PsrHandler\__construct(), Monolog\Handler\ErrorLogHandler\__construct(), Monolog\Handler\AmqpHandler\__construct(), Monolog\Handler\CubeHandler\__construct(), Monolog\Handler\InsightOpsHandler\__construct(), Monolog\Handler\IFTTTHandler\__construct(), Monolog\Handler\GelfHandler\__construct(), Monolog\Handler\AbstractHandler\__construct(), Monolog\Handler\RedisHandler\__construct(), Monolog\Handler\SocketHandler\__construct(), Monolog\Handler\SyslogHandler\__construct(), Monolog\Handler\BufferHandler\__construct(), Monolog\Handler\StreamHandler\__construct(), Monolog\Handler\FlowdockHandler\__construct(), Monolog\Handler\RotatingFileHandler\__construct(), Monolog\Handler\ZendMonitorHandler\__construct(), Monolog\Handler\FleepHookHandler\__construct(), Monolog\Handler\SlackbotHandler\__construct(), Monolog\Handler\SlackWebhookHandler\__construct(), Monolog\Handler\SlackHandler\__construct(), Monolog\Handler\ElasticSearchHandler\__construct(), Monolog\Handler\DynamoDbHandler\__construct(), Monolog\Handler\NewRelicHandler\__construct(), Monolog\Handler\AbstractSyslogHandler\__construct(), Monolog\Handler\RavenHandler\__construct(), Monolog\Handler\ChromePHPHandler\__construct(), Monolog\Handler\RollbarHandler\__construct(), Monolog\Handler\PHPConsoleHandler\__construct(), Monolog\Handler\NativeMailerHandler\__construct(), Monolog\Handler\PushoverHandler\__construct(), Monolog\Handler\HipChatHandler\__construct(), Monolog\Handler\HipChatHandler\combineRecords(), Monolog\Handler\FingersCrossedHandler\flushBuffer(), Monolog\Handler\HipChatHandler\getAlertColor(), Monolog\Handler\SlackHandler\getAttachmentColor(), Monolog\Handler\AbstractHandler\getLevel(), Monolog\Handler\LogglyHandler\handleBatch(), Monolog\Handler\RavenHandler\handleBatch(), Monolog\Handler\TestHandler\hasRecord(), Monolog\Handler\TestHandler\hasRecords(), Monolog\Handler\TestHandler\hasRecordThatContains(), Monolog\Handler\TestHandler\hasRecordThatMatches(), Monolog\Handler\TestHandler\hasRecordThatPasses(), Monolog\Handler\DeduplicationHandler\isDuplicate(), Monolog\Handler\AbstractHandler\isHandling(), Monolog\Handler\FilterHandler\setAcceptedLevels(), Monolog\Handler\AbstractHandler\setLevel(), and Monolog\Handler\ZendMonitorHandler\writeZendMonitorCustomEvent().

$processors

Monolog\Handler\AbstractHandler::$processors = array()

protected

Definition at line 33 of file AbstractHandler.php.

---

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

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