Inheritance diagram for Element:

Public Member Functions
	setParent ($element)

	getParent ()

	hasChildren ()

	getAttribute ($name)

	descend ($path)

	setAttribute ($name, $value)

	asArray ()

	asCanonicalArray ()

	asNiceXml ($filename='', $level=0)

	innerXml ($level=0)

	xmlentities ($value=null)

	appendChild ($source)

	extend ($source, $overwrite=false)

	extendChild ($source, $overwrite=false)

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

	unsetSelf ()

Protected Member Functions
	_asArray ($isCanonical=false)

Protected Attributes
	$_parent = null

Detailed Description

Extends SimpleXML to add valuable functionality to \SimpleXMLElement class

@api

Since: 100.0.2

Definition at line 15 of file Element.php.

Member Function Documentation

◆ _asArray()

_asArray ( $isCanonical = false )

protected

Returns the node and children as an array

Parameters

bool $isCanonical - whether to ignore attributes

Returns: array|string

Definition at line 197 of file Element.php.

     {
         $result = [];
         if (!$isCanonical) {
             // add attributes
             foreach ($this->attributes() as $attributeName => $attribute) {
                 if ($attribute) {
                     $result['@'][$attributeName] = (string)$attribute;
                 }
             }
         }
         // add children values
         if ($this->hasChildren()) {
             foreach ($this->children() as $childName => $child) {
                 $result[$childName] = $child->_asArray($isCanonical);
             }
         } else {
             if (empty($result)) {
                 // return as string, if nothing was found
                 $result = (string)$this;
             } else {
                 // value has zero key element
                 $result[0] = (string)$this;
             }
         }
         return $result;
     }

◆ appendChild()

appendChild ( $source )

Appends $source to current node

Parameters

\Magento\Framework\Simplexml\Element $source

Returns: $this

Definition at line 330 of file Element.php.

     {
         if ($source->count()) {
             $child = $this->addChild($source->getName());
         } else {
             $child = $this->addChild($source->getName(), $this->xmlentities($source));
         }
         $child->setParent($this);
 
         $attributes = $source->attributes();
         foreach ($attributes as $key => $value) {
             $child->addAttribute($key, $this->xmlentities($value));
         }
 
         foreach ($source->children() as $sourceChild) {
             $child->appendChild($sourceChild);
         }
         return $this;
     }

◆ asArray()

asArray ( )

Returns the node and children as an array

Returns: array|string

Definition at line 177 of file Element.php.

     {
         return $this->_asArray();
     }

◆ asCanonicalArray()

asCanonicalArray ( )

asArray() analog, but without attributes

Returns: array|string

Definition at line 186 of file Element.php.

     {
         return $this->_asArray(true);
     }

◆ asNiceXml()

asNiceXml	(	$filename = `''`,
		$level = `0`
	)

Makes nicely formatted XML from the node

Parameters

string	$filename
int \| boolean	$level	if false

Returns: string @SuppressWarnings(PHPMD.CyclomaticComplexity) @SuppressWarnings(PHPMD.NPathComplexity)

Definition at line 234 of file Element.php.

     {
         if (is_numeric($level)) {
             $pad = str_pad('', $level * 3, ' ', STR_PAD_LEFT);
             $nl = "\n";
         } else {
             $pad = '';
             $nl = '';
         }
 
         $out = $pad . '<' . $this->getName();
 
         $attributes = $this->attributes();
         if ($attributes) {
             foreach ($attributes as $key => $value) {
                 $out .= ' ' . $key . '="' . str_replace('"', '\"', (string)$value) . '"';
             }
         }
 
         $attributes = $this->attributes('xsi', true);
         if ($attributes) {
             foreach ($attributes as $key => $value) {
                 $out .= ' xsi:' . $key . '="' . str_replace('"', '\"', (string)$value) . '"';
             }
         }
 
         if ($this->hasChildren()) {
             $out .= '>';
             $value = trim((string)$this);
             if (strlen($value)) {
                 $out .= $this->xmlentities($value);
             }
             $out .= $nl;
             foreach ($this->children() as $child) {
                 $out .= $child->asNiceXml('', is_numeric($level) ? $level + 1 : true);
             }
             $out .= $pad . '</' . $this->getName() . '>' . $nl;
         } else {
             $value = (string)$this;
             if (strlen($value)) {
                 $out .= '>' . $this->xmlentities($value) . '</' . $this->getName() . '>' . $nl;
             } else {
                 $out .= '/>' . $nl;
             }
         }
 
         if ((0 === $level || false === $level) && !empty($filename)) {
             file_put_contents($filename, $out);
         }
 
         return $out;
     }

