Dom Class Reference

Inheritance diagram for Dom:

Public Member Functions
	__construct ( $xml, \Magento\Framework\Config\ValidationStateInterface $validationState, array $idAttributes=[], $typeAttributeName=null, $schemaFile=null, $errorFormat=self::ERROR_FORMAT_DEFAULT)
	merge ($xml)
	getDom ()
	validate ($schemaFileName, &$errors=[])
	setSchemaFile ($schemaFile)

Static Public Member Functions
static	validateDomDocument (\DOMDocument $dom, $schema, $errorFormat=self::ERROR_FORMAT_DEFAULT)

Data Fields
const	ROOT_NAMESPACE_PREFIX = 'x'
const	ERROR_FORMAT_DEFAULT = "%message%\nLine: %line%\n"

Protected Member Functions
	_mergeNode (\DOMElement $node, $parentPath)
	_isTextNode ($node)
	_mergeAttributes ($baseNode, $mergeNode)
	_getNodePathByParent (\DOMElement $node, $parentPath)
	_getMatchedNode ($nodePath)
	_initDom ($xml)

Protected Attributes
	$dom
	$nodeMergingConfig
	$typeAttributeName
	$schema
	$errorFormat
	$rootNamespace

Detailed Description

Class Dom

@SuppressWarnings(PHPMD.CouplingBetweenObjects) @api

Since

100.0.2

Definition at line 23 of file Dom.php.

Constructor & Destructor Documentation

__construct()

__construct	(		$xml,
		\Magento\Framework\Config\ValidationStateInterface	$validationState,
		array	$idAttributes = [],
			$typeAttributeName = null,
			$schemaFile = null,
			$errorFormat = self::ERROR_FORMAT_DEFAULT
	)

Build DOM with initial XML contents and specifying identifier attributes for merging

Format of $idAttributes: array('/xpath/to/some/node' => 'id_attribute_name') The path to ID attribute name should not include any attribute notations or modifiers – only node names

Parameters

string	$xml
\Magento\Framework\Config\ValidationStateInterface	$validationState
array	$idAttributes
string	$typeAttributeName
string	$schemaFile
string	$errorFormat

Definition at line 104 of file Dom.php.

      {
        $this->validationState = $validationState;
        $this->schema = $schemaFile;
        $this->nodeMergingConfig = new Dom\NodeMergingConfig(new Dom\NodePathMatcher(), $idAttributes);
        $this->typeAttributeName = $typeAttributeName;
        $this->errorFormat = $errorFormat;
        $this->dom = $this->_initDom($xml);
        $this->rootNamespace = $this->dom->lookupNamespaceUri($this->dom->namespaceURI);
    }

Member Function Documentation

_getMatchedNode()

_getMatchedNode (   $nodePath )

protected

Getter for node by path

Parameters

string

$nodePath

Exceptions

Definition at line 271 of file Dom.php.

    {
        $xPath = new \DOMXPath($this->dom);
        if ($this->rootNamespace) {
            $xPath->registerNamespace(self::ROOT_NAMESPACE_PREFIX, $this->rootNamespace);
        }
        $matchedNodes = $xPath->query($nodePath);
        $node = null;
        if ($matchedNodes->length > 1) {
            throw new \Magento\Framework\Exception\LocalizedException(
                new \Magento\Framework\Phrase(
                    "More than one node matching the query: %1, Xml is: %2",
                    [$nodePath, $this->dom->saveXML()]
                )
            );
        } elseif ($matchedNodes->length == 1) {
            $node = $matchedNodes->item(0);
        }
        return $node;
    }

_getNodePathByParent()

_getNodePathByParent ( \DOMElement  $node,   $parentPath  )

protected

Identify node path based on parent path and node attributes

Parameters

\DOMElement	$node
string	$parentPath

Returns

string

