Parser Class Reference

Public Member Functions
	__construct ()
	initErrorHandler ()
	getDom ()
	xmlToArray ()
	load ($file)
	loadXML ($string)
	errorHandler ($errorNo, $errorStr, $errorFile, $errorLine)

Protected Member Functions
	_getCurrentDom ()
	_setCurrentDom ($node)
	_xmlToArray ($currentNode=false)

Protected Attributes
	$_dom = null
	$_currentDom
	$_content = []
	$errorHandlerIsActive = false

Detailed Description

Definition at line 8 of file Parser.php.

Constructor & Destructor Documentation

__construct()

__construct

(

)

Definition at line 33 of file Parser.php.

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

Member Function Documentation

_getCurrentDom()

_getCurrentDom ( )

protected

Returns

\DOMDocument

Definition at line 61 of file Parser.php.

    {
        return $this->_currentDom;
    }

_setCurrentDom()

_setCurrentDom (   $node )

protected

Parameters

\DOMDocument

$node

Returns

$this

Definition at line 70 of file Parser.php.

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

_xmlToArray()

_xmlToArray (   $currentNode = false )

protected

Parameters

bool

$currentNode

Returns

array @SuppressWarnings(PHPMD.CyclomaticComplexity) @SuppressWarnings(PHPMD.NPathComplexity)

Definition at line 91 of file Parser.php.

    {
        if (!$currentNode) {
            $currentNode = $this->getDom();
        }
        $content = '';
        foreach ($currentNode->childNodes as $node) {
            switch ($node->nodeType) {
                case XML_ELEMENT_NODE:
                    $content = $content ?: [];

                    $value = null;
                    if ($node->hasChildNodes()) {
                        $value = $this->_xmlToArray($node);
                    }
                    $attributes = [];
                    if ($node->hasAttributes()) {
                        foreach ($node->attributes as $attribute) {
                            $attributes += [$attribute->name => $attribute->value];
                        }
                        $value = ['_value' => $value, '_attribute' => $attributes];
                    }
                    if (isset($content[$node->nodeName])) {
                        if ((is_string($content[$node->nodeName]) || !isset($content[$node->nodeName][0]))
                            || (is_array($value) && !is_array($content[$node->nodeName][0]))
                        ) {
                            $oldValue = $content[$node->nodeName];
                            $content[$node->nodeName] = [];
                            $content[$node->nodeName][] = $oldValue;
                        }
                        $content[$node->nodeName][] = $value;
                    } else {
                        $content[$node->nodeName] = $value;
                    }
                    break;
                case XML_CDATA_SECTION_NODE:
                    $content = $node->nodeValue;
                    break;
                case XML_TEXT_NODE:
                    if (trim($node->nodeValue) !== '') {
                        $content = $node->nodeValue;
                    }
                    break;
            }
        }
        return $content;
    }

errorHandler()

errorHandler	(		$errorNo,
			$errorStr,
			$errorFile,
			$errorLine
	)

Custom XML lib error handler

Parameters

int	$errorNo
string	$errorStr
string	$errorFile
int	$errorLine

Exceptions

Definition at line 187 of file Parser.php.

    {
        if ($errorNo != 0) {
            $message = "{$errorStr} in {$errorFile} on line {$errorLine}";
            throw new \Magento\Framework\Exception\LocalizedException(new \Magento\Framework\Phrase($message));
        }
    }

getDom()

getDom

(

)

Returns

\DOMDocument|null

Definition at line 53 of file Parser.php.

    {
        return $this->_dom;
    }

initErrorHandler()

initErrorHandler

(

)

Initializes error handler

Returns

void

Definition at line 45 of file Parser.php.

    {
        $this->errorHandlerIsActive = true;
    }

load()

load

(

$file

)

Parameters

string

$file

Returns

$this

Definition at line 143 of file Parser.php.

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

loadXML()

loadXML

(

$string

)

Parameters

string

$string

Returns

$this

Exceptions

Definition at line 154 of file Parser.php.

    {
        if ($this->errorHandlerIsActive) {
            set_error_handler([$this, 'errorHandler']);
        }

        try {
            $this->getDom()->loadXML($string);
        } catch (\Magento\Framework\Exception\LocalizedException $e) {
            restore_error_handler();
            throw new \Magento\Framework\Exception\LocalizedException(
                new \Magento\Framework\Phrase($e->getMessage()),
                $e
            );
        }

        if ($this->errorHandlerIsActive) {
            restore_error_handler();
        }

        return $this;
    }

xmlToArray()

xmlToArray

(

)

Returns

array

Definition at line 79 of file Parser.php.

    {
        $this->_content = $this->_xmlToArray();
        return $this->_content;
    }

Field Documentation

$_content

$_content = []

protected

Definition at line 23 of file Parser.php.

$_currentDom

$_currentDom

protected

Definition at line 18 of file Parser.php.

$_dom

$_dom = null

protected

Definition at line 13 of file Parser.php.

$errorHandlerIsActive

$errorHandlerIsActive = false

protected

Definition at line 28 of file Parser.php.

---

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

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