Zend_Log Class Reference

Public Member Functions
	__construct (Zend_Log_Writer_Abstract $writer=null)
	__call ($method, $params)
	addPriority ($name, $priority)
	addFilter ($filter)
	addWriter ($writer)
	setEventItem ($name, $value)
	registerErrorHandler ()
	errorHandler ($errno, $errstr, $errfile, $errline, $errcontext)
	setTimestampFormat ($format)
	getTimestampFormat ()

Static Public Member Functions
static	factory ($config=array())

Data Fields
const	EMERG = 0
const	ALERT = 1
const	CRIT = 2
const	ERR = 3
const	WARN = 4
const	NOTICE = 5
const	INFO = 6
const	DEBUG = 7

Protected Member Functions
	_constructWriterFromConfig ($config)
	_constructFilterFromConfig ($config)
	_constructFormatterFromConfig ($config)
	_constructFromConfig ($type, $config, $namespace)
	getClassName ($config, $type, $defaultNamespace)
	_packEvent ($message, $priority)

Protected Attributes
	$_priorities = array()
	$_writers = array()
	$_filters = array()
	$_extras = array()
	$_defaultWriterNamespace = 'Zend_Log_Writer'
	$_defaultFilterNamespace = 'Zend_Log_Filter'
	$_defaultFormatterNamespace = 'Zend_Log_Formatter'
	$_origErrorHandler = null
	$_registeredErrorHandler = false
	$_errorHandlerMap = false
	$_timestampFormat = 'c'

Detailed Description

Definition at line 40 of file Log.php.

Constructor & Destructor Documentation

__construct()

__construct

(

Zend_Log_Writer_Abstract

$writer = null

)

Class constructor. Create a new logger

Parameters

Zend_Log_Writer_Abstract | null

$writer

default writer

Definition at line 119 of file Log.php.

    {
        $r = new ReflectionClass($this);
        $this->_priorities = array_flip($r->getConstants());

        if ($writer !== null) {
            $this->addWriter($writer);
        }
    }

Member Function Documentation

__call()

__call	(		$method,
			$params
	)

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

Parameters

string	$method	priority name
string	$params	message to log

Returns

void

Exceptions

Zend_Log_Exception

See also

Zend_Log_Exception

Zend_Log_Exception

Definition at line 381 of file Log.php.

    {
        $priority = strtoupper($method);
        if (($priority = array_search($priority, $this->_priorities)) !== false) {
            switch (count($params)) {
                case 0:
                    #require_once 'Zend/Log/Exception.php';
                    throw new Zend_Log_Exception('Missing log message');
                case 1:
                    $message = array_shift($params);
                    $extras = null;
                    break;
                default:
                    $message = array_shift($params);
                    $extras  = array_shift($params);
                    break;
            }
            $this->log($message, $priority, $extras);
        } else {
            #require_once 'Zend/Log/Exception.php';
            throw new Zend_Log_Exception('Bad log priority');
        }
    }

_constructFilterFromConfig()

_constructFilterFromConfig (   $config )

protected

Construct filter object from configuration array or Zend_Config object

Parameters

array | Zend_Config

$config

Zend_Config or Array

Returns

Zend_Log_Filter_Interface

Exceptions

Zend_Log_Exception

See also

Zend_Log_Exception

Definition at line 223 of file Log.php.

    {
        $filter = $this->_constructFromConfig('filter', $config, $this->_defaultFilterNamespace);

        if (!$filter instanceof Zend_Log_Filter_Interface) {
             $filterName = is_object($filter)
                         ? get_class($filter)
                         : 'The specified filter';
            #require_once 'Zend/Log/Exception.php';
            throw new Zend_Log_Exception("{$filterName} does not implement Zend_Log_Filter_Interface");
        }

        return $filter;
    }

_constructFormatterFromConfig()

_constructFormatterFromConfig (   $config )

protected

Construct formatter object from configuration array or Zend_Config object

Parameters

array | Zend_Config

$config

Zend_Config or Array

Returns

Zend_Log_Formatter_Interface

Exceptions

Zend_Log_Exception

See also

Zend_Log_Exception

