Zend Framework » \Zend\Log\Logger

Logging messages with a stack of backends

Methods

Constructor

__construct(array | \Traversable $options) : \Zend\Log\Logger

Set options for a logger. Accepted options are: - writers: array of writers to add to this logger - exceptionhandler: if true register this logger as exceptionhandler - errorhandler: if true register this logger as errorhandler

Parameters

$options

array\Traversable

Exceptions

`\Zend\Log\Exception\InvalidArgumentException`

Returns

\Zend\Log\Logger

Shutdown all writers

__destruct() : void

Add a processor to a logger

addProcessor(string | \Zend\Log\Processor\ProcessorInterface $processor, int $priority, array $options) : \Zend\Log\Logger

Parameters

$processor

string\Zend\Log\Processor\ProcessorInterface

$priority

int

$options

arraynull

Exceptions

`\Zend\Log\Exception\InvalidArgumentException`

Returns

\Zend\Log\Logger

Add a writer to a logger

addWriter(string | \Zend\Log\Writer\WriterInterface $writer, int $priority, array $options) : \Zend\Log\Logger

Parameters

$writer

string\Zend\Log\Writer\WriterInterface

$priority

int

$options

arraynull

Exceptions

`\Zend\Log\Exception\InvalidArgumentException`

Returns

\Zend\Log\Logger

alert()

alert(string $message, array | \Traversable $extra) : \Zend\Log\Logger

Parameters

$message

string

$extra

array\Traversable

Returns

\Zend\Log\Logger

crit()

crit(string $message, array | \Traversable $extra) : \Zend\Log\Logger

Parameters

$message

string

$extra

array\Traversable

Returns

\Zend\Log\Logger

debug()

debug(string $message, array | \Traversable $extra) : \Zend\Log\Logger

Parameters

$message

string

$extra

array\Traversable

Returns

\Zend\Log\Logger

emerg()

emerg(string $message, array | \Traversable $extra) : \Zend\Log\Logger

Parameters

$message

string

$extra

array\Traversable

Returns

\Zend\Log\Logger

err()

err(string $message, array | \Traversable $extra) : \Zend\Log\Logger

Parameters

$message

string

$extra

array\Traversable

Returns

\Zend\Log\Logger

Get processor plugin manager

getProcessorPluginManager() : \Zend\Log\ProcessorPluginManager

Returns

\Zend\Log\ProcessorPluginManager

Get processors

getProcessors() : \Zend\Stdlib\SplPriorityQueue

Returns

\Zend\Stdlib\SplPriorityQueue

Get writer plugin manager

getWriterPluginManager() : \Zend\Log\WriterPluginManager

Returns

\Zend\Log\WriterPluginManager

Get writers

getWriters() : \Zend\Stdlib\SplPriorityQueue

Returns

\Zend\Stdlib\SplPriorityQueue

info()

info(string $message, array | \Traversable $extra) : \Zend\Log\Logger

Parameters

$message

string

$extra

array\Traversable

Returns

\Zend\Log\Logger

Add a message as a log entry

log(int $priority, mixed $message, array | \Traversable $extra) : \Zend\Log\Logger

Parameters

$priority

int

$message

mixed

$extra

array\Traversable

Exceptions

`\Zend\Log\Exception\InvalidArgumentException`	if message can't be cast to string
`\Zend\Log\Exception\InvalidArgumentException`	if extra can't be iterated over
`\Zend\Log\Exception\RuntimeException`	if no log writer specified

Returns

\Zend\Log\Logger

notice()

notice(string $message, array | \Traversable $extra) : \Zend\Log\Logger

Parameters

$message

string

$extra

array\Traversable

Returns

\Zend\Log\Logger

Get processor instance

processorPlugin(string $name, array $options) : \Zend\Log\Processor\ProcessorInterface

Parameters

$name

string

$options

arraynull

Returns

\Zend\Log\Processor\ProcessorInterface

Register logging system as an error handler to log PHP errors

registerErrorHandler(\Zend\Log\Logger $logger, bool $continueNativeHandler) : mixed

link	http://www.php.net/manual/function.set-error-handler.php

Parameters

$logger

\Zend\Log\Logger

$continueNativeHandler

bool

Exceptions

`\Zend\Log\Exception\InvalidArgumentException`	if logger is null

Returns

mixedReturns result of set_error_handler

Register logging system as an exception handler to log PHP exceptions

registerExceptionHandler(\Zend\Log\Logger $logger) : bool

link	http://www.php.net/manual/en/function.set-exception-handler.php

Parameters

$logger

\Zend\Log\Logger

Exceptions

`\Zend\Log\Exception\InvalidArgumentException`	if logger is null

Returns

bool

Register a shutdown handler to log fatal errors

registerFatalErrorShutdownFunction(\Zend\Log\Logger $logger) : bool

link	http://www.php.net/manual/function.register-shutdown-function.php

Parameters

$logger

\Zend\Log\Logger

Returns

bool

Set processor plugin manager

setProcessorPluginManager(string | \Zend\Log\ProcessorPluginManager $plugins) : \Zend\Log\Logger

Parameters

$plugins

string\Zend\Log\ProcessorPluginManager

Exceptions

`\Zend\Log\Exception\InvalidArgumentException`

Returns

\Zend\Log\Logger

Set writer plugin manager

setWriterPluginManager(string | \Zend\Log\WriterPluginManager $plugins) : \Zend\Log\Logger

Parameters

$plugins

string\Zend\Log\WriterPluginManager

Exceptions

`\Zend\Log\Exception\InvalidArgumentException`

Returns

\Zend\Log\Logger

Set the writers

setWriters(\Zend\Stdlib\SplPriorityQueue $writers) : \Zend\Log\Logger

Parameters

$writers

\Zend\Stdlib\SplPriorityQueue

Exceptions

`\Zend\Log\Exception\InvalidArgumentException`

Returns

\Zend\Log\Logger

Unregister error handler

unregisterErrorHandler()

Unregister exception handler

unregisterExceptionHandler()

warn()

warn(string $message, array | \Traversable $extra) : \Zend\Log\Logger

Parameters

$message

string

$extra

array\Traversable

Returns

\Zend\Log\Logger

Get writer instance

writerPlugin(string $name, array $options) : \Zend\Log\Writer\WriterInterface

Parameters

$name

string

$options

arraynull

Returns

\Zend\Log\Writer\WriterInterface

Properties

Map native PHP errors to priority

$errorPriorityMap : array

List of priority code => priority (short) name

$priorities : array

Processor plugins

$processorPlugins : \Zend\Log\ProcessorPluginManager

Processors

$processors : \Zend\Stdlib\SplPriorityQueue

Registered error handler

$registeredErrorHandler : bool

Registered exception handler

$registeredExceptionHandler : bool

Registered shutdown error handler

$registeredFatalErrorShutdownFunction : bool

Writer plugins

$writerPlugins : \Zend\Log\WriterPluginManager

Writers

$writers : \Zend\Stdlib\SplPriorityQueue

Constants

ALERT

ALERT

CRIT

CRIT

DEBUG

DEBUG

EMERG

EMERG

const	int defined from the BSD Syslog message severities
link	http://tools.ietf.org/html/rfc3164

ERR

ERR

INFO

INFO

NOTICE

NOTICE

WARN

WARN