Monolog\Handler\AbstractSyslogHandler Class Reference

Common syslog functionality. More...

Inheritance diagram for Monolog\Handler\AbstractSyslogHandler:

Collaboration diagram for Monolog\Handler\AbstractSyslogHandler:

Public Member Functions
	__construct ($facility=LOG_USER, $level=Logger::DEBUG, $bubble=true)
Public Member Functions inherited from 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 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...
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 Member Functions
	getDefaultFormatter ()
	{} More...
Protected Member Functions inherited from Monolog\Handler\AbstractProcessingHandler
	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...

Protected Attributes
	$facility
	$logLevels
	Translates Monolog log levels to syslog log priorities. More...
	$facilities
	List of valid log facility names. More...
Protected Attributes inherited from Monolog\Handler\AbstractHandler
	$level = Logger::DEBUG
	$bubble = true
	$formatter
	$processors = array()

Detailed Description

Common syslog functionality.

Definition at line 20 of file AbstractSyslogHandler.php.

Constructor & Destructor Documentation

__construct()

Monolog\Handler\AbstractSyslogHandler::__construct	(		$facility = LOG_USER,
			$level = Logger::DEBUG,
			$bubble = true
	)

Parameters

mixed	$facility
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 60 of file AbstractSyslogHandler.php.

References Monolog\Handler\AbstractHandler\$bubble, Monolog\Handler\AbstractSyslogHandler\$facility, and Monolog\Handler\AbstractHandler\$level.

    {
        parent::__construct($level, $bubble);

        if (!defined('PHP_WINDOWS_VERSION_BUILD')) {
            $this->facilities['local0'] = LOG_LOCAL0;
            $this->facilities['local1'] = LOG_LOCAL1;
            $this->facilities['local2'] = LOG_LOCAL2;
            $this->facilities['local3'] = LOG_LOCAL3;
            $this->facilities['local4'] = LOG_LOCAL4;
            $this->facilities['local5'] = LOG_LOCAL5;
            $this->facilities['local6'] = LOG_LOCAL6;
            $this->facilities['local7'] = LOG_LOCAL7;
        } else {
            $this->facilities['local0'] = 128; // LOG_LOCAL0
            $this->facilities['local1'] = 136; // LOG_LOCAL1
            $this->facilities['local2'] = 144; // LOG_LOCAL2
            $this->facilities['local3'] = 152; // LOG_LOCAL3
            $this->facilities['local4'] = 160; // LOG_LOCAL4
            $this->facilities['local5'] = 168; // LOG_LOCAL5
            $this->facilities['local6'] = 176; // LOG_LOCAL6
            $this->facilities['local7'] = 184; // LOG_LOCAL7
        }

        // convert textual description of facility to syslog constant
        if (array_key_exists(strtolower($facility), $this->facilities)) {
            $facility = $this->facilities[strtolower($facility)];
        } elseif (!in_array($facility, array_values($this->facilities), true)) {
            throw new \UnexpectedValueException('Unknown facility value "'.$facility.'" given');
        }

        $this->facility = $facility;
    }

Member Function Documentation

getDefaultFormatter()

Monolog\Handler\AbstractSyslogHandler::getDefaultFormatter ( )

protected

{}

Definition at line 97 of file AbstractSyslogHandler.php.

    {
        return new LineFormatter('%channel%.%level_name%: %message% %context% %extra%');
    }

Field Documentation

$facilities

Monolog\Handler\AbstractSyslogHandler::$facilities

protected

Initial value:

= array(
        'auth'     => LOG_AUTH,
        'authpriv' => LOG_AUTHPRIV,
        'cron'     => LOG_CRON,
        'daemon'   => LOG_DAEMON,
        'kern'     => LOG_KERN,
        'lpr'      => LOG_LPR,
        'mail'     => LOG_MAIL,
        'news'     => LOG_NEWS,
        'syslog'   => LOG_SYSLOG,
        'user'     => LOG_USER,
        'uucp'     => LOG_UUCP,
    )

List of valid log facility names.

Definition at line 41 of file AbstractSyslogHandler.php.

$facility

Monolog\Handler\AbstractSyslogHandler::$facility

protected

Definition at line 22 of file AbstractSyslogHandler.php.

Referenced by Monolog\Handler\SyslogUdpHandler\__construct(), Monolog\Handler\SyslogHandler\__construct(), Monolog\Handler\AbstractSyslogHandler\__construct(), and Monolog\Handler\SyslogUdpHandler\makeCommonSyslogHeader().

$logLevels

Monolog\Handler\AbstractSyslogHandler::$logLevels

protected

Initial value:

= array(
        Logger::DEBUG     => LOG_DEBUG,
        Logger::INFO      => LOG_INFO,
        Logger::NOTICE    => LOG_NOTICE,
        Logger::WARNING   => LOG_WARNING,
        Logger::ERROR     => LOG_ERR,
        Logger::CRITICAL  => LOG_CRIT,
        Logger::ALERT     => LOG_ALERT,
        Logger::EMERGENCY => LOG_EMERG,
    )

Translates Monolog log levels to syslog log priorities.

Definition at line 27 of file AbstractSyslogHandler.php.

---

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

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