ILIAS\COPage\Dom\DomUtil Class Reference

DOM 2 util. More...

Collaboration diagram for ILIAS\COPage\Dom\DomUtil:

Public Member Functions
	docFromString (string $xml, ?string &$error_str)
	validate (\DOMDocument $doc, ?string &$error, $throw=false)
	path (\DOMDocument $doc, string $path)
	changeName (\DOMNode $node, string $name, bool $keep_attributes=true)
	addParent (\DOMNode $node, string $name)
	replaceByChilds (\DOMNode $node)
	deleteAllChildsByName (\DOMNode $parent, array $node_names)
	deleteAllChilds (\DOMNode $parent)
	setAttributes (?\DOMNode $node, array $attributes)
	set attributes of a node More...
	setAttribute (?\DOMNode $node, string $attribute, ?string $value)
	setFirstOptionalElement (\DOMNode $parent_node, string $node_name, array $successors, string $content, array $attributes, bool $remove_childs=true)
	searches for an element $node_name within the childs of $parent_node if no node is found, a new is created before the childs with names of $successors. More...
	dump (\DOMNode $node)
	setContent (\DOMNode $node, string $text)
	getContent (\DOMNode $node)
	addElementToList (\DOMNode $parent_node, string $a_node_name, array $a_successors, string $a_content, array $a_attributes)
	Places a new node $a_node_name directly before nodes with names of $a_successors. More...

Static Protected Member Functions
static	xmlError (int $errno, string $errstr, ?string $errfile=null, ?int $errline=null, ?array $errcontext=null, bool $ret=false)

Detailed Description

DOM 2 util.

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 25 of file class.DomUtil.php.

Member Function Documentation

addElementToList()

ILIAS\COPage\Dom\DomUtil::addElementToList	(	\DOMNode	$parent_node,
		string	$a_node_name,
		array	$a_successors,
		string	$a_content,
		array	$a_attributes
	)

Places a new node $a_node_name directly before nodes with names of $a_successors.

The content of the node is set to $a_content and the attributes to $a_attributes

Definition at line 279 of file class.DomUtil.php.

     : \DOMNode {
        $doc = $parent_node->ownerDocument;
        $search = $a_successors;
        $child = null;
        $childs = $parent_node->childNodes;
        $found = false;
        foreach ($childs as $child) {
            $child_name = $child->nodeName;
            if (in_array($child_name, $search)) {
                $found = true;
                break;
            }
        }
        // didn't successors -> append at the end
        $new_node = $doc->createElement($a_node_name);
        if (!$found) {
            $new_node = $parent_node->appendChild($new_node);
        } else {
            $new_node = $parent_node->insertBefore($new_node, $child);
        }
        if ($a_content != "") {
            $this->setContent($new_node, $a_content);
        }
        $this->setAttributes($new_node, $a_attributes);
 
        return $new_node;
    }

addParent()

ILIAS\COPage\Dom\DomUtil::addParent	(	\DOMNode	$node,
		string	$name
	)

Definition at line 109 of file class.DomUtil.php.

     : \DOMNode {
        $newnode = $node->ownerDocument->createElement($name);
        $par = $node->parentNode;
        if ($next_sib = $node->nextSibling) {
            $newnode = $par->insertBefore($newnode, $next_sib);
        } else {
            $newnode = $par->appendChild($newnode);
        }
 
        $node = $par->removeChild($node);
        $newnode->appendChild($node);
        return $newnode;
    }

changeName()

ILIAS\COPage\Dom\DomUtil::changeName	(	\DOMNode	$node,
		string	$name,
		bool	$keep_attributes = true
	)

Definition at line 87 of file class.DomUtil.php.

     : \DOMNode {
        $newnode = $node->ownerDocument->createElement($name);
 
        foreach ($node->childNodes as $child) {
            $child2 = $child->cloneNode(true);
            $newnode->appendChild($child2);
        }
        if ($keep_attributes) {
            foreach ($node->attributes as $attrName => $attrNode) {
                $newnode->setAttribute($attrName, $attrNode);
            }
        }
        $node->parentNode->replaceChild($newnode, $node);
 
        return $newnode;
    }

