Generator Class Reference

Public Member Functions
	__construct ()
	getDom ()
	arrayToXml ($content)
	__toString ()
	save ($file)
	setIndexedArrayItemName ($name)

Data Fields
const	DEFAULT_ENTITY_ITEM_NAME = 'item'

Protected Member Functions
	_getCurrentDom ()
	_setCurrentDom ($node)
	_getIndexedArrayItemName ()

Protected Attributes
	$_dom = null
	$_currentDom
	$_defaultIndexedArrayItemName

Detailed Description

Definition at line 8 of file Generator.php.

Constructor & Destructor Documentation

__construct()

__construct

(

)

Definition at line 33 of file Generator.php.

    {
        $this->_dom = new \DOMDocument('1.0');
        $this->_dom->formatOutput = true;
        $this->_currentDom = $this->_dom;
        return $this;
    }

Member Function Documentation

__toString()

__toString

(

)

Returns

string

Definition at line 115 of file Generator.php.

    {
        return $this->getDom()->saveXML();
    }

_getCurrentDom()

_getCurrentDom ( )

protected

Returns

\DOMDocument

Definition at line 52 of file Generator.php.

    {
        return $this->_currentDom;
    }

_getIndexedArrayItemName()

_getIndexedArrayItemName ( )

protected

Get xml node name to use instead of numeric index during numeric arrays conversion.

Returns

string

Definition at line 147 of file Generator.php.

    {
        return $this->_defaultIndexedArrayItemName ?? self::DEFAULT_ENTITY_ITEM_NAME;
    }

_setCurrentDom()

_setCurrentDom (   $node )

protected

Parameters

\DOMDocument

$node

Returns

$this

Definition at line 61 of file Generator.php.

    {
        $this->_currentDom = $node;
        return $this;
    }

arrayToXml()

arrayToXml

(

$content

)

Parameters

array

$content

Returns

$this

Exceptions

Definition at line 73 of file Generator.php.

    {
        $parentNode = $this->_getCurrentDom();
        if (!$content || !count($content)) {
            return $this;
        }
        foreach ($content as $_key => $_item) {
            $node = $this->getDom()->createElement(preg_replace('/[^\w-]/i', '', $_key));
            $parentNode->appendChild($node);
            if (is_array($_item) && isset($_item['_attribute'])) {
                if (is_array($_item['_value'])) {
                    if (isset($_item['_value'][0])) {
                        foreach ($_item['_value'] as $_v) {
                            $this->_setCurrentDom($node)->arrayToXml($_v);
                        }
                    } else {
                        $this->_setCurrentDom($node)->arrayToXml($_item['_value']);
                    }
                } else {
                    $child = $this->getDom()->createTextNode($_item['_value']);
                    $node->appendChild($child);
                }
                foreach ($_item['_attribute'] as $_attributeKey => $_attributeValue) {
                    $node->setAttribute($_attributeKey, $_attributeValue);
                }
            } elseif (is_string($_item)) {
                $text = $this->getDom()->createTextNode($_item);
                $node->appendChild($text);
            } elseif (is_array($_item) && !isset($_item[0])) {
                $this->_setCurrentDom($node)->arrayToXml($_item);
            } elseif (is_array($_item) && isset($_item[0])) {
                foreach ($_item as $v) {
                    $this->_setCurrentDom($node)->arrayToXml([$this->_getIndexedArrayItemName() => $v]);
                }
            }
        }
        return $this;
    }

getDom()

getDom

(

)

Returns

\DOMDocument|null

Definition at line 44 of file Generator.php.

    {
        return $this->_dom;
    }

save()

save

(

$file

)

Parameters

string

$file

Returns

$this

Definition at line 124 of file Generator.php.

    {
        $this->getDom()->save($file);
        return $this;
    }

setIndexedArrayItemName()

setIndexedArrayItemName

(

$name

)

Set xml node name to use instead of numeric index during numeric arrays conversion.

Parameters

string

$name

Returns

$this

Definition at line 136 of file Generator.php.

    {
        $this->_defaultIndexedArrayItemName = $name;
        return $this;
    }

Field Documentation

$_currentDom

$_currentDom

protected

Definition at line 23 of file Generator.php.

$_defaultIndexedArrayItemName

$_defaultIndexedArrayItemName

protected

Definition at line 28 of file Generator.php.

$_dom

$_dom = null

protected

Definition at line 18 of file Generator.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 13 of file Generator.php.

---

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

• vendor/magento/framework/Xml/Generator.php