Xml Class Reference

Inheritance diagram for Xml:

Public Member Functions
	__construct (\Magento\Framework\Xml\Generator $xmlGenerator)
	getMimeType ()
	render ($data)

Data Fields
const	MIME_TYPE = 'application/xml'
const	XML_ROOT_NODE = 'response'
const	DEFAULT_ENTITY_ITEM_NAME = 'item'

Protected Member Functions
	_formatData ($data, $isRoot=false)
	_formatValue ($value)
	_prepareKey ($key)

Protected Attributes
	$_xmlGenerator

Detailed Description

Definition at line 10 of file Xml.php.

Constructor & Destructor Documentation

__construct()

__construct

(

\Magento\Framework\Xml\Generator

$xmlGenerator

)

Initialize dependencies.

Parameters

\Magento\Framework\Xml\Generator

$xmlGenerator

Definition at line 37 of file Xml.php.

    {
        $this->_xmlGenerator = $xmlGenerator;
    }

Member Function Documentation

_formatData()

_formatData (   $data,   $isRoot = false  )

protected

Reformat mixed data to multidimensional array.

This method is recursive.

Parameters

array | \Magento\Framework\DataObject	$data
bool	$isRoot

Returns

array

Exceptions

Definition at line 77 of file Xml.php.

    {
        if (!is_array($data) && !is_object($data)) {
            if ($isRoot) {
                return $this->_formatValue($data);
            }
        } elseif ($data instanceof \Magento\Framework\DataObject) {
            $data = $data->toArray();
        } else {
            $data = (array)$data;
        }
        $isAssoc = !preg_match('/^\d+$/', implode(array_keys($data), ''));

        $formattedData = [];
        foreach ($data as $key => $value) {
            $value = is_array($value) || is_object($value) ? $this->_formatData($value) : $this->_formatValue($value);
            if ($isAssoc) {
                $formattedData[$this->_prepareKey($key)] = $value;
            } else {
                $formattedData[] = $value;
            }
        }
        return $formattedData;
    }

_formatValue()

_formatValue (   $value )

protected

Prepare value in contrast with key.

Parameters

string

$value

Returns

string

Without the following transformation boolean values are rendered incorrectly

Definition at line 108 of file Xml.php.

    {
        if (is_bool($value)) {
            $value = $value ? 'true' : 'false';
        }
        $replacementMap = ['&' => '&'];
        return str_replace(array_keys($replacementMap), array_values($replacementMap), $value);
    }

_prepareKey()

_prepareKey (   $key )

protected

Format array key or field name to be valid array key name.

Replaces characters that are invalid in array key names.

Parameters

string

$key

Returns

string

Definition at line 126 of file Xml.php.

    {
        $replacementMap = [
            '!' => '',
            '"' => '',
            '#' => '',
            '$' => '',
            '%' => '',
            '&' => '',
            '\'' => '',
            '(' => '',
            ')' => '',
            '*' => '',
            '+' => '',
            ',' => '',
            '/' => '',
            ';' => '',
            '<' => '',
            '=' => '',
            '>' => '',
            '?' => '',
            '@' => '',
            '[' => '',
            '\\' => '',
            ']' => '',
            '^' => '',
            '`' => '',
            '{' => '',
            '|' => '',
            '}' => '',
            '~' => '',
            ' ' => '_',
            ':' => '_',
        ];
        $key = str_replace(array_keys($replacementMap), array_values($replacementMap), $key);
        $key = trim($key, '_');
        $prohibitedTagPattern = '/^[0-9,.-]/';
        if (preg_match($prohibitedTagPattern, $key)) {
            $key = self::DEFAULT_ENTITY_ITEM_NAME . '_' . $key;
        }
        return $key;
    }

getMimeType()

getMimeType

(

)

Get XML renderer MIME type.

Returns

string

Implements RendererInterface.

Definition at line 47 of file Xml.php.

    {
        return self::MIME_TYPE;
    }

render()

render

(

$data

)

Format object|array to valid XML.

Parameters

object | array | int | string | bool | float | null

$data

Returns

string

Wrap response in a single node.

Implements RendererInterface.

Definition at line 58 of file Xml.php.

    {
        $formattedData = $this->_formatData($data, true);
        $formattedData = [self::XML_ROOT_NODE => $formattedData];
        $this->_xmlGenerator->setIndexedArrayItemName(self::DEFAULT_ENTITY_ITEM_NAME)->arrayToXml($formattedData);
        return $this->_xmlGenerator->getDom()->saveXML();
    }

Field Documentation

$_xmlGenerator

$_xmlGenerator

protected

Definition at line 30 of file Xml.php.

DEFAULT_ENTITY_ITEM_NAME

const DEFAULT_ENTITY_ITEM_NAME = 'item'

This value is used to replace numeric keys while formatting data for XML output.

Definition at line 25 of file Xml.php.

MIME_TYPE

const MIME_TYPE = 'application/xml'

Renderer mime type.

Definition at line 15 of file Xml.php.

XML_ROOT_NODE

const XML_ROOT_NODE = 'response'

Root node in XML output.

Definition at line 20 of file Xml.php.

---

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

• vendor/magento/framework/Webapi/Rest/Response/Renderer/Xml.php