Monolog\Handler\SyslogHandler Class Reference

Logs to syslog service. More...

Inheritance diagram for Monolog\Handler\SyslogHandler:

Collaboration diagram for Monolog\Handler\SyslogHandler:

Public Member Functions
	__construct ($ident, $facility=LOG_USER, $level=Logger::DEBUG, $bubble=true, $logopts=LOG_PID)
	close ()
	{} More...
Public Member Functions inherited from Monolog\Handler\AbstractSyslogHandler
	__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
	write (array $record)
	{} More...
Protected Member Functions inherited from Monolog\Handler\AbstractSyslogHandler
	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
	$ident
	$logopts
Protected Attributes inherited from Monolog\Handler\AbstractSyslogHandler
	$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

Logs to syslog service.

usage example:

$log = new Logger('application'); $syslog = new SyslogHandler('myfacility', 'local6'); $formatter = new LineFormatter("%channel%.%level_name%: %message% %extra%"); $syslog->setFormatter($formatter); $log->pushHandler($syslog);

Author

Sven Paulus sven@.nosp@m.karl.nosp@m.sruhe.nosp@m..org

Definition at line 29 of file SyslogHandler.php.

Constructor & Destructor Documentation

__construct()

Monolog\Handler\SyslogHandler::__construct	(		$ident,
			$facility = LOG_USER,
			$level = Logger::DEBUG,
			$bubble = true,
			$logopts = LOG_PID
	)

Parameters

string	$ident
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
int	$logopts	Option flags for the openlog() call, defaults to LOG_PID

Definition at line 41 of file SyslogHandler.php.

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

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

        $this->ident = $ident;
        $this->logopts = $logopts;
    }

Member Function Documentation

close()

Monolog\Handler\SyslogHandler::close

(

)

{}

Definition at line 52 of file SyslogHandler.php.

    {
        closelog();
    }

write()

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

protected

{}

Definition at line 60 of file SyslogHandler.php.

    {
        if (!openlog($this->ident, $this->logopts, $this->facility)) {
            throw new \LogicException('Can\'t open syslog for ident "'.$this->ident.'" and facility "'.$this->facility.'"');
        }
        syslog($this->logLevels[$record['level']], (string) $record['formatted']);
    }

Field Documentation

$ident

Monolog\Handler\SyslogHandler::$ident

protected

Definition at line 31 of file SyslogHandler.php.

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

$logopts

Monolog\Handler\SyslogHandler::$logopts

protected

Definition at line 32 of file SyslogHandler.php.

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

---

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

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