◆ descend()

descend ( $path )

Find a descendant of a node by path

Todo:

Do we need to make it xpath look-a-like?

Check if we still need all this and revert to plain XPath if this makes any sense

param string $path Subset of xpath. Example: "child/grand[@attrName='attrValue']/subGrand"

Parameters

string $path Example: "child/grand@attrName=attrValue/subGrand" (to make it faster without regex)

Returns: \Magento\Framework\Simplexml\Element @SuppressWarnings(PHPMD.CyclomaticComplexity)

Definition at line 103 of file Element.php.

     {
         # $node = $this->xpath($path);
         # return $node[0];
         if (is_array($path)) {
             $pathArr = $path;
         } else {
             // Simple exploding by / does not suffice,
             // as an attribute value may contain a / inside
             // Note that there are three matches for different kinds of attribute values specification
             if (strpos($path, "@") === false) {
                 $pathArr = explode('/', $path);
             } else {
                 $regex = "#([^@/\\\"]+(?:@[^=/]+=(?:\\\"[^\\\"]*\\\"|[^/]*))?)/?#";
                 $pathArr = $pathMatches = [];
                 if (preg_match_all($regex, $path, $pathMatches)) {
                     $pathArr = $pathMatches[1];
                 }
             }
         }
         $desc = $this;
         foreach ($pathArr as $nodeName) {
             if (strpos($nodeName, '@') !== false) {
                 $a = explode('@', $nodeName);
                 $b = explode('=', $a[1]);
                 $nodeName = $a[0];
                 $attributeName = $b[0];
                 $attributeValue = $b[1];
                 //
                 // Does a very simplistic trimming of attribute value.
                 //
                 $attributeValue = trim($attributeValue, '"');
                 $found = false;
                 foreach ($desc->{$nodeName} as $subdesc) {
                     if ((string)$subdesc[$attributeName] === $attributeValue) {
                         $found = true;
                         $desc = $subdesc;
                         break;
                     }
                 }
                 if (!$found) {
                     $desc = false;
                 }
             } else {
                 $desc = $desc->{$nodeName};
             }
             if (!$desc) {
                 return false;
             }
         }
         return $desc;
     }

◆ extend()

extend	(	$source,
		$overwrite = `false`
	)

Extends current node with xml from $source

If $overwrite is false will merge only missing nodes Otherwise will overwrite existing nodes

Parameters

\Magento\Framework\Simplexml\Element	$source
boolean	$overwrite

Returns: $this

Definition at line 360 of file Element.php.

     {
         if (!$source instanceof \Magento\Framework\Simplexml\Element) {
             return $this;
         }
 
         foreach ($source->children() as $child) {
             $this->extendChild($child, $overwrite);
         }
 
         return $this;
     }

◆ extendChild()

extendChild	(	$source,
		$overwrite = `false`
	)

Extends one node

Parameters

\Magento\Framework\Simplexml\Element	$source
boolean	$overwrite

Returns: $this @SuppressWarnings(PHPMD.CyclomaticComplexity) @SuppressWarnings(PHPMD.UnusedLocalVariable)

Definition at line 382 of file Element.php.

     {
         // this will be our new target node
         $targetChild = null;
 
         // name of the source node
         $sourceName = $source->getName();
 
         // here we have children of our source node
         $sourceChildren = $source->children();
 
         if (!$source->hasChildren()) {
             // handle string node
             if (isset($this->{$sourceName})) {
                 // if target already has children return without regard
                 if ($this->{$sourceName}->hasChildren()) {
                     return $this;
                 }
                 if ($overwrite) {
                     unset($this->{$sourceName});
                 } else {
                     return $this;
                 }
             }
 
             $targetChild = $this->addChild($sourceName, $source->xmlentities());
             $targetChild->setParent($this);
             foreach ($source->attributes() as $key => $value) {
                 $targetChild->addAttribute($key, $this->xmlentities($value));
             }
             return $this;
         }
 
         if (isset($this->{$sourceName})) {
             $targetChild = $this->{$sourceName};
         }
 
         if ($targetChild === null) {
             // if child target is not found create new and descend
             $targetChild = $this->addChild($sourceName);
             $targetChild->setParent($this);
             foreach ($source->attributes() as $key => $value) {
                 $targetChild->addAttribute($key, $this->xmlentities($value));
             }
         }
 
         // finally add our source node children to resulting new target node
         foreach ($sourceChildren as $childKey => $childNode) {
             $targetChild->extendChild($childNode, $overwrite);
         }
 
         return $this;
     }

