Varien_Simplexml_Element Class Reference

Inheritance diagram for Varien_Simplexml_Element:

List of all members.

Public Member Functions
	setParent ($element)
	getParent ()
	hasChildren ()
	getAttribute ($name)
	descend ($path)
	asArray ()
	asNiceXml ($filename='', $level=0)
	innerXml ($level=0)
	xmlentities ($value='')
	appendChild ($source)
	extend ($source, $overwrite=false)
	extendChild ($source, $overwrite=false)
	setNode ($path, $value, $overwrite=true)
Protected Attributes
	$_parent = null

---

Detailed Description

Definition at line 35 of file Element.php.

---

Member Function Documentation

appendChild

(

$

source

)

Appends $source to current node

Parameters:

Varien_Simplexml_Element

$source

Returns:

Varien_Simplexml_Element

See also:

http://bugs.php.net/bug.php?id=41867 , fixed in 5.2.4

Definition at line 299 of file Element.php.

    {
        if ($source->children()) {
            /**
             * @see http://bugs.php.net/bug.php?id=41867 , fixed in 5.2.4
             */
            if (version_compare(phpversion(), '5.2.4', '<')===true) {
                $name = $source->children()->getName();
            }
            else {
                $name = $source->getName();
            }
            $child = $this->addChild($name);
        } 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

(

)

Returns the node and children as an array

Returns:

array

Definition at line 189 of file Element.php.

    {
        $r = array();

        $attributes = $this->attributes();
        foreach($attributes as $k=>$v) {
            if ($v) $r['@'][$k] = (string) $v;
        }

        if (!($children = $this->children())) {
            $r = (string) $this;
            return $r;
        }

        foreach($children as $childName=>$child) {
            $r[$childName] = array();
            foreach ($child as $index=>$element) {
                $r[$childName][$index] = $element->asArray();
            }
        }

        return $r;
    }

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

Makes nicely formatted XML from the node

Parameters:

	string	$filename
	int|boolean	$level if false

Returns:

string

Definition at line 220 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();

        if ($attributes = $this->attributes()) {
            foreach ($attributes as $key=>$value) {
                $out .= ' '.$key.'="'.str_replace('"', '\"', (string)$value).'"';
            }
        }

        if ($this->hasChildren()) {
            $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

(

$

path

)

Find a descendant of a node by path

Todo:

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

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:

Varien_Simplexml_Element

Definition at line 147 of file Element.php.

    {
        #$node = $this->xpath($path);
        #return $node[0];
        if (is_array($path)) {
            $pathArr = $path;
        } else {
            $pathArr = explode('/', $path);
        }
        $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];
                $found = false;
                foreach ($this->$nodeName as $desc) {
                    if ((string)$nodeChild[$attributeName]===$attributeValue) {
                        $found = true;
                        break;
                    }
                }
                if (!$found) {
                    $desc = false;
                }
            } else {
                $desc = $desc->$nodeName;
            }
            if (!$desc) {
                return false;
            }
        }
        return $desc;
    }

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:

	Varien_Simplexml_Element	$source
	boolean	$overwrite

Returns:

Varien_Simplexml_Element

Reimplemented in Mage_Api_Model_Wsdl_Config_Element.

Definition at line 338 of file Element.php.

    {
        if (!$source instanceof Varien_Simplexml_Element) {
            return $this;
        }

        foreach ($source->children() as $child) {
            $this->extendChild($child, $overwrite);
        }

        return $this;
    }

extendChild	(	$	source,
		$	overwrite = false
	)

Extends one node

Parameters:

	Varien_Simplexml_Element	$source
	boolean	$overwrite

Returns:

Varien_Simplexml_Element

Definition at line 358 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->children()) {
                    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 (is_null($targetChild)) {
            // 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

(

$

name

)

Returns attribute value by attribute name

Returns:

string

Definition at line 100 of file Element.php.

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

getParent

(

)

Returns parent node for the element

Currently using xpath

Returns:

Varien_Simplexml_Element

Definition at line 66 of file Element.php.

    {
        if (!empty($this->_parent)) {
            $parent = $this->_parent;
        } else {
            $arr = $this->xpath('..');
            $parent = $arr[0];
        }
        return $parent;
    }

hasChildren

(

)

Enter description here...

Returns:

boolean

Reimplemented in Mage_Api_Model_Wsdl_Config_Element.

Definition at line 82 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

(

$

level = 0

)

Enter description here...

Parameters:

int

$level

Returns:

string

Definition at line 266 of file Element.php.

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

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

Definition at line 412 of file Element.php.

    {
        $arr1 = explode('/', $path);
        $arr = array();
        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($xml->$nodeName)) {
                    if ($overwrite) {
                        unset($xml->$nodeName);
                    } else {
                        continue;
                    }
                }
                $xml->addChild($nodeName, $xml->xmlentities($value));
                */
                if (!isset($node->$nodeName) || $overwrite) {
                    // http://bugs.php.net/bug.php?id=36795
                    // comment on [8 Feb 8:09pm UTC]
                    if (isset($node->$nodeName) && (version_compare(phpversion(), '5.2.6', '<')===true)) {
                        $node->$nodeName = $node->xmlentities($value);
                    } else {
                        $node->$nodeName = $value;
                    }
                }
            } else {
                if (!isset($node->$nodeName)) {
                    $node = $node->addChild($nodeName);
                } else {
                    $node = $node->$nodeName;
                }
            }

        }
        return $this;
    }

setParent

(

$

element

)

For future use

Parameters:

Varien_Simplexml_Element

$element

Definition at line 54 of file Element.php.

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

xmlentities

(

$

value = ''

)

Converts meaningful xml characters to xml entities

Parameters:

string

Returns:

string

Definition at line 281 of file Element.php.

    {
        if (empty($value)) {
            $value = $this;
        }
        $value = (string)$value;

        $value = str_replace(array('&', '"', "'", '<', '>'), array('&amp;', '&quot;', '&apos;', '&lt;', '&gt;'), $value);

        return $value;
    }

---

Member Data Documentation

$_parent = null [protected]

Definition at line 47 of file Element.php.

---

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

• lib/Varien/Simplexml/Element.php