Zend_Log_Formatter_Xml Class Reference

Inheritance diagram for Zend_Log_Formatter_Xml:

Public Member Functions
	__construct ($options=array())
	getEncoding ()
	setEncoding ($value)
	format ($event)

Static Public Member Functions
static	factory ($options)

Protected Attributes
	$_rootElement
	$_elementMap
	$_encoding

Detailed Description

Definition at line 34 of file Xml.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$options = array()

)

Class constructor (the default encoding is UTF-8)

Parameters

array | Zend_Config

$options

Returns

void

Definition at line 58 of file Xml.php.

    {
        if ($options instanceof Zend_Config) {
            $options = $options->toArray();
        } elseif (!is_array($options)) {
            $args = func_get_args();

            $options = array(
                'rootElement' => array_shift($args)
            );

            if (count($args)) {
                $options['elementMap'] = array_shift($args);
            }

            if (count($args)) {
                $options['encoding'] = array_shift($args);
            }
        }

        if (!array_key_exists('rootElement', $options)) {
            $options['rootElement'] = 'logEntry';
        }

        if (!array_key_exists('encoding', $options)) {
            $options['encoding'] = 'UTF-8';
        }

        $this->_rootElement = $options['rootElement'];
        $this->setEncoding($options['encoding']);

        if (array_key_exists('elementMap', $options)) {
            $this->_elementMap  = $options['elementMap'];
        }
    }

Member Function Documentation

factory()

static factory (   $options )

static

Factory for Zend_Log_Formatter_Xml classe

Parameters

array | Zend_Config

$options

Returns

Zend_Log_Formatter_Xml

Implements Zend_Log_FactoryInterface.

Definition at line 100 of file Xml.php.

    {
        return new self($options);
    }

format()

format

(

$event

)

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

Parameters

array

$event

event data

Returns

string formatted line to write to the log

Implements Zend_Log_Formatter_Interface.

Definition at line 133 of file Xml.php.

    {
        if ($this->_elementMap === null) {
            $dataToInsert = $event;
        } else {
            $dataToInsert = array();
            foreach ($this->_elementMap as $elementName => $fieldKey) {
                $dataToInsert[$elementName] = $event[$fieldKey];
            }
        }

        $enc = $this->getEncoding();
        $dom = new DOMDocument('1.0', $enc);
        $elt = $dom->appendChild(new DOMElement($this->_rootElement));

        foreach ($dataToInsert as $key => $value) {
            if (empty($value)
                || is_scalar($value)
                || (is_object($value) && method_exists($value,'__toString'))
            ) {
                if($key == "message") {
                    $value = htmlspecialchars($value, ENT_COMPAT, $enc);
                }
                $elt->appendChild(new DOMElement($key, (string)$value));
            }
        }

        $xml = $dom->saveXML();
        $xml = preg_replace('/<\?xml version="1.0"( encoding="[^\"]*")?\?>\n/u', '', $xml);

        return $xml . PHP_EOL;
    }

getEncoding()

getEncoding

(

)

Get encoding

Returns

string

Definition at line 110 of file Xml.php.

    {
        return $this->_encoding;
    }

setEncoding()

setEncoding

(

$value

)

Set encoding

Parameters

string

$value

Returns

Zend_Log_Formatter_Xml

Definition at line 121 of file Xml.php.

    {
        $this->_encoding = (string) $value;
        return $this;
    }

Field Documentation

$_elementMap

$_elementMap

protected

Definition at line 44 of file Xml.php.

$_encoding

$_encoding

protected

Definition at line 49 of file Xml.php.

$_rootElement

$_rootElement

protected

Definition at line 39 of file Xml.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/zendframework1/library/Zend/Log/Formatter/Xml.php