Zend Framework » \Zend\Log\Writer\Stream

Methods

Constructor

__construct(string | resource | array | \Traversable $streamOrUrl, string | null $mode, null | string $logSeparator) : \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

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

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

Get log separator string

getLogSeparator() : string

Returns

string

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

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

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

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`

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

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

Separator between log entries

$logSeparator : string

Holds the PHP stream to log to.

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