◆ getAttribute()

getAttribute ( $name )

Returns attribute value by attribute name

Parameters

string $name

Returns: string|null

Definition at line 87 of file Element.php.

     {
         $attrs = $this->attributes();
         return isset($attrs[$name]) ? (string)$attrs[$name] : null;
     }

◆ getParent()

getParent ( )

Returns parent node for the element

Currently using xpath

Exceptions

Definition at line 48 of file Element.php.

     {
         if (!empty($this->_parent)) {
             $parent = $this->_parent;
         } else {
             $arr = $this->xpath('..');
             if (!isset($arr[0])) {
                 throw new \InvalidArgumentException('Root node could not be unset.');
             }
             $parent = $arr[0];
         }
         return $parent;
     }

◆ hasChildren()

hasChildren ( )

Enter description here...

Returns: boolean @SuppressWarnings(PHPMD.UnusedLocalVariable)

Definition at line 68 of file Element.php.

     {
         if (!$this->children()) {
             return false;
         }
 
         // simplexml bug: @attributes is in children() but invisible in foreach
         foreach ($this->children() as $k => $child) {
             return true;
         }
         return false;
     }

◆ innerXml()

innerXml ( $level = 0 )

Enter description here...

Parameters

int $level

Returns: string

Definition at line 293 of file Element.php.

     {
         $out = '';
         foreach ($this->children() as $child) {
             $out .= $child->asNiceXml($level);
         }
         return $out;
     }

◆ setAttribute()

setAttribute	(	$name,
		$value
	)

Create attribute if it does not exists and set value to it

Parameters

string	$name
string	$value

Returns: void

Definition at line 163 of file Element.php.

     {
         if (!isset($this->attributes()[$name])) {
             $this->addAttribute($name, $value);
         }
 
         $this->attributes()[$name] = $value;
     }

◆ setNode()

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

Set node

Parameters

string	$path
string	$value
bool	$overwrite

Returns: $this

Definition at line 444 of file Element.php.

     {
         $arr1 = explode('/', $path);
         $arr = [];
         foreach ($arr1 as $v) {
             if (!empty($v)) {
                 $arr[] = $v;
             }
         }
         $last = sizeof($arr) - 1;
         $node = $this;
         foreach ($arr as $i => $nodeName) {
             if ($last === $i) {
                 if (!isset($node->{$nodeName}) || $overwrite) {
                     $node->{$nodeName} = $value;
                 }
             } else {
                 if (!isset($node->{$nodeName})) {
                     $node = $node->addChild($nodeName);
                 } else {
                     $node = $node->{$nodeName};
                 }
             }
         }
         return $this;
     }

◆ setParent()

setParent ( $element )

For future use

Parameters

\Magento\Framework\Simplexml\Element $element

Returns: void @SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 35 of file Element.php.

     {
         //$this->_parent = $element;
     }

◆ unsetSelf()

unsetSelf ( )

Unset self from the XML-node tree

Note: trying to refer this object as a variable after "unsetting" like this will result in E_WARNING

Returns: void

Definition at line 477 of file Element.php.

     {
         $uniqueId = uniqid();
         $this['_unique_id'] = $uniqueId;
         $children = $this->getParent()->xpath('*');
         for ($i = count($children); $i > 0; $i--) {
             if ($children[$i - 1][0]['_unique_id'] == $uniqueId) {
                 unset($children[$i - 1][0]);
                 return;
             }
         }
     }

◆ xmlentities()

xmlentities ( $value = null )

Converts meaningful xml characters to xml entities

Parameters

string $value

Returns: string

Definition at line 308 of file Element.php.

     {
         if ($value === null) {
             $value = $this;
         }
         $value = (string)$value;
 
         $value = str_replace(
             ['&', '"', "'", '<', '>'],
             ['&amp;', '&quot;', '&apos;', '&lt;', '&gt;'],
             $value
         );
 
         return $value;
     }

Field Documentation

◆ $_parent

$_parent = null

protected

Definition at line 26 of file Element.php.

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

vendor/magento/framework/Simplexml/Element.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ _asArray()

◆ appendChild()

◆ asArray()

◆ asCanonicalArray()

◆ asNiceXml()

◆ descend()

◆ extend()

◆ extendChild()

◆ getAttribute()

◆ getParent()

◆ hasChildren()

◆ innerXml()

◆ setAttribute()

◆ setNode()

◆ setParent()

◆ unsetSelf()

◆ xmlentities()

Field Documentation

◆ $_parent