Definition at line 245 of file Dom.php.

    {
        $prefix = $this->rootNamespace === null ? '' : self::ROOT_NAMESPACE_PREFIX . ':';
        $path = $parentPath . '/' . $prefix . $node->tagName;
        $idAttribute = $this->nodeMergingConfig->getIdAttribute($path);
        if (is_array($idAttribute)) {
            $constraints = [];
            foreach ($idAttribute as $attribute) {
                $value = $node->getAttribute($attribute);
                $constraints[] = "@{$attribute}='{$value}'";
            }
            $path .= '[' . implode(' and ', $constraints) . ']';
        } elseif ($idAttribute && ($value = $node->getAttribute($idAttribute))) {
            $path .= "[@{$idAttribute}='{$value}']";
        }
        return $path;
    }

_initDom()

_initDom (   $xml )

protected

Create DOM document based on $xml parameter

Parameters

string

$xml

Returns

\DOMDocument

Exceptions

Definition at line 388 of file Dom.php.

    {
        $dom = new \DOMDocument();
        $useErrors = libxml_use_internal_errors(true);
        $res = $dom->loadXML($xml);
        if (!$res) {
            $errors = self::getXmlErrors($this->errorFormat);
            libxml_use_internal_errors($useErrors);
            throw new \Magento\Framework\Config\Dom\ValidationException(implode("\n", $errors));
        }
        libxml_use_internal_errors($useErrors);
        if ($this->validationState->isValidationRequired() && $this->schema) {
            $errors = $this->validateDomDocument($dom, $this->schema, $this->errorFormat);
            if (count($errors)) {
                throw new \Magento\Framework\Config\Dom\ValidationException(implode("\n", $errors));
            }
        }
        return $dom;
    }

_isTextNode()

_isTextNode (   $node )

protected

Check if the node content is text

Parameters

\DOMElement

$node

Returns

bool

Definition at line 219 of file Dom.php.

    {
        return $node->childNodes->length == 1 && $node->childNodes->item(0) instanceof \DOMText;
    }

_mergeAttributes()

_mergeAttributes (   $baseNode,   $mergeNode  )

protected

Merges attributes of the merge node to the base node

Parameters

\DOMElement	$baseNode
\DOMNode	$mergeNode

Returns

void

Definition at line 231 of file Dom.php.

    {
        foreach ($mergeNode->attributes as $attribute) {
            $baseNode->setAttribute($this->_getAttributeName($attribute), $attribute->value);
        }
    }

_mergeNode()

_mergeNode ( \DOMElement  $node,   $parentPath  )

protected

Recursive merging of the \DOMElement into the original document

Algorithm:

1. Find the same node in original document
2. Extend and override original document node attributes and scalar value if found
3. Append new node if original document doesn't have the same node

Parameters

\DOMElement	$node
string	$parentPath	path to parent node

Returns

void @SuppressWarnings(PHPMD.CyclomaticComplexity)

Definition at line 167 of file Dom.php.

    {
        $path = $this->_getNodePathByParent($node, $parentPath);

        $matchedNode = $this->_getMatchedNode($path);

        /* Update matched node attributes and value */
        if ($matchedNode) {
            //different node type
            if ($this->typeAttributeName &&
                $node->hasAttribute($this->typeAttributeName) &&
                $matchedNode->hasAttribute($this->typeAttributeName) &&
                $node->getAttribute($this->typeAttributeName) !== $matchedNode->getAttribute($this->typeAttributeName)
            ) {
                $parentMatchedNode = $this->_getMatchedNode($parentPath);
                $newNode = $this->dom->importNode($node, true);
                $parentMatchedNode->replaceChild($newNode, $matchedNode);
                return;
            }

            $this->_mergeAttributes($matchedNode, $node);
            if (!$node->hasChildNodes()) {
                return;
            }
            /* override node value */
            if ($this->_isTextNode($node)) {
                /* skip the case when the matched node has children, otherwise they get overridden */
                if (!$matchedNode->hasChildNodes() || $this->_isTextNode($matchedNode)) {
                    $matchedNode->nodeValue = $node->childNodes->item(0)->nodeValue;
                }
            } else {
                /* recursive merge for all child nodes */
                foreach ($node->childNodes as $childNode) {
                    if ($childNode instanceof \DOMElement) {
                        $this->_mergeNode($childNode, $path);
                    }
                }
            }
        } else {
            /* Add node as is to the document under the same parent element */
            $parentMatchedNode = $this->_getMatchedNode($parentPath);
            $newNode = $this->dom->importNode($node, true);
            $parentMatchedNode->appendChild($newNode);
        }
    }