Definition at line 246 of file Log.php.

    {
        $formatter = $this->_constructFromConfig('formatter', $config, $this->_defaultFormatterNamespace);

        if (!$formatter instanceof Zend_Log_Formatter_Interface) {
             $formatterName = is_object($formatter)
                         ? get_class($formatter)
                         : 'The specified formatter';
            #require_once 'Zend/Log/Exception.php';
            throw new Zend_Log_Exception($formatterName . ' does not implement Zend_Log_Formatter_Interface');
        }

        return $formatter;
    }

_constructFromConfig()

_constructFromConfig (   $type,   $config,   $namespace  )

protected

Construct a filter or writer from config

Parameters

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

Returns

object

Exceptions

Zend_Log_Exception

Definition at line 271 of file Log.php.

    {
        if ($config instanceof Zend_Config) {
            $config = $config->toArray();
        }

        if (!is_array($config) || empty($config)) {
            #require_once 'Zend/Log/Exception.php';
            throw new Zend_Log_Exception(
                'Configuration must be an array or instance of Zend_Config'
            );
        }

        $params    = isset($config[ $type .'Params' ]) ? $config[ $type .'Params' ] : array();
        $className = $this->getClassName($config, $type, $namespace);
        if (!class_exists($className)) {
            #require_once 'Zend/Loader.php';
            Zend_Loader::loadClass($className);
        }

        $reflection = new ReflectionClass($className);
        if (!$reflection->implementsInterface('Zend_Log_FactoryInterface')) {
            #require_once 'Zend/Log/Exception.php';
            throw new Zend_Log_Exception(
                $className . ' does not implement Zend_Log_FactoryInterface and can not be constructed from config.'
            );
        }

        return call_user_func(array($className, 'factory'), $params);
    }

_constructWriterFromConfig()

_constructWriterFromConfig (   $config )

protected

Construct a writer object based on a configuration array

Parameters

array

$config

config array with writer spec

Returns

Zend_Log_Writer_Abstract

Exceptions

Zend_Log_Exception

See also

Zend_Log_Exception

Definition at line 190 of file Log.php.

    {
        $writer = $this->_constructFromConfig('writer', $config, $this->_defaultWriterNamespace);

        if (!$writer instanceof Zend_Log_Writer_Abstract) {
            $writerName = is_object($writer)
                        ? get_class($writer)
                        : 'The specified writer';
            #require_once 'Zend/Log/Exception.php';
            throw new Zend_Log_Exception("{$writerName} does not extend Zend_Log_Writer_Abstract!");
        }

        if (isset($config['filterName'])) {
            $filter = $this->_constructFilterFromConfig($config);
            $writer->addFilter($filter);
        }

        if (isset($config['formatterName'])) {
            $formatter = $this->_constructFormatterFromConfig($config);
            $writer->setFormatter($formatter);
        }

        return $writer;
    }

_packEvent()

_packEvent (   $message,   $priority  )

protected

Packs message and priority into Event array

Parameters

string	$message	Message to log
integer	$priority	Priority of message

Returns

array Event array

Definition at line 345 of file Log.php.

    {
        return array_merge(array(
            'timestamp'    => date($this->_timestampFormat),
            'message'      => $message,
            'priority'     => $priority,
            'priorityName' => $this->_priorities[$priority]
            ),
            $this->_extras
        );
    }

addFilter()

addFilter

(

$filter

)

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

int | Zend_Config | array | Zend_Log_Filter_Interface

$filter

Returns

$this

Exceptions

Zend_Log_Exception

See also

Zend_Log_Filter_Priority

Zend_Log_Exception

Definition at line 501 of file Log.php.

    {
        if (is_int($filter)) {
            #require_once 'Zend/Log/Filter/Priority.php';
            $filter = new Zend_Log_Filter_Priority($filter);

        } elseif ($filter instanceof Zend_Config || is_array($filter)) {
            $filter = $this->_constructFilterFromConfig($filter);

        } elseif(! $filter instanceof Zend_Log_Filter_Interface) {
            #require_once 'Zend/Log/Exception.php';
            throw new Zend_Log_Exception('Invalid filter provided');
        }

        $this->_filters[] = $filter;
        return $this;
    }

addPriority()

addPriority	(		$name,
			$priority
	)

Add a custom priority

Parameters

string	$name	Name of priority
integer	$priority	Numeric priority

Returns

$this

Exceptions

Zend_Log_Exception

See also

Zend_Log_Exception

