Zend Framework
Back to top  

 Methods

Constructor

__construct(\Zend\Db\Adapter\Adapter | array | \Traversable $db, string $tableName, array $columnMap, string $separator) 

We used the Adapter instead of Zend\Db for a performance reason.

Parameters

$db

\Zend\Db\Adapter\Adapterarray\Traversable

$tableName

string

$columnMap

array

$separator

string

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

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

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

Remove reference to database adapter

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

Transform event into column for the db table

eventIntoColumn(array $event) : array

Parameters

$event

array

Returns

array

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

Map event into column using the $columnMap array

mapEventIntoColumn(array $event, array $columnMap) : array

Parameters

$event

array

$columnMap

array

Returns

array

Prepare the INSERT SQL statement

prepareInsert(\Zend\Db\Adapter\Adapter $db, string $tableName, array $fields) : string

Parameters

$db

\Zend\Db\Adapter\Adapter

$tableName

string

$fields

array

Returns

string

 Properties

 

Relates database columns names to log data field keys.

$columnMap : null | array

 

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

$convertWriteErrorsToExceptions : bool
Inherited

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

Db adapter instance

$db : \Zend\Db\Adapter\Adapter

 

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
 

Field separator for sub-elements

$separator : string

 

Table name

$tableName : string