Config Class Reference

Inheritance diagram for Config:

Public Member Functions
	__construct ($sourceData=null)
	setXml (Element $node)
	getNode ($path=null)
	getXpath ($xpath)
	getXmlString ()
	loadFile ($filePath)
	loadString ($string)
	loadDom (\DOMNode $dom)
	setNode ($path, $value, $overwrite=true)
	applyExtends ()
	processFileData ($text)
	extend (Config $config, $overwrite=true)
	__destruct ()

Protected Member Functions
	getXml ()

Protected Attributes
	$_xml = null
	$_elementClass = \Magento\Framework\Simplexml\Element::class
	$_xpathExtends = "//*[@extends]"

Detailed Description

Base class for simplexml based configurations

@api

Since

100.0.2

Definition at line 14 of file Config.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$sourceData = null

)

Constructor

Initializes XML for this configuration

See also

\Magento\Framework\Simplexml\Config::setXml

Parameters

Element | string

$sourceData

Definition at line 45 of file Config.php.

    {
        if ($sourceData === null) {
            return;
        }
        if ($sourceData instanceof Element) {
            $this->setXml($sourceData);
        } elseif (is_string($sourceData) && !empty($sourceData)) {
            if (strlen($sourceData) < 1000 && is_readable($sourceData)) {
                $this->loadFile($sourceData);
            } else {
                $this->loadString($sourceData);
            }
        }
    }

__destruct()

__destruct

(

)

Cleanup circular references

Destructor should be called explicitly in order to work around the PHP bug https://bugs.php.net/bug.php?id=62468

Returns

void

Definition at line 242 of file Config.php.

    {
        $this->_xml = null;
    }

Member Function Documentation

applyExtends()

applyExtends

(

)

Process configuration xml

Returns

$this

Definition at line 193 of file Config.php.

    {
        $targets = $this->getXpath($this->_xpathExtends);
        if (!$targets) {
            return $this;
        }
        foreach ($targets as $target) {
            $sources = $this->getXpath((string)$target['extends']);
            if ($sources) {
                foreach ($sources as $source) {
                    $target->extend($source);
                }
            }
        }
        return $this;
    }

extend()

extend	(	Config	$config,
			$overwrite = true
	)

Enter description here...

Parameters

Config	$config
boolean	$overwrite

Returns

$this

Definition at line 228 of file Config.php.

    {
        $this->getNode()->extend($config->getNode(), $overwrite);
        return $this;
    }

getNode()

getNode

(

$path = null

)

Returns node found by the $path

See also

\Magento\Framework\Simplexml\Element::descend

Parameters

string

$path

Returns

Element|bool

Definition at line 80 of file Config.php.

    {
        if (!$this->getXml() instanceof Element) {
            return false;
        } elseif ($path === null) {
            return $this->getXml();
        } else {
            return $this->getXml()->descend($path);
        }
    }

getXml()

getXml ( )

protected

Getter for xml element

Returns

Element

Definition at line 252 of file Config.php.

    {
        return $this->_xml;
    }

getXmlString()

getXmlString

(

)

Return Xml of node as string

Returns

string

Definition at line 116 of file Config.php.

    {
        return $this->getNode()->asNiceXml('', false);
    }

getXpath()

getXpath

(

$xpath

)

Returns nodes found by xpath expression

Parameters

string

$xpath

Returns

Element[]|bool

Definition at line 97 of file Config.php.

    {
        $xml = $this->getXml();
        if (empty($xml)) {
            return false;
        }

        if (!($result = @$xml->xpath($xpath))) {
            return false;
        }

        return $result;
    }

loadDom()

loadDom

(

\DOMNode

$dom

)

Imports DOM node

Parameters

\DOMNode

$dom

Returns

bool

Definition at line 163 of file Config.php.

    {
        $xml = simplexml_import_dom($dom, $this->_elementClass);
        if ($xml) {
            $this->setXml($xml);
            return true;
        }

        return false;
    }

loadFile()

loadFile

(

$filePath

)

Imports XML file

Parameters

string

$filePath

Returns

boolean

Definition at line 127 of file Config.php.

    {
        if (!is_readable($filePath)) {
            //throw new \Exception('Can not read xml file '.$filePath);
            return false;
        }

        $fileData = file_get_contents($filePath);
        $fileData = $this->processFileData($fileData);
        return $this->loadString($fileData);
    }

loadString()

loadString

(

$string

)

Imports XML string

Parameters

string

$string

Returns

boolean

Definition at line 145 of file Config.php.

    {
        if (!empty($string)) {
            $xml = simplexml_load_string($string, $this->_elementClass);
            if ($xml) {
                $this->setXml($xml);
                return true;
            }
        }
        return false;
    }

processFileData()

processFileData

(

$text

)

Stub method for processing file data right after loading the file text

Parameters

string

$text

Returns

string

Definition at line 216 of file Config.php.

    {
        return $text;
    }

setNode()

setNode	(		$path,
			$value,
			$overwrite = true
	)

Create node by $path and set its value.

Parameters

string	$path	separated by slashes
string	$value
boolean	$overwrite

Returns

$this

Definition at line 182 of file Config.php.

    {
        $this->getXml()->setNode($path, $value, $overwrite);
        return $this;
    }

setXml()

setXml

(

Element

$node

)

Sets xml for this configuration

Parameters

Element

$node

Returns

$this

Definition at line 67 of file Config.php.

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

Field Documentation

$_elementClass

$_elementClass = \Magento\Framework\Simplexml\Element::class

protected

Definition at line 28 of file Config.php.

$_xml

$_xml = null

protected

Definition at line 21 of file Config.php.

$_xpathExtends

$_xpathExtends = "//*[@extends]"

protected

Definition at line 35 of file Config.php.

---

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

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