deleteAllChilds()

ILIAS\COPage\Dom\DomUtil::deleteAllChilds

(

\DOMNode

$parent

)

Definition at line 148 of file class.DomUtil.php.

     : void {
        while ($parent->hasChildNodes()) {
            $parent->removeChild($parent->firstChild);
        }
    }

deleteAllChildsByName()

ILIAS\COPage\Dom\DomUtil::deleteAllChildsByName	(	\DOMNode	$parent,
		array	$node_names
	)

Definition at line 137 of file class.DomUtil.php.

     : void {
        foreach ($parent->childNodes as $child) {
            if (in_array($child->nodeName, $node_names)) {
                $parent->removeChild($child);
            }
        }
    }

docFromString()

ILIAS\COPage\Dom\DomUtil::docFromString	(	string	$xml,
		?string &	$error_str
	)

Definition at line 39 of file class.DomUtil.php.

                                                                   : ?\DOMDocument
    {
        $doc = new \DOMDocument();
        set_error_handler('ILIAS\COPage\Dom\DomUtil::xmlError');
        $old = ini_set('html_errors', false);
        $success = $doc->loadXML($xml);
        // Restore error handling
        ini_set('html_errors', $old);
        restore_error_handler();
        $error_str = "";
        if (!$success) {
            $error_arr = self::xmlError(0, "", "", 0, null, true);
            foreach ($error_arr as $error) {
                $error = str_replace("DOMDocument::loadXML():", "", $error);
                $error_str .= $error . "<br />";
            }
            return null;
        }
        return $doc;
    }

References ILIAS\$error, and ILIAS\COPage\Dom\DomUtil\xmlError().

Here is the call graph for this function:

dump()

ILIAS\COPage\Dom\DomUtil::dump

(

\DOMNode

$node

)

Definition at line 240 of file class.DomUtil.php.

                                        : string
    {
        return $node->ownerDocument->saveXML($node);
    }

Referenced by ilPCParagraphModelProvider\getModels().

Here is the caller graph for this function:

getContent()

ILIAS\COPage\Dom\DomUtil::getContent

(

\DOMNode

$node

)

Definition at line 263 of file class.DomUtil.php.

                                              : string
    {
        $text_node = $node->firstChild;
 
        if (is_object($text_node)) {
            return $text_node->textContent;
        } else {
            return "";
        }
    }

path()

ILIAS\COPage\Dom\DomUtil::path	(	\DOMDocument	$doc,
		string	$path
	)

Definition at line 80 of file class.DomUtil.php.

                                                         : \DOMNodeList
    {
        $xpath = new \DOMXPath($doc);
        return $xpath->query($path);
    }

References $path.

replaceByChilds()

ILIAS\COPage\Dom\DomUtil::replaceByChilds

(

\DOMNode

$node

)

Definition at line 127 of file class.DomUtil.php.

                                                   : void
    {
        foreach ($node->childNodes as $child) {
            $child2 = $child->cloneNode(true);
            $node->parentNode->insertBefore($child2, $node);
        }
        $node->parentNode->removeChild($node);
    }

setAttribute()

ILIAS\COPage\Dom\DomUtil::setAttribute	(	?\DOMNode	$node,
		string	$attribute,
		?string	$value
	)

Definition at line 168 of file class.DomUtil.php.

     : void {
        if (!is_null($node)) {
            if (!is_null($value) && $value !== "") {
                $node->setAttribute($attribute, $value);
            } elseif ($node->hasAttribute($attribute)) {
                $node->removeAttribute($attribute);
            }
        }
    }

setAttributes()

ILIAS\COPage\Dom\DomUtil::setAttributes	(	?\DOMNode	$node,
		array	$attributes
	)

set attributes of a node

