package Default
inherited_from \Zend\Log\Writer\AbstractWriter

 Methods

Constructor

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

Set options for a writer. Accepted options are:

  • filters: array of filters to add to this filter
  • formatter: formatter for this writer
inherited_from \Zend\Log\Writer\AbstractWriter::__construct()

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

\Zend\Log\Writer\Stream

Constructor

__construct(array|\Traversable $options = null
Inherited

Set options for a writer. Accepted options are:

  • filters: array of filters to add to this filter
  • formatter: formatter for this writer

Parameters

$options

array\Traversable

Exceptions

\Zend\Log\Exception\InvalidArgumentException

Add a filter specific to this writer.

addFilter(integer|string|\Zend\Log\Filter\FilterInterface $filter, array|null $options = null) : \Zend\Log\Writer\AbstractWriter
Inherited
inherited_from \Zend\Log\Writer\WriterInterface::addFilter()

Parameters

$filter

integerstring\Zend\Log\Filter\FilterInterface

$options

arraynull

Exceptions

\Zend\Log\Exception\InvalidArgumentException

Returns

\Zend\Log\Writer\AbstractWriter

Get filter instance

filterPlugin(string $name, array|null $options = null) : \Zend\Log\Filter\FilterInterface
Inherited

Parameters

$name

string

$options

arraynull

Returns

\Zend\Log\Filter\FilterInterface

Get formatter instance

formatterPlugin(string $name, array|null $options = null) : \Zend\Log\Formatter\FormatterInterface
Inherited

Parameters

$name

string

$options

arraynull

Returns

\Zend\Log\Formatter\FormatterInterface

Get filter plugin manager

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

Returns

\Zend\Log\Writer\FilterPluginManager

Get formatter plugin manager

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

Returns

\Zend\Log\Writer\FormatterPluginManager

Get log separator string

getLogSeparator() : string

Returns

string

Set convert write errors to exception flag

setConvertWriteErrorsToExceptions(boolean $convertErrors) 
Inherited

Parameters

$convertErrors

boolean

Set filter plugin manager

setFilterPluginManager(string|\Zend\Log\Writer\FilterPluginManager $plugins) : \Zend\Log\Writer\Stream
Inherited
fluent This method is part of a fluent interface and will return the same instance

Parameters

$plugins

string\Zend\Log\Writer\FilterPluginManager

Exceptions

\Zend\Log\Exception\InvalidArgumentException

Returns

\Zend\Log\Writer\Stream

Set a new formatter for this writer

setFormatter(string|\Zend\Log\Formatter\FormatterInterface $formatter, array|null $options = null) : \Zend\Log\Writer\Stream
Inherited
inherited_from \Zend\Log\Writer\WriterInterface::setFormatter()
fluent This method is part of a fluent interface and will return the same instance

Parameters

$formatter

string\Zend\Log\Formatter\FormatterInterface

$options

arraynull

Exceptions

\Zend\Log\Exception\InvalidArgumentException

Returns

\Zend\Log\Writer\Stream

Set formatter plugin manager

setFormatterPluginManager(string|\Zend\Log\Writer\FormatterPluginManager $plugins) : \Zend\Log\Writer\Stream
Inherited
fluent This method is part of a fluent interface and will return the same instance

Parameters

$plugins

string\Zend\Log\Writer\FormatterPluginManager

Exceptions

\Zend\Log\Exception\InvalidArgumentException

Returns

\Zend\Log\Writer\Stream

Set log separator string

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

Parameters

$logSeparator

string

Returns

\Zend\Log\Writer\Stream

Close the stream resource.

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

Perform shutdown activities such as closing open resources

shutdown() : void
Inherited
inherited_from \Zend\Log\Writer\WriterInterface::shutdown()

Log a message to this writer.

write(array $event) : void
Inherited
inherited_from \Zend\Log\Writer\WriterInterface::write()

Parameters

$event

array

log data event

Write a message to the log.

doWrite(array $event) : void
inherited_from \Zend\Log\Writer\AbstractWriter::doWrite()

Parameters

$event

array

event data

Exceptions

\Zend\Log\Exception\RuntimeException

Write a message to the log

doWrite(array $event) : void
Inherited

Parameters

$event

array

log data event

Get formatter

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

Returns

\Zend\Log\Formatter\FormatterInterface

Check if the writer has a formatter

hasFormatter() : boolean
Inherited

Returns

boolean

 Properties

 

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

$convertWriteErrorsToExceptions : boolean

Default

true
 

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

$errorsToExceptionsConversionLevel : boolean

Default

E_WARNING
 

Filter plugins

$filterPlugins : \Zend\Log\Writer\FilterPluginManager

Default

 

Filter chain

$filters : array<mixed,\Zend\Log\Filter\FilterInterface>

Default

array()
 

Formats the log message before writing

$formatter : \Zend\Log\Formatter\FormatterInterface

Default

 

Formatter plugins

$formatterPlugins : \Zend\Log\Writer\FormatterPluginManager

Default

 

Separator between log entries

$logSeparator : string

Default

PHP_EOL
 

Holds the PHP stream to log to.

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

Default

null