class.ilDOMXML.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2009 ILIAS open source, Extended GPL, see docs/LICENSE */


class ilDOMXML
{
        var $doc;

        var $tree;

        var $error;

        function ilDOMXML ()
        {
                $num = func_num_args();
                $args = func_get_args();
                
                if (($num == 1) && is_object($args[0]))
                {
                        $this->doc = $args[0];
                }
                else
                {
                        $this->initNewDocument($args[0],$args[1],$args[2]);
                }
        }
        
        function _ilDOMXML ()
        {
                if (DEBUG)
                {
            printf("domxml destructor called, class=%s\n", get_class($this)."<br/>");
        }
        }
        
        

        function initNewDocument ($a_version = "", $a_encoding = "", $a_charset = "")
        {
                if (!$a_version) {
                        $a_version = "1.0";
                }

                if (!$a_encoding) {
                        $a_encoding = "UTF-8";
                }

                if (!$a_charset) {
                        $a_charset = "UTF-8";
                }

                // create the xml string (workaround for domxml_new_doc) ***
                $xmlHeader = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>". // *** ISO-8859-1
                                         "<root />"; // dummy node
                
                // create a domxml document object
                $this->doc = domxml_open_mem($xmlHeader); // *** Fehlerabfrage

                // delete dummy node 
                $root = $this->doc->document_element();
                $root->unlink_node();
                
                //$this->doc = new_xmldoc($a_version);
                $this->setEncoding($a_encoding);
                $this->setCharset($a_charset);
        }

        function createRootElement ($a_element)
        {
                // check if rootNode already exists
                if ($root = $this->getRoot()) {
                        return false;
                }
                
                return $this->appendChild($this->createElement($a_element));
        }

        function loadDocument ($a_filename, $a_filepath, $a_validate = false)
        {
                if ($a_validate) {
                        $mode = DOMXML_LOAD_VALIDATING;
                } else {
                        $mode = DOMXML_LOAD_PARSING;
                } 

                $this->doc = domxml_open_file($a_filepath . "/" . $a_filename, $mode, $this->error);

                // stop parsing if an error occured
                if ($this->error) {
                        $error_msg = "Error(s) while parsing the document!<br><br>";

                        foreach ($this->error as $error) {
                                $error_msg .= $error["errormessage"]." in line: ".$error["line"]."<br>";
                        }
                        
                        // error handling with ilias object?
                        echo $error_msg;
                        exit();
                }
                
                // set encoding to UTF-8 if empty
                $this->setEncoding("iso-8859-1",true);
                // set charset to UTF-8
                $this->setCharset("iso-8859-1");

                return $this->doc; 
        }

        function trim ($a_node)
        {
                if ($a_node->has_child_nodes()) {
                        $childs = $a_node->child_nodes();

                        foreach ($childs as $child) {
                                $content = trim($child->get_content());

                                if (empty($content)) {
                                        $child->unlink_node();
                                } else {
                                        $this->trim($child);
                                } 
                        } 
                } 
        }

        function trimDocument ($a_node = '')
        {
                if (empty($a_node))     {
                        $a_node = $this->doc;
                }
        
                $this->trim($a_node);
                return $a_node;
        }

        function transform ($node, $left2 = -1, $lvl = 0)
        { 
                static $left;
                
                // set depth
                $lvl++;

                // start value given from outside?
                if ($left2 > 0) {
                        $left = $left2;
                } 
                // set default value 1 if no value given
                if (!$left) {
                        $left = 1;
                } 

                $node2 = (array)$node;
                
                // init structure data
                // provides additional information about document structure
                // bitwise:
                // 1: has attributes
                // 2: has text element 
                $this->tree[$node2[0]]["struct"] = 0;

                if ($parent = $node->parent_node()) {
                        $parent = (array)$parent;
                } 

                if ($first = $node->first_child())
                {
                        $first = (array)$first;
                } 

                if ($prev = $node->previous_sibling()) {
                        $prev = (array)$prev;
                } 

                if ($next = $node->next_sibling()) {
                        $next = (array)$next;
                } 

                $this->tree[$node2[0]]["content"] = trim($node->node_value());
                $this->tree[$node2[0]]["name"] = $node->node_name();
                $this->tree[$node2[0]]["type"] = $node->type;
                $this->tree[$node2[0]]["depth"] = $lvl;
                $this->tree[$node2[0]]["parent"] = $parent[0];
                $this->tree[$node2[0]]["first"] = $first[0];
                $this->tree[$node2[0]]["prev"] = $prev[0];
                $this->tree[$node2[0]]["next"] = $next[0];
                $this->tree[$node2[0]]["left"] = $left;
                $left++;

                // write attributes to sub-array
                if ($node->has_attributes())
                {
                        $data = "";
                        
                        foreach ($node->attributes() as $attribute)
                        {
                                $data[$attribute->name] = $attribute->value;
                        }

                        $this->tree[$node2[0]]["attr_list"] = $data;
                        $this->tree[$node2[0]]["struct"] += 1;
                }

                // check if one child is a text_node
                foreach ($node->child_nodes() as $child)
                {
                        if ($child->node_type() == XML_TEXT_NODE)
                        {
                                $this->tree[$node2[0]]["struct"] += 2;
                                break;
                        }
                }
                
                // recursive call
                // please don't merge this loop with the one above together! 
                foreach ($node->child_nodes() as $child)
                {
                        $this->transform($child, $left, $lvl);
                }
                
                $this->tree[$node2[0]]["right"] = $left;
                $left++;
        }