Definition at line 476 of file Log.php.

    {
        // Priority names must be uppercase for predictability.
        $name = strtoupper($name);

        if (isset($this->_priorities[$priority])
            || false !== array_search($name, $this->_priorities)) {
            #require_once 'Zend/Log/Exception.php';
            throw new Zend_Log_Exception('Existing priorities cannot be overwritten');
        }

        $this->_priorities[$priority] = $name;
        return $this;
    }

addWriter()

addWriter

(

$writer

)

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

Parameters

mixed

$writer

Zend_Log_Writer_Abstract or Config array

Returns

Zend_Log

Exceptions

Zend_Log_Exception

See also

Zend_Log_Exception

Definition at line 529 of file Log.php.

    {
        if (is_array($writer) || $writer instanceof  Zend_Config) {
            $writer = $this->_constructWriterFromConfig($writer);
        }

        if (!$writer instanceof Zend_Log_Writer_Abstract) {
            #require_once 'Zend/Log/Exception.php';
            throw new Zend_Log_Exception(
                'Writer must be an instance of Zend_Log_Writer_Abstract'
                . ' or you should pass a configuration array'
            );
        }

        $this->_writers[] = $writer;
        return $this;
    }

errorHandler()

errorHandler	(		$errno,
			$errstr,
			$errfile,
			$errline,
			$errcontext
	)

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

Custom error handler int $errno string $errstr string $errfile int $errline array $errcontext boolean

Definition at line 622 of file Log.php.

    {
        $errorLevel = error_reporting();

        if ($errorLevel & $errno) {
            if (isset($this->_errorHandlerMap[$errno])) {
                $priority = $this->_errorHandlerMap[$errno];
            } else {
                $priority = Zend_Log::INFO;
            }
            $this->log($errstr, $priority, array('errno'=>$errno, 'file'=>$errfile, 'line'=>$errline, 'context'=>$errcontext));
        }

        if ($this->_origErrorHandler !== null) {
            return call_user_func($this->_origErrorHandler, $errno, $errstr, $errfile, $errline, $errcontext);
        }
        return false;
    }

factory()

static factory (   $config = array() )

static

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

Parameters

array|Zend_Config

Array or instance of Zend_Config

Returns

Zend_Log

Exceptions

Zend_Log_Exception

See also

Zend_Log_Exception

Zend_Log_Exception

Definition at line 137 of file Log.php.

    {
        if ($config instanceof Zend_Config) {
            $config = $config->toArray();
        }

        if (!is_array($config) || empty($config)) {
            #require_once 'Zend/Log/Exception.php';
            throw new Zend_Log_Exception('Configuration must be an array or instance of Zend_Config');
        }

        if (array_key_exists('className', $config)) {
            $class = $config['className'];
            unset($config['className']);
        } else {
            $class = __CLASS__;
        }

        $log = new $class;

        if (!$log instanceof Zend_Log) {
            #require_once 'Zend/Log/Exception.php';
            throw new Zend_Log_Exception('Passed className does not belong to a descendant of Zend_Log');
        }

        if (array_key_exists('timestampFormat', $config)) {
            if (null != $config['timestampFormat'] && '' != $config['timestampFormat']) {
                $log->setTimestampFormat($config['timestampFormat']);
            }
            unset($config['timestampFormat']);
        }

        if (!is_array(current($config))) {
            $log->addWriter(current($config));
        } else {
            foreach($config as $writer) {
                $log->addWriter($writer);
            }
        }

        return $log;
    }

getClassName()

getClassName (   $config,   $type,   $defaultNamespace  )

protected

Get the writer or filter full classname

Parameters

array	$config
string	$type	filter|writer
string	$defaultNamespace

Returns

string full classname

Exceptions

Zend_Log_Exception

Definition at line 311 of file Log.php.

    {
        if (!isset($config[$type . 'Name'])) {
            #require_once 'Zend/Log/Exception.php';
            throw new Zend_Log_Exception("Specify {$type}Name in the configuration array");
        }

        $className = $config[$type . 'Name'];
        $namespace = $defaultNamespace;

        if (isset($config[$type . 'Namespace'])) {
            $namespace = $config[$type . 'Namespace'];
        }

        // PHP >= 5.3.0 namespace given?
        if (substr($namespace, -1) == '\\') {
            return $namespace . $className;
        }

        // empty namespace given?
        if (strlen($namespace) === 0) {
            return $className;
        }

        return $namespace . '_' . $className;
    }