getDom()

getDom

(

)

DOM document getter

Returns

\DOMDocument

Definition at line 376 of file Dom.php.

    {
        return $this->dom;
    }

merge()

merge

(

$xml

)

Merge $xml into DOM document

Parameters

string

$xml

Returns

void

Definition at line 148 of file Dom.php.

    {
        $dom = $this->_initDom($xml);
        $this->_mergeNode($dom->documentElement, '');
    }

setSchemaFile()

setSchemaFile

(

$schemaFile

)

Set schema file

Parameters

string

$schemaFile

Returns

$this

Definition at line 430 of file Dom.php.

    {
        $this->schema = $schemaFile;
        return $this;
    }

validate()

validate	(		$schemaFileName,
		&	$errors = []
	)

Validate self contents towards to specified schema

Parameters

string	$schemaFileName	absolute path to schema file
array	&$errors

Returns

bool

Definition at line 415 of file Dom.php.

    {
        if ($this->validationState->isValidationRequired()) {
            $errors = $this->validateDomDocument($this->dom, $schemaFileName, $this->errorFormat);
            return !count($errors);
        }
        return true;
    }

validateDomDocument()

static validateDomDocument ( \DOMDocument  $dom,   $schema,   $errorFormat = self::ERROR_FORMAT_DEFAULT  )

static

Validate dom document

Parameters

\DOMDocument	$dom
string	$schema	Absolute schema file path or URN
string	$errorFormat

Returns

array of errors

Exceptions

Definition at line 301 of file Dom.php.

      {
        if (!function_exists('libxml_set_external_entity_loader')) {
            return [];
        }

        if (!self::$urnResolver) {
            self::$urnResolver = new UrnResolver();
        }
        if (!isset(self::$resolvedSchemaPaths[$schema])) {
            self::$resolvedSchemaPaths[$schema] = self::$urnResolver->getRealPath($schema);
        }
        $schema = self::$resolvedSchemaPaths[$schema];

        libxml_use_internal_errors(true);
        libxml_set_external_entity_loader([self::$urnResolver, 'registerEntityLoader']);
        $errors = [];
        try {
            $result = $dom->schemaValidate($schema);
            if (!$result) {
                $errors = self::getXmlErrors($errorFormat);
            }
        } catch (\Exception $exception) {
            $errors = self::getXmlErrors($errorFormat);
            libxml_use_internal_errors(false);
            array_unshift($errors, new Phrase('Processed schema file: %1', [$schema]));
            throw new ValidationSchemaException(new Phrase(implode("\n", $errors)));
        }
        libxml_set_external_entity_loader(null);
        libxml_use_internal_errors(false);
        return $errors;
    }

Field Documentation

$dom

$dom

protected

Definition at line 45 of file Dom.php.

$errorFormat

$errorFormat

protected

Definition at line 71 of file Dom.php.

$nodeMergingConfig

$nodeMergingConfig

protected

Definition at line 50 of file Dom.php.

$rootNamespace

$rootNamespace

protected

Definition at line 78 of file Dom.php.

$schema

$schema

protected

Definition at line 64 of file Dom.php.

$typeAttributeName

$typeAttributeName

protected

Definition at line 57 of file Dom.php.

ERROR_FORMAT_DEFAULT

const ERROR_FORMAT_DEFAULT = "%message%\nLine: %line%\n"

Format of items in errors array to be used by default. Available placeholders - fields of \LibXMLError.

Definition at line 33 of file Dom.php.

ROOT_NAMESPACE_PREFIX

const ROOT_NAMESPACE_PREFIX = 'x'

Prefix which will be used for root namespace

Definition at line 28 of file Dom.php.

---

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

• vendor/magento/framework/Config/Dom.php