Log/Writer/Syslog.php

Show: inherited
Table of Contents

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to [email protected] so we can send you a copy immediately.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Log  
Subpackage
Writer  
Version
$Id: Syslog.php 25024 2012-07-30 15:08:15Z rob $  

\Zend_Log_Writer_Syslog
jump to top

Package: Zend\Log\Writer

Writes log messages to syslog

Parent(s)
\Zend_Log_Writer_Abstract
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Version
$Id: Abstract.php 24593 2012-01-05 20:35:02Z matthew $  

Properties

Propertyprotectedstring $_application = 'Zend_Log'

Application name used by this syslog-writer instance

Default value'Zend_Log'Details
Type
string
Propertyprotectedstring $_defaultPriority = LOG_NOTICE

The default log priority - for unmapped custom priorities

Default valueLOG_NOTICEDetails
Type
string
Propertyprotectedint $_facility = LOG_USER

Facility used by this syslog-writer instance

Default valueLOG_USERDetails
Type
int
Propertyprotectedarray $_filters = array()
inherited

<p>of Zend_Log_Filter_Interface</p>Inherited from: \Zend_Log_Writer_Abstract::$$_filters
Default valuearray()Details
Type
array
Inherited_from
\Zend_Log_Writer_Abstract::$$_filters  
Propertyprotected\Zend_Log_Formatter_Interface $_formatter =
inherited

Formats the log message before writing.

Inherited from: \Zend_Log_Writer_Abstract::$$_formatter
Details
Type
\Zend_Log_Formatter_Interface
Inherited_from
\Zend_Log_Writer_Abstract::$$_formatter  
Propertyprotectedstring $_lastApplication =
static

Last application name set by a syslog-writer instance

Details
Type
string
Propertyprotectedstring $_lastFacility =
static

Last facility name set by a syslog-writer instance

Details
Type
string
Propertyprotectedarray $_priorities = 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)

Maps Zend_Log priorities to PHP's syslog priorities

Default valuearray(\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)Details
Type
array
Propertyprotectedarray $_validFacilities = array()

Types of program available to logging of message

Default valuearray()Details
Type
array

Methods

methodpublic__construct(array $params = array()) : void

Class constructor

Parameters
Name Type Description
$params array

Array of options; may include "application" and "facility" keys
methodprotected_initializeSyslog() : void

Initialize syslog / set application name and facility

methodprotected_initializeValidFacilities() : void

Initialize values facilities

methodprotected_parseConfig(array | \Zend_Config $config) : array
staticinherited

Validate and optionally convert the config to array

Inherited from: \Zend_Log_Writer_Abstract::_parseConfig()
Parameters
Name Type Description
$config array | \Zend_Config

Zend_Config or Array
Returns
Type Description
array
Throws
Exception Description
\Zend_Log_Exception
methodprotected_write(array $event) : void

Write a message to syslog.

Parameters
Name Type Description
$event array

event data
methodpublicaddFilter(\Zend_Log_Filter_Interface $filter) : \Zend_Log_Writer_Abstract
inherited

Add a filter specific to this writer.

Inherited from: \Zend_Log_Writer_Abstract::addFilter()
Parameters
Name Type Description
$filter \Zend_Log_Filter_Interface
Returns
Type Description
\Zend_Log_Writer_Abstract
methodpublicfactory(array | \Zend_Config $config) : \Zend_Log_Writer_Syslog
static

Create a new instance of Zend_Log_Writer_Syslog

Parameters
Name Type Description
$config array | \Zend_Config
Returns
Type Description
\Zend_Log_Writer_Syslog
methodpublicsetApplicationName(string $application) : \Zend_Log_Writer_Syslog

Set application name

Parameters
Name Type Description
$application string

Application name
Returns
Type Description
\Zend_Log_Writer_Syslog
methodpublicsetFacility(int $facility) : \Zend_Log_Writer_Syslog

Set syslog facility

Parameters
Name Type Description
$facility int

Syslog facility
Returns
Type Description
\Zend_Log_Writer_Syslog
Throws
Exception Description
\Zend_Log_Exception for invalid log facility
methodpublicsetFormatter(\Zend_Log_Formatter_Interface $formatter) : \Zend_Log_Writer_Abstract
inherited

Set a new formatter for this writer

Inherited from: \Zend_Log_Writer_Abstract::setFormatter()
Parameters
Name Type Description
$formatter \Zend_Log_Formatter_Interface
Returns
Type Description
\Zend_Log_Writer_Abstract
methodpublicshutdown() : void

Close syslog.

methodpublicwrite(array $event) : void
inherited

Log a message to this writer.

Inherited from: \Zend_Log_Writer_Abstract::write()
Parameters
Name Type Description
$event array

log data event
Documentation was generated by phpDocumentor 2.0.0a8.