category Zend
package Zend_Log
subpackage Writer

 Methods

Constructor

__construct(string | resource | array | \Traversable $streamOrUrl, string | null $mode, null | string $logSeparator) : \Zend\Log\Writer\Stream

Parameters

$streamOrUrl

stringresourcearray\Traversable

Stream or URL to open as a stream

$mode

stringnull

Mode, only applicable if a URL is given

$logSeparator

nullstring

Log separator string

Exceptions

\Zend\Log\Exception\InvalidArgumentException
\Zend\Log\Exception\RuntimeException

Returns

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

$options

arraynull

Exceptions

\Zend\Log\Exception\InvalidArgumentException

Returns

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

Get filter plugin manager

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

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

Returns

Get log separator string

getLogSeparator() : string

Returns

string

Set convert write errors to exception flag

setConvertWriteErrorsToExceptions($convertErrors) 
Inherited

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

Parameters

$convertErrors

Set filter plugin manager

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

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

Parameters

Exceptions

\Zend\Log\Exception\InvalidArgumentException

Returns

\Zend\Log\Writer\self

Set a new formatter for this writer

setFormatter(\Zend\Log\Formatter\FormatterInterface $formatter) : \Zend\Log\Writer\self
Inherited

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

Parameters

Returns

\Zend\Log\Writer\self

Set log separator string

setLogSeparator(string $logSeparator) : \Zend\Log\Writer\Stream

Parameters

$logSeparator

string

Returns

Close the stream resource.

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

doWrite(array $event) : void

Parameters

$event

array

event data

Exceptions

\Zend\Log\Exception\RuntimeException

 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
 

Formats the log message before writing

$formatter : \Zend\Log\Formatter\FormatterInterface
Inherited

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

Separator between log entries

$logSeparator : string

 

Holds the PHP stream to log to.

$stream : null | \Zend\Log\Writer\stream