        function buildTree ($a_node = "")
        {
                if (empty($a_node)) {
                        $a_node = $this->doc;
                }
                
                $this->transform($a_node,1);
                
                return $this->tree;
        }

        function dumpDocument ($a_stdout = -1, $a_compress = false, $a_format = false)
        {
                if ($a_stdout != -1) {
                        $this->doc->dump_file($a_stdout,$a_compress,$a_format);
                }
                
                return $this->doc->dump_mem();
        }

        function getTextFromElement ($a_element)
        {
                if ($a_element->node_type() == XML_ELEMENT_NODE) {
                        $value = "";
                
                        foreach ($a_element->child_nodes() as $child) {
                                if ($child->node_type() == XML_TEXT_NODE) {
                                        $value .= $child->content;
                                }
                        }
                
                        return trim($value);
                }
                
                die("<b>".$a_element."</b> is not a valid element node!");
        }

        function isLeafElement ($a_node, $a_elementname, $a_num = 0)
        {
                $var = true;
                
                if ($childs = $a_node->child_nodes()) {
                        foreach ($childs as $child) {
                                $var = $this->isLeafElement($child, $a_elementname);

                                if (!$var) {
                                        return false;
                                }
                        }
                }

                if (($a_node->node_type() == XML_ELEMENT_NODE) && ($a_node->tagname == $a_elementname) && ($a_num != 1)) {
                        return false;
                }
                
                return $var;
        }

        function getElementsByTagname ($a_elementname, $a_node = "")
        {
                if (empty($a_node)) {
                        $a_node = $this->doc;
                }
                
                if (count($node = $a_node->get_elements_by_tagname($a_elementname)) > 0) {
                        return $node;
                }
                
                return false;
        }

        function appendReferenceNodeForLO ($a_node, $a_lo_id, $a_lm_id, $a_prev_sibling)
        {
                $newnode = $this->createElement("LO");
                
                if (empty($a_prev_sibling))
                {
                        $node = $a_node->append_child($newnode);
                }
                else
                {
                        $node = $a_prev_sibling->append_sibling($newnode);
                }

                $node->set_attribute("id",$a_lo_id);
                $node->set_attribute("lm",$a_lm_id);
        }

        function appendChild ($a_node)
        {
                return $this->doc->append_child($a_node);
        }

        function getRoot ()
        {
                return $this->doc->document_element();
        }

        function createElement ($a_node)
        {
                return $this->doc->create_element($a_node);
        }

        function addElement ($a_parent, $a_node)
        {
                $node = $this->doc->create_element($a_node);
                $node = $a_parent->append_child($node);
                
                return $node;
        }
                
        function createText ($a_text)
        {
                return $this->doc->create_text_node($a_text);
        }

        function createNode ($a_parent, $a_elementname, $a_attr_list = NULL, $a_text = NULL)
        {
                // create new element node
                $node = $this->createElement($a_elementname);
                
                // set attributes
                if (is_array($a_attr_list)) {
                        foreach ($a_attr_list as $attr => $value) {
                                $node->set_attribute($attr, $value);
                        }
                }
                
                // create and add a text node to the new element node
                if (is_string($a_text)) {
                        $node_text = $this->doc->create_text_node($a_text);
                        $node_text = $node->append_child($node_text);
                }
                
                // add element node at at the end of the children of the parent
                $node = $a_parent->append_child($node);
                
                return $node;
        }

        function getElementId($a_node)
        {
                $node = (array) $a_node;
                return $node[0];
        }

        function getElementName($a_node)
        {
                return $a_node->node_name();
        }

        function setEncoding ($a_encode,$a_overwrite = false)
        {
                if (empty($this->doc->encoding) or ($a_overwrite)) {
                        $this->doc->encoding = $a_encode;
                        return true;
                }
                
                return false;
        }

        function getEncoding ()
        {
                return $this->doc->encoding;
        }

        function setCharset ($a_charset,$a_overwrite = false)
        {
                if (is_integer($this->doc->charset) or ($a_overwrite)) {
                        $this->doc->charset = $a_charset;
                        return true;
                }
                
                return false;
        }

        function getCharset ()
        {
                return $this->doc->charset;
        }

        function getInfo ()
        {
                $node = $this->getElementsByTagname("MetaData");

                if($node !== false)
                {
                        $childs = $node[0]->child_nodes();

                        foreach ($childs as $child)
                        {
                                        if (($child->node_type() == XML_ELEMENT_NODE) && ($child->tagname == "General"))
                                        {
                                                $childs2 = $child->child_nodes();

                                                foreach ($childs2 as $child2)
                                                {
                                                        if (($child2->node_type() == XML_ELEMENT_NODE) && ($child2->tagname == "Title" || $child2->tagname == "Description"))
                                                        {
                                                                $arr[$child2->tagname] = $child2->get_content();
                                                        }
                                                }

                                                // General-tag was found. Stop foreach-loop
                                                break;
                                        }
                        }
                }

                // for compatibility reasons:
                $arr["title"] = $arr["Title"];
                $arr["desc"] = $arr["Description"];

                return $arr;
        }

        function getReferences()
        {
                if ($nodes = $this->getElementsByTagname("LO"))
                {
                        foreach ($nodes as $node)
                        {
                                $attr[] = $node->get_attribute("id");
                        }
                }

                return $attr;
        }
} // END class.domxml
?>