Zend_Log_Writer_Syslog Class Reference

Inheritance diagram for Zend_Log_Writer_Syslog:

Public Member Functions
	__construct (array $params=array())
	setFacility ($facility)
	setApplicationName ($application)
	shutdown ()
Public Member Functions inherited from Zend_Log_Writer_Abstract
	addFilter ($filter)
	setFormatter (Zend_Log_Formatter_Interface $formatter)
	shutdown ()

Static Public Member Functions
static	factory ($config)

Protected Member Functions
	_initializeValidFacilities ()
	_initializeSyslog ()
	_write ($event)
Protected Member Functions inherited from Zend_Log_Writer_Abstract
	_write ($event)

Protected Attributes
	$_priorities
	$_defaultPriority = LOG_NOTICE
	$_application = 'Zend_Log'
	$_facility = LOG_USER
	$_validFacilities = array()
Protected Attributes inherited from Zend_Log_Writer_Abstract
	$_filters = array()
	$_formatter

Static Protected Attributes
static	$_lastApplication
static	$_lastFacility

Additional Inherited Members
Static Protected Member Functions inherited from Zend_Log_Writer_Abstract
static	_parseConfig ($config)

Detailed Description

Definition at line 38 of file Syslog.php.

Constructor & Destructor Documentation

__construct()

__construct

(

array

$params = array()

)

Class constructor

Parameters

array

$params

Array of options; may include "application" and "facility" keys

Returns

void

Definition at line 104 of file Syslog.php.

    {
        if (isset($params['application'])) {
            $this->_application = $params['application'];
        }

        $runInitializeSyslog = true;
        if (isset($params['facility'])) {
            $this->setFacility($params['facility']);
            $runInitializeSyslog = false;
        }

        if ($runInitializeSyslog) {
            $this->_initializeSyslog();
        }
    }

Member Function Documentation

_initializeSyslog()

_initializeSyslog ( )

protected

Initialize syslog / set application name and facility

Returns

void

Definition at line 173 of file Syslog.php.

    {
        self::$_lastApplication = $this->_application;
        self::$_lastFacility    = $this->_facility;
        openlog($this->_application, LOG_PID, $this->_facility);
    }

_initializeValidFacilities()

_initializeValidFacilities ( )

protected

Initialize values facilities

Returns

void

Definition at line 137 of file Syslog.php.

    {
        $constants = array(
            'LOG_AUTH',
            'LOG_AUTHPRIV',
            'LOG_CRON',
            'LOG_DAEMON',
            'LOG_KERN',
            'LOG_LOCAL0',
            'LOG_LOCAL1',
            'LOG_LOCAL2',
            'LOG_LOCAL3',
            'LOG_LOCAL4',
            'LOG_LOCAL5',
            'LOG_LOCAL6',
            'LOG_LOCAL7',
            'LOG_LPR',
            'LOG_MAIL',
            'LOG_NEWS',
            'LOG_SYSLOG',
            'LOG_USER',
            'LOG_UUCP'
        );

        foreach ($constants as $constant) {
            if (defined($constant)) {
                $this->_validFacilities[] = constant($constant);
            }
        }
    }

_write()

_write (   $event )

protected

Write a message to syslog.

Parameters

array

$event

event data

Returns

void

Definition at line 246 of file Syslog.php.

    {
        if (array_key_exists($event['priority'], $this->_priorities)) {
            $priority = $this->_priorities[$event['priority']];
        } else {
            $priority = $this->_defaultPriority;
        }

        if ($this->_application !== self::$_lastApplication
            || $this->_facility !== self::$_lastFacility)
        {
            $this->_initializeSyslog();
        }

        $message = $event['message'];
        if ($this->_formatter instanceof Zend_Log_Formatter_Interface) {
            $message = $this->_formatter->format($event);
        }

        syslog($priority, $message);
    }

factory()

static factory (   $config )

static

Create a new instance of Zend_Log_Writer_Syslog

Parameters

array | Zend_Config

$config

Returns

Zend_Log_Writer_Syslog

Implements Zend_Log_FactoryInterface.

Definition at line 127 of file Syslog.php.

    {
        return new self(self::_parseConfig($config));
    }

setApplicationName()

setApplicationName

(

$application

)

Set application name

Parameters

string

$application

Application name

Returns

Zend_Log_Writer_Syslog

Definition at line 220 of file Syslog.php.

    {
        if ($this->_application === $application) {
            return $this;
        }
        $this->_application = $application;
        $this->_initializeSyslog();
        return $this;
    }

setFacility()

setFacility

(

$facility

)

Set syslog facility

Parameters

int

$facility

Syslog facility

Returns

Zend_Log_Writer_Syslog

Exceptions

Zend_Log_Exception

for invalid log facility

Definition at line 187 of file Syslog.php.

    {
        if ($this->_facility === $facility) {
            return $this;
        }

        if (!count($this->_validFacilities)) {
            $this->_initializeValidFacilities();
        }

        if (!in_array($facility, $this->_validFacilities)) {
            #require_once 'Zend/Log/Exception.php';
            throw new Zend_Log_Exception('Invalid log facility provided; please see http://php.net/openlog for a list of valid facility values');
        }

        if ('WIN' == strtoupper(substr(PHP_OS, 0, 3))
            && ($facility !== LOG_USER)
        ) {
            #require_once 'Zend/Log/Exception.php';
            throw new Zend_Log_Exception('Only LOG_USER is a valid log facility on Windows');
        }

        $this->_facility = $facility;
        $this->_initializeSyslog();
        return $this;
    }

shutdown()

shutdown

(

)

Close syslog.

Returns

void

Definition at line 235 of file Syslog.php.

    {
        closelog();
    }

Field Documentation

$_application

$_application = 'Zend_Log'

protected

Definition at line 82 of file Syslog.php.

$_defaultPriority

$_defaultPriority = LOG_NOTICE

protected

Definition at line 61 of file Syslog.php.

$_facility

$_facility = LOG_USER

protected

Definition at line 89 of file Syslog.php.

$_lastApplication

$_lastApplication

staticprotected

Definition at line 68 of file Syslog.php.

$_lastFacility

$_lastFacility

staticprotected

Definition at line 75 of file Syslog.php.

$_priorities

$_priorities

protected

Initial value:

= array(
        Zend_Log::EMERG  => LOG_EMERG,
        Zend_Log::ALERT  => LOG_ALERT,
        Zend_Log::CRIT   => LOG_CRIT,
        Zend_Log::ERR    => LOG_ERR,
        Zend_Log::WARN   => LOG_WARNING,
        Zend_Log::NOTICE => LOG_NOTICE,
        Zend_Log::INFO   => LOG_INFO,
        Zend_Log::DEBUG  => LOG_DEBUG,
    )

Definition at line 45 of file Syslog.php.

$_validFacilities

$_validFacilities = array()

protected

Definition at line 96 of file Syslog.php.

---

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

• vendor/magento/zendframework1/library/Zend/Log/Writer/Syslog.php