Definition at line 159 of file class.DomUtil.php.

     : void {
        foreach ($attributes as $attribute => $value) {
            $this->setAttribute($node, $attribute, $value);
        }
    }

setContent()

ILIAS\COPage\Dom\DomUtil::setContent	(	\DOMNode	$node,
		string	$text
	)

Definition at line 245 of file class.DomUtil.php.

                                                            : void
    {
        // the following replace has been added to conform with PHP4.
        // A set_content("&") brought a get_content() = "&" there,
        // whereas PHP5 gives a get_content() = "&"
        $text = str_replace("&lt;", "<", $text);
        $text = str_replace("&gt;", ">", $text);
        $text = str_replace("&amp;", "&", $text);
 
        $text_node = new \DOMText();
        $text_node->appendData($text);
        if (is_object($node->firstChild)) {
            $node->replaceChild($text_node, $node->firstChild);
        } else {
            $node->appendChild($text_node);
        }
    }

setFirstOptionalElement()

ILIAS\COPage\Dom\DomUtil::setFirstOptionalElement	(	\DOMNode	$parent_node,
		string	$node_name,
		array	$successors,
		string	$content,
		array	$attributes,
		bool	$remove_childs = true
	)

searches for an element $node_name within the childs of $parent_node if no node is found, a new is created before the childs with names of $successors.

the content of the node is set to $content and the attributes to $attributes

Definition at line 188 of file class.DomUtil.php.

     : void {
        $doc = $parent_node->ownerDocument;
        $search = $successors;
        $search[] = $node_name;
        $child_name = "";
        $child = null;
 
        $found = false;
        foreach ($parent_node->childNodes as $child) {
            $child_name = $child->nodeName;
            if (in_array($child_name, $search)) {
                $found = true;
                break;
            }
        }
        // didn't find element
        if (!$found) {
            $new_node = $doc->createElement($node_name);
            $new_node = $parent_node->appendChild($new_node);
            if ($content != "") {
                $this->setContent($new_node, $content);
            }
            $this->setAttributes($new_node, $attributes);
        } else {
            if ($child_name == $node_name) {
                if ($remove_childs) {
                    foreach ($child->childNodes as $child2) {
                        $child->removeChild($child2);
                    }
                }
                if ($content != "") {
                    $this->setContent($child, $content);
                }
                $this->setAttributes($child, $attributes);
            } else {
                $new_node = $doc->createElement($node_name);
                $new_node = $child->parentNode->insertBefore($new_node, $child);
                if ($content != "") {
                    $this->setContent($new_node, $content);
                }
                $this->setAttributes($new_node, $attributes);
            }
        }
    }

validate()

ILIAS\COPage\Dom\DomUtil::validate	(	\DOMDocument	$doc,
		?string &	$error,
			$throw = false
	)

Definition at line 60 of file class.DomUtil.php.

                                                                                : void
    {
        $ok = $doc->validate();
 
        if (!$ok) {
            $error = array(array("0", "Unknown Error"));
 
            if (function_exists("libxml_get_last_error")) {
                $err = libxml_get_last_error();
 
                if (is_object($err)) {
                    if ($throw) {
                        throw new \ilCOPageException($err->message);
                    }
                    $error = array(array($err->code, $err->message));
                }
            }
        }
    }

References ILIAS\$error.

xmlError()

static ILIAS\COPage\Dom\DomUtil::xmlError ( int  $errno, string  $errstr, ?string  $errfile = null, ?int  $errline = null, ?array  $errcontext = null, bool  $ret = false  )

staticprotected

Definition at line 27 of file class.DomUtil.php.

    {
        static $errs = array();
 
        $tag = 'DOMDocument::validate(): ';
        $errs[] = str_replace($tag, '', $errstr);
 
        if ($ret === true) {
            return $errs;
        }
    }

Referenced by ILIAS\COPage\Dom\DomUtil\docFromString().

Here is the caller graph for this function:

---

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

• components/ILIAS/COPage/DOM/class.DomUtil.php