Log.php

Show:

inherited

Classes
- \Zend_Log

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
Version: $Id: Log.php 25131 2012-11-16 15:29:18Z rob $

\Zend_Log
jump to top

Package: Zend\Log

Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Version: $Id: Log.php 25131 2012-11-16 15:29:18Z rob $

Constants

 
                EMERG
                = 0

 
                ALERT
                = 1

 
                CRIT
                = 2

 
                ERR
                = 3

 
                WARN
                = 4

 
                NOTICE
                = 5

 
                INFO
                = 6

 
                DEBUG
                = 7

Properties

string $_defaultFilterNamespace = 'Zend_Log_Filter'

Default value'Zend_Log_Filter'Details

Type: string

string $_defaultFormatterNamespace = 'Zend_Log_Formatter'

Default value'Zend_Log_Formatter'Details

Type: string

string $_defaultWriterNamespace = 'Zend_Log_Writer'

Default value'Zend_Log_Writer'Details

Type: string

array|boolean $_errorHandlerMap = false

Default valuefalseDetails

Type: array | boolean

array $_extras = array()

of extra log event

Default valuearray()Details

Type: array

array $_filters = array()

of Zend_Log_Filter_Interface

Default valuearray()Details

Type: array

callback $_origErrorHandler = null

Default valuenullDetails

Type: callback

array $_priorities = array()

of priorities where the keys are the priority numbers and the values are the priority names

Default valuearray()Details

Type: array

boolean $_registeredErrorHandler = false

Default valuefalseDetails

Type: boolean

string $_timestampFormat = 'c'

Default value'c'Details

Type: string

array $_writers = array()

of Zend_Log_Writer_Abstract

Default valuearray()Details

Type: array

Methods

__call(string $method, string $params) : void

Undefined method handler allows a shortcut: $log->priorityName('message') instead of $log->log('message', Zend_Log::PRIORITY_NAME)

Parameters

Name	Type	Description
$method	string	priority name
$params	string	message to log

Throws

Exception	Description
\Zend_Log_Exception

__construct(\Zend_Log_Writer_Abstract | null $writer = null) : void

Class constructor.

Create a new logger

Parameters

Name	Type	Description
$writer	\Zend_Log_Writer_Abstract \| null	default writer

__destruct() : void

Class destructor.

Shutdown log writers

_constructFilterFromConfig(array | \Zend_Config $config) : \Zend_Log_Filter_Interface

Construct filter object from configuration array or Zend_Config object

Parameters

Name	Type	Description
$config	array \| \Zend_Config	Zend_Config or Array

Returns

Type	Description
\Zend_Log_Filter_Interface

Throws

Exception	Description
\Zend_Log_Exception

_constructFormatterFromConfig(array | \Zend_Config $config) : \Zend_Log_Formatter_Interface

Construct formatter object from configuration array or Zend_Config object

Parameters

Name	Type	Description
$config	array \| \Zend_Config	Zend_Config or Array

Returns

Type	Description
\Zend_Log_Formatter_Interface

Throws

Exception	Description
\Zend_Log_Exception

_constructFromConfig(string $type, mixed $config, string $namespace) : object

Construct a filter or writer from config

Parameters

Name	Type	Description
$type	string	'writer' of 'filter'
$config	mixed	Zend_Config or Array
$namespace	string

Returns

Type	Description
object

Throws

Exception	Description
\Zend_Log_Exception

_constructWriterFromConfig( $config) : \Zend_Log_Writer_Abstract

Construct a writer object based on a configuration array

Parameters

Name	Type	Description
$config

Returns

Type	Description
\Zend_Log_Writer_Abstract

Throws

Exception	Description
\Zend_Log_Exception

_packEvent(string $message, integer $priority) : array

Packs message and priority into Event array

Parameters

Name	Type	Description
$message	string	Message to log
$priority	integer	Priority of message

Returns

Type	Description
array	Event array

addFilter(int | \Zend_Config | array | \Zend_Log_Filter_Interface $filter) : \Zend_Log

Add a filter that will be applied before all log writers.

Before a message will be received by any of the writers, it must be accepted by all filters added with this method.

Parameters

Name	Type	Description
$filter	int \| \Zend_Config \| array \| \Zend_Log_Filter_Interface

Returns

Type	Description
\Zend_Log

Throws

Exception	Description
\Zend_Log_Exception

addPriority(string $name, integer $priority) : void

Add a custom priority

Parameters

Name	Type	Description
$name	string	Name of priority
$priority	integer	Numeric priority

Throws

Exception	Description
\Zend_Log_Exception

addWriter(mixed $writer) : \Zend_Log

Add a writer.

A writer is responsible for taking a log message and writing it out to storage.

Parameters

Name	Type	Description
$writer	mixed	Zend_Log_Writer_Abstract or Config array

Returns

Type	Description
\Zend_Log

errorHandler(int $errno, string $errstr, string $errfile, int $errline, array $errcontext) : boolean

Error Handler will convert error into log message, and then call the original error handler

Parameters

Name	Type	Description
$errno	int
$errstr	string
$errfile	string
$errline	int
$errcontext	array

Returns

Type	Description
boolean

Details

Link: Custom error handler

factory(array | \Zend_Config $config = array()) : \Zend_Log

static

Factory to construct the logger and one or more writers based on the configuration array

Parameters

Name	Type	Description
$config	array \| \Zend_Config	Array or instance of Zend_Config

Returns

Type	Description
\Zend_Log

Throws

Exception	Description
\Zend_Log_Exception

getClassName(array $config, string $type, string $defaultNamespace) : string

Get the writer or filter full classname

Parameters

Name	Type	Description
$config	array
$type	string	filter\|writer
$defaultNamespace	string

Returns

Type	Description
string	full classname

Throws

Exception	Description
\Zend_Log_Exception

getTimestampFormat() : string

Get timestamp format used for log entries.

Returns

Type	Description
string

log(string $message, integer $priority, mixed $extras = null) : void

Log a message at a priority

Parameters

Name	Type	Description
$message	string	Message to log
$priority	integer	Priority of message
$extras	mixed	Extra information to log in event

Throws

Exception	Description
\Zend_Log_Exception

registerErrorHandler() : \Zend_Log

Register Logging system as an error handler to log php errors Note: it still calls the original error handler if set_error_handler is able to return it.

Errors will be mapped as: E_NOTICE, E_USER_NOTICE => NOTICE E_WARNING, E_CORE_WARNING, E_USER_WARNING => WARN E_ERROR, E_USER_ERROR, E_CORE_ERROR, E_RECOVERABLE_ERROR => ERR E_DEPRECATED, E_STRICT, E_USER_DEPRECATED => DEBUG (unknown/other) => INFO

Returns

Type	Description
\Zend_Log

Details

Link: Custom error handler

setEventItem(string $name, string $value) : \Zend_Log

Set an extra item to pass to the log writers.

Parameters

Name	Type	Description
$name	string	Name of the field
$value	string	Value of the field

Returns

Type	Description
\Zend_Log

setTimestampFormat(string $format) : \Zend_Log

Set timestamp format for log entries.

Parameters

Name	Type	Description
$format	string

Returns

Type	Description
\Zend_Log

Log.php

\Zend_Logjump to top

Constants

Properties

Methods

\Zend_Log
jump to top