Zend Framework
Back to top  

 Methods

Initializes a new instance of this class.

__construct(null | \Zend\Log\Writer\FirePhp\FirePhpInterface | array | \Traversable $instance) 

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

Parameters

$instance

null\Zend\Log\Writer\FirePhp\FirePhpInterfacearray\Traversable

An instance of FirePhpInterface that should be used for logging

Exceptions

\Zend\Log\Exception\InvalidArgumentException

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

Gets the FirePhpInterface instance that is used for logging.

getFirePhp() : \Zend\Log\Writer\FirePhp\FirePhpInterface

Exceptions

\Zend\Log\Exception\RuntimeException

Returns

\Zend\Log\Writer\FirePhp\FirePhpInterface

Get formatter plugin manager

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

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

Returns

\Zend\Log\Writer\FormatterPluginManager

Set convert write errors to exception flag

setConvertWriteErrorsToExceptions(bool $convertErrors) 
Inherited

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

Parameters

$convertErrors

bool

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

Sets the FirePhpInterface instance that is used for logging.

setFirePhp(\Zend\Log\Writer\FirePhp\FirePhpInterface $instance) : \Zend\Log\Writer\FirePhp

Parameters

$instance

\Zend\Log\Writer\FirePhp\FirePhpInterface

A FirePhpInterface instance to set.

Returns

\Zend\Log\Writer\FirePhp

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

Perform shutdown activities such as closing open resources

shutdown() : void
Inherited

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

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 the log.

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

 Properties

 

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

$convertWriteErrorsToExceptions : bool
Inherited

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

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
 

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
 

A FirePhpInterface instance that is used to log messages to.

$firephp : \Zend\Log\Writer\FirePhp\FirePhpInterface

 

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