getTimestampFormat()

getTimestampFormat

(

)

Get timestamp format used for log entries.

Returns

string

Definition at line 658 of file Log.php.

    {
        return $this->_timestampFormat;
    }

registerErrorHandler()

registerErrorHandler

(

)

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

Custom error handler Zend_Log

Definition at line 576 of file Log.php.

    {
        // Only register once.  Avoids loop issues if it gets registered twice.
        if ($this->_registeredErrorHandler) {
            return $this;
        }

        $this->_origErrorHandler = set_error_handler(array($this, 'errorHandler'));

        // Contruct a default map of phpErrors to Zend_Log priorities.
        // Some of the errors are uncatchable, but are included for completeness
        $this->_errorHandlerMap = array(
            E_NOTICE            => Zend_Log::NOTICE,
            E_USER_NOTICE       => Zend_Log::NOTICE,
            E_WARNING           => Zend_Log::WARN,
            E_CORE_WARNING      => Zend_Log::WARN,
            E_USER_WARNING      => Zend_Log::WARN,
            E_ERROR             => Zend_Log::ERR,
            E_USER_ERROR        => Zend_Log::ERR,
            E_CORE_ERROR        => Zend_Log::ERR,
            E_RECOVERABLE_ERROR => Zend_Log::ERR,
            E_STRICT            => Zend_Log::DEBUG,
        );
        // PHP 5.3.0+
        if (defined('E_DEPRECATED')) {
            $this->_errorHandlerMap['E_DEPRECATED'] = Zend_Log::DEBUG;
        }
        if (defined('E_USER_DEPRECATED')) {
            $this->_errorHandlerMap['E_USER_DEPRECATED'] = Zend_Log::DEBUG;
        }

        $this->_registeredErrorHandler = true;
        return $this;
    }

setEventItem()

setEventItem	(		$name,
			$value
	)

Set an extra item to pass to the log writers.

Parameters

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

Returns

Zend_Log

Definition at line 555 of file Log.php.

    {
        $this->_extras = array_merge($this->_extras, array($name => $value));
        return $this;
    }

setTimestampFormat()

setTimestampFormat

(

$format

)

Set timestamp format for log entries.

Parameters

string

$format

Returns

Zend_Log

Definition at line 647 of file Log.php.

    {
        $this->_timestampFormat = $format;
        return $this;
    }

Field Documentation

$_defaultFilterNamespace

$_defaultFilterNamespace = 'Zend_Log_Filter'

protected

Definition at line 82 of file Log.php.

$_defaultFormatterNamespace

$_defaultFormatterNamespace = 'Zend_Log_Formatter'

protected

Definition at line 88 of file Log.php.

$_defaultWriterNamespace

$_defaultWriterNamespace = 'Zend_Log_Writer'

protected

Definition at line 76 of file Log.php.

$_errorHandlerMap

$_errorHandlerMap = false

protected

Definition at line 106 of file Log.php.

$_extras

$_extras = array()

protected

Definition at line 70 of file Log.php.

$_filters

$_filters = array()

protected

Definition at line 65 of file Log.php.

$_origErrorHandler

$_origErrorHandler = null

protected

Definition at line 94 of file Log.php.

$_priorities

$_priorities = array()

protected

Definition at line 55 of file Log.php.

$_registeredErrorHandler

$_registeredErrorHandler = false

protected

Definition at line 100 of file Log.php.

$_timestampFormat

$_timestampFormat = 'c'

protected

Definition at line 112 of file Log.php.

$_writers

$_writers = array()

protected

Definition at line 60 of file Log.php.

ALERT

const ALERT = 1

Definition at line 43 of file Log.php.

CRIT

const CRIT = 2

Definition at line 44 of file Log.php.

DEBUG

const DEBUG = 7

Definition at line 49 of file Log.php.

EMERG

const EMERG = 0

Definition at line 42 of file Log.php.

ERR

const ERR = 3

Definition at line 45 of file Log.php.

INFO

const INFO = 6

Definition at line 48 of file Log.php.

NOTICE

const NOTICE = 5

Definition at line 47 of file Log.php.

WARN

const WARN = 4

Definition at line 46 of file Log.php.

---

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

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