API Documentation

Zend/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 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 24594 2012-01-05 21:27:01Z matthew $  

\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  

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
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'

Maps Zend_Log priorities to PHP's syslog priorities

Default valuearray( Zend_Log::EMERG => LOG_EMERGDetails
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_write( array $event ) : void

Write a message to syslog.

Parameters
Name Type Description
$event array

event data

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
methodpublicshutdown( ) : void

Close syslog.

Documentation was generated by DocBlox 0.15.1.