Zend Framework
Back to top  

 Methods

Class constructor (the default encoding is UTF-8)

__construct(array | \Traversable $options) : \Zend\Log\Formatter\Xml

Parameters

$options

array\Traversable

Returns

\Zend\Log\Formatter\Xml

Formats data into a single line to be written by the writer.

format(array $event) : string

Parameters

$event

array

event data

Returns

stringformatted line to write to the log

Get the format specifier for DateTime objects

getDateTimeFormat() : string

Returns

string

Get encoding

getEncoding() : string

Returns

string

Get Escaper instance

getEscaper() : \Zend\Escaper\Escaper

Lazy-loads an instance with the current encoding if none registered.

Returns

\Zend\Escaper\Escaper

Set the format specifier for DateTime objects

setDateTimeFormat(string $dateTimeFormat) : \Zend\Log\Formatter\FormatterInterface

Parameters

$dateTimeFormat

string

DateTime format

Returns

\Zend\Log\Formatter\FormatterInterface

Set encoding

setEncoding(string $value) : \Zend\Log\Formatter\Xml

Parameters

$value

string

Returns

\Zend\Log\Formatter\Xml

Set Escaper instance

setEscaper(\Zend\Escaper\Escaper $escaper) : \Zend\Log\Formatter\Xml

Parameters

$escaper

\Zend\Escaper\Escaper

Returns

\Zend\Log\Formatter\Xml

Recursion function to create an xml tree structure out of array structure

buildElementTree(\DOMDocument $doc, \DOMElement $rootElement, \Zend\Log\Formatter\$mixedData $mixedData) : \Zend\Log\Formatter\DomElement

Parameters

$doc

\Zend\Log\Formatter\DomDocument
  • DomDocument where the current nodes will be generated

$rootElement

\Zend\Log\Formatter\DomElement
  • root element the tree will be attached to

$mixedData

\Zend\Log\Formatter\$mixedData

array|Traversable - mixedData

Returns

\Zend\Log\Formatter\DomElement$domElement - DOM Element with appended child nodes

 Properties

 

Format specifier for DateTime objects in event data (default: ISO 8601)

$dateTimeFormat : string

see \Zend\Log\Formatter\http://php.net/manual/en/function.date.php
 

<p>Relates XML elements to log data field keys.</p>

$elementMap : array

 

<p>Encoding to use in XML</p>

$encoding : string

 

<p>instance</p>

$escaper : \Zend\Escaper\Escaper

 

<p>Name of root element</p>

$rootElement : string

 Constants

 

Default format specifier for DateTime objects is ISO 8601

DEFAULT_DATETIME_FORMAT 
Inherited

see \Zend\Log\Formatter\http://php.net/manual/en/function.date.php
inherited_from \Zend\Log\Formatter\FormatterInterface::DEFAULT_DATETIME_FORMAT