AbstractXml Class Reference

Inheritance diagram for AbstractXml:

Public Member Functions
	__construct ( $configFiles, \Magento\Framework\Config\DomFactory $domFactory)
	getSchemaFile ()
	getPerFileSchemaFile ()

Protected Member Functions
	_extractData (\DOMDocument $dom)
	_merge ($configFiles)
	_performValidate ($file=null)
	_getDomConfigModel ()
	_getInitialXml ()
	_getIdAttributes ()

Protected Attributes
	$_data
	$_domConfig = null
	$domFactory

Detailed Description

@api

Since

100.0.2

Definition at line 16 of file AbstractXml.php.

Constructor & Destructor Documentation

__construct()

__construct	(		$configFiles,
		\Magento\Framework\Config\DomFactory	$domFactory
	)

Instantiate with the list of files to merge

Parameters

array	$configFiles
\Magento\Framework\Config\DomFactory	$domFactory

Exceptions

Definition at line 43 of file AbstractXml.php.

      {
        $this->domFactory = $domFactory;
        if (empty($configFiles)) {
            throw new \InvalidArgumentException('There must be at least one configuration file specified.');
        }
        $this->_data = $this->_extractData($this->_merge($configFiles));
    }

Member Function Documentation

_extractData()

_extractData ( \DOMDocument  $dom )

abstractprotected

Extract configuration data from the DOM structure

Parameters

\DOMDocument

$dom

Returns

array

_getDomConfigModel()

_getDomConfigModel ( )

protected

Get Dom configuration model

Returns

\Magento\Framework\Config\Dom

Exceptions

Definition at line 131 of file AbstractXml.php.

    {
        if (null === $this->_domConfig) {
            $this->_domConfig = $this->domFactory->createDom(
                [
                    'xml' => $this->_getInitialXml(),
                    'idAttributes' => $this->_getIdAttributes(),
                    'schemaFile' => $this->getPerFileSchemaFile()
                ]
            );
        }
        return $this->_domConfig;
    }

_getIdAttributes()

_getIdAttributes ( )

abstractprotected

Get list of paths to identifiable nodes

Returns

array

_getInitialXml()

_getInitialXml ( )

abstractprotected

Get XML-contents, initial for merging

Returns

string

_merge()

_merge (   $configFiles )

protected

Merge the config XML-files

Parameters

array

$configFiles

Returns

\DOMDocument

Exceptions

Definition at line 86 of file AbstractXml.php.

    {
        foreach ($configFiles as $key => $content) {
            try {
                $this->_getDomConfigModel()->merge($content);
            } catch (\Magento\Framework\Config\Dom\ValidationException $e) {
                throw new \Magento\Framework\Exception\LocalizedException(
                    new \Magento\Framework\Phrase(
                        'The XML in file "%1" is invalid:' . "\n%2\nVerify the XML and try again.",
                        [$key, $e->getMessage()]
                    )
                );
            }
        }
        $this->_performValidate();
        return $this->_getDomConfigModel()->getDom();
    }

_performValidate()

_performValidate (   $file = null )

protected

Perform xml validation

Parameters

string

$file

Returns

$this

Exceptions

Definition at line 111 of file AbstractXml.php.

    {
        $errors = [];
        $this->_getDomConfigModel()->validate($this->getSchemaFile(), $errors);
        if (!empty($errors)) {
            $phrase = (null === $file)
                ? new \Magento\Framework\Phrase('Invalid Document %1%2', [PHP_EOL, implode("\n", $errors)])
                : new \Magento\Framework\Phrase('Invalid XML-file: %1%2%3', [$file, PHP_EOL, implode("\n", $errors)]);

            throw new \Magento\Framework\Exception\LocalizedException($phrase);
        }
        return $this;
    }

getPerFileSchemaFile()

getPerFileSchemaFile

(

)

Get absolute path to per-file XML-schema file

Returns

string

Definition at line 66 of file AbstractXml.php.

    {
        return null;
    }

getSchemaFile()

getSchemaFile ( )

abstract

Get absolute path to the XML-schema file

Returns

string

Field Documentation

$_data

$_data

protected

Definition at line 23 of file AbstractXml.php.

$_domConfig

$_domConfig = null

protected

Definition at line 29 of file AbstractXml.php.

$domFactory

$domFactory

protected

Definition at line 34 of file AbstractXml.php.

---

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

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