Zend Framework » \Zend\Log\Writer\Syslog

Writes log messages to syslog

Methods

Constructor

__construct(array $params) : \Zend\Log\Writer\Syslog

Set options for a writer. Accepted options are: - filters: array of filters to add to this filter - formatter: formatter for this writer

Parameters

$params

array

Array of options; may include "application" and "facility" keys

Exceptions

`\Zend\Log\Exception\InvalidArgumentException`

Returns

\Zend\Log\Writer\Syslog

Add a filter specific to this writer.

addFilter(int | string | \Zend\Log\Filter\FilterInterface $filter, array $options) : \Zend\Log\Writer\AbstractWriter

Inherited

inherited_from	\Zend\Log\Writer\AbstractWriter::addFilter()

Parameters

$filter

intstring\Zend\Log\Filter\FilterInterface

$options

arraynull

Exceptions

`\Zend\Log\Exception\InvalidArgumentException`

Returns

\Zend\Log\Writer\AbstractWriter

Get filter instance

filterPlugin(string $name, array $options) : \Zend\Log\Filter\FilterInterface

Inherited

inherited_from	\Zend\Log\Writer\AbstractWriter::filterPlugin()

Parameters

$name

string

$options

arraynull

Returns

\Zend\Log\Filter\FilterInterface

Get formatter instance

formatterPlugin(string $name, array $options) : \Zend\Log\Formatter\FormatterInterface

Inherited

inherited_from	\Zend\Log\Writer\AbstractWriter::formatterPlugin()

Parameters

$name

string

$options

arraynull

Returns

\Zend\Log\Formatter\FormatterInterface

Get filter plugin manager

getFilterPluginManager() : \Zend\Log\Writer\FilterPluginManager

Inherited

inherited_from	\Zend\Log\Writer\AbstractWriter::getFilterPluginManager()

Returns

\Zend\Log\Writer\FilterPluginManager

Get formatter plugin manager

getFormatterPluginManager() : \Zend\Log\Writer\FormatterPluginManager

Inherited

inherited_from	\Zend\Log\Writer\AbstractWriter::getFormatterPluginManager()

Returns

\Zend\Log\Writer\FormatterPluginManager

Set application name

setApplicationName(string $appName) : \Zend\Log\Writer\Syslog

Parameters

$appName

string

Application name

Returns

\Zend\Log\Writer\Syslog

Set convert write errors to exception flag

setConvertWriteErrorsToExceptions(bool $convertErrors)

Inherited

inherited_from	\Zend\Log\Writer\AbstractWriter::setConvertWriteErrorsToExceptions()

Parameters

$convertErrors

bool

Set syslog facility

setFacility(int $facility) : \Zend\Log\Writer\Syslog

Parameters

$facility

int

Syslog facility

Exceptions

`\Zend\Log\Exception\InvalidArgumentException`	for invalid log facility

Returns

\Zend\Log\Writer\Syslog

Set filter plugin manager

setFilterPluginManager(string | \Zend\Log\Writer\FilterPluginManager $plugins) : \Zend\Log\Writer\self

Inherited

inherited_from	\Zend\Log\Writer\AbstractWriter::setFilterPluginManager()

Parameters

$plugins

string\Zend\Log\Writer\FilterPluginManager

Exceptions

`\Zend\Log\Exception\InvalidArgumentException`

Returns

\Zend\Log\Writer\self

Set a new formatter for this writer

setFormatter(string | \Zend\Log\Formatter\FormatterInterface $formatter, array $options) : \Zend\Log\Writer\self

Inherited

inherited_from	\Zend\Log\Writer\AbstractWriter::setFormatter()

Parameters

$formatter

string\Zend\Log\Formatter\FormatterInterface

$options

arraynull

Exceptions

`\Zend\Log\Exception\InvalidArgumentException`

Returns

\Zend\Log\Writer\self

Set formatter plugin manager

setFormatterPluginManager(string | \Zend\Log\Writer\FormatterPluginManager $plugins) : \Zend\Log\Writer\self

Inherited

inherited_from	\Zend\Log\Writer\AbstractWriter::setFormatterPluginManager()

Parameters

$plugins

string\Zend\Log\Writer\FormatterPluginManager

Exceptions

`\Zend\Log\Exception\InvalidArgumentException`

Returns

\Zend\Log\Writer\self

Close syslog.

shutdown() : void

Log a message to this writer.

write(array $event) : void

Inherited

inherited_from	\Zend\Log\Writer\AbstractWriter::write()

Parameters

$event

array

log data event

Write a message to syslog.

doWrite(array $event) : void

Parameters

$event

array

event data

Get formatter

getFormatter() : \Zend\Log\Formatter\FormatterInterface

Inherited

inherited_from	\Zend\Log\Writer\AbstractWriter::getFormatter()

Returns

\Zend\Log\Formatter\FormatterInterface

Check if the writer has a formatter

hasFormatter() : bool

Inherited

inherited_from	\Zend\Log\Writer\AbstractWriter::hasFormatter()

Returns

bool

Initialize syslog / set application name and facility

initializeSyslog() : void

Initialize values facilities

initializeValidFacilities() : void

Properties

Application name used by this syslog-writer instance

$appName : string

Use Zend\Stdlib\ErrorHandler to report errors during calls to write

$convertWriteErrorsToExceptions : bool

Inherited

inherited_from	\Zend\Log\Writer\AbstractWriter::$$convertWriteErrorsToExceptions

The default log priority - for unmapped custom priorities

$defaultPriority : string

Error level passed to Zend\Stdlib\ErrorHandler::start for errors reported during calls to write

$errorsToExceptionsConversionLevel : bool

Inherited

inherited_from	\Zend\Log\Writer\AbstractWriter::$$errorsToExceptionsConversionLevel

Facility used by this syslog-writer instance

$facility : int

Filter plugins

$filterPlugins : \Zend\Log\Writer\FilterPluginManager

Inherited

inherited_from	\Zend\Log\Writer\AbstractWriter::$$filterPlugins

Filter chain

$filters : \Zend\Log\Filter\FilterInterface[]

Inherited

inherited_from	\Zend\Log\Writer\AbstractWriter::$$filters

Formats the log message before writing

$formatter : \Zend\Log\Formatter\FormatterInterface

Inherited

inherited_from	\Zend\Log\Writer\AbstractWriter::$$formatter

Formatter plugins

$formatterPlugins : \Zend\Log\Writer\FormatterPluginManager

Inherited

inherited_from	\Zend\Log\Writer\AbstractWriter::$$formatterPlugins

Last application name set by a syslog-writer instance

$lastApplication : string

Last facility name set by a syslog-writer instance

$lastFacility : string

Maps Zend\Log priorities to PHP's syslog priorities

$priorities : array

Types of program available to logging of message

$validFacilities : array