Log/Writer/Syslog.php

Show: PublicProtectedPrivateinherited
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 license@zend.com 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

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

>VPropertyprotectedstring $_application = 'Zend_Log'
Application name used by this syslog-writer instance
Default value'Zend_Log'Details
Type
string
>VPropertyprotectedstring $_defaultPriority = LOG_NOTICE
The default log priority - for unmapped custom priorities
Default valueLOG_NOTICEDetails
Type
string
>VPropertyprotectedint $_facility = LOG_USER
Facility used by this syslog-writer instance
Default valueLOG_USERDetails
Type
int
>VPropertyprotectedarray $_filters = array()
inherited

of Zend_Log_Filter_Interface

Inherited from: \Zend_Log_Writer_Abstract::$$_filters
Default valuearray()Details
Type
array
Inherited_from
\Zend_Log_Writer_Abstract::$$_filters  
>VPropertyprotected\Zend_Log_Formatter_Interface $_formatter
inherited
Formats the log message before writing.
Inherited from: \Zend_Log_Writer_Abstract::$$_formatter
>VPropertyprotectedstring $_lastApplication
static
Last application name set by a syslog-writer instance
Details
Type
string
>VPropertyprotectedstring $_lastFacility
static
Last facility name set by a syslog-writer instance
Details
Type
string
>VPropertyprotectedarray $_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
>VPropertyprotectedarray $_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
NameTypeDescription
$paramsarray

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
NameTypeDescription
$configarray | \Zend_Config

Zend_Config or Array

Returns
TypeDescription
array
Throws
ExceptionDescription
\Zend_Log_Exception
methodprotected_write(array $event) : void

Write a message to syslog.

Parameters
NameTypeDescription
$eventarray

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
NameTypeDescription
$filter\Zend_Log_Filter_Interface
Returns
TypeDescription
\Zend_Log_Writer_Abstract
methodpublicfactory(array | \Zend_Config $config) : \Zend_Log_Writer_Syslog
static

Create a new instance of Zend_Log_Writer_Syslog

Parameters
NameTypeDescription
$configarray | \Zend_Config
Returns
TypeDescription
\Zend_Log_Writer_Syslog
methodpublicsetApplicationName(string $application) : \Zend_Log_Writer_Syslog

Set application name

Parameters
NameTypeDescription
$applicationstring

Application name

Returns
TypeDescription
\Zend_Log_Writer_Syslog
methodpublicsetFacility(int $facility) : \Zend_Log_Writer_Syslog

Set syslog facility

Parameters
NameTypeDescription
$facilityint

Syslog facility

Returns
TypeDescription
\Zend_Log_Writer_Syslog
Throws
ExceptionDescription
\Zend_Log_Exceptionfor 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
NameTypeDescription
$formatter\Zend_Log_Formatter_Interface
Returns
TypeDescription
\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
NameTypeDescription
$eventarray

log data event

Documentation was generated by phpDocumentor 2.0.0a12.