class.ilExplorerBaseGUI.php

Go to the documentation of this file.

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

abstract class ilExplorerBaseGUI
{
        protected static $js_tree_path = "./Services/UIComponent/Explorer2/lib/jstree-v.pre1.0/jquery.jstree.js";
        protected static $js_expl_path = "./Services/UIComponent/Explorer2/js/Explorer2.js";
        protected $skip_root_node = false;
        protected $ajax = false;
        protected $custom_open_nodes = array();
        protected $selected_nodes = array();
        protected $select_postvar = "";
        protected $offline_mode = false;
        protected $sec_highl_nodes = array();
        protected $enable_dnd = false;

        private $nodeOnclickEnabled;

        public function __construct($a_expl_id, $a_parent_obj, $a_parent_cmd)
        {
                $this->id = $a_expl_id;
                $this->parent_obj = $a_parent_obj;
                $this->parent_cmd = $a_parent_cmd;

                // get open nodes
                include_once("./Services/Authentication/classes/class.ilSessionIStorage.php");
                $this->store = new ilSessionIStorage("expl2");
                $open_nodes = $this->store->get("on_".$this->id);
                $this->open_nodes = unserialize($open_nodes);
                if (!is_array($this->open_nodes))
                {
                        $this->open_nodes = array();
                }

                $this->nodeOnclickEnabled = true;
        }

        static function getLocalExplorerJsPath()
        {
                return self::$js_expl_path;
        }

        static function getLocalJsTreeJsPath()
        {
                return self::$js_tree_path;
        }

        static function createHTMLExportDirs($a_target_dir)
        {
                ilUtil::makeDirParents($a_target_dir."/Services/UIComponent/Explorer2/lib/jstree-v.pre1.0");
                ilUtil::makeDirParents($a_target_dir."/Services/UIComponent/Explorer2/js");
        }



        //
        // Abstract functions that need to be overwritten in derived classes
        //
        
        abstract function getRootNode();
        
        abstract function getChildsOfNode($a_parent_node_id);
        
        abstract function getNodeContent($a_node);

        abstract function getNodeId($a_node);

        
        //
        // Functions with standard implementations that may be overwritten
        //

        function getNodeHref($a_node)
        {
                return "#";
        }

        function nodeHasVisibleChilds($a_node)
        {
                $childs = $this->getChildsOfNode($this->getNodeId($a_node));

                foreach ($childs as $child)
                {
                        if ($this->isNodeVisible($child))
                        {
                                return true;
                        }
                }
                return false;
        }
        
        function sortChilds($a_childs, $a_parent_node_id)
        {
                return $a_childs;
        }

        function getNodeIcon($a_node)
        {
                return "";
        }

        function getNodeIconAlt($a_node)
        {
                return "";
        }

        function getNodeTarget($a_node)
        {
                return "";
        }

        function getNodeOnClick($a_node)
        {
                if ($this->select_postvar != "")
                {                       
                        return $this->getSelectOnClick($a_node);
                }
                return "";
        }

        function isNodeVisible($a_node)
        {
                return true;
        }

        function isNodeHighlighted($a_node)
        {
                return false;
        }

        function isNodeClickable($a_node)
        {
                return true;
        }

        protected function isNodeSelectable($a_node)
        {
                return true;
        }

        
        //
        // Basic configuration / setter/getter
        //
        
        function getId()
        {
                return $this->id;
        }
        
        function setSkipRootNode($a_val)
        {
                $this->skip_root_node = $a_val;
        }
        
        function getSkipRootNode()
        {
                return $this->skip_root_node;
        }
        
        function setAjax($a_val)
        {
                $this->ajax = $a_val;
        }
        
        function getAjax()
        {
                return $this->ajax;
        }

        function setSecondaryHighlightedNodes($a_val)
        {
                $this->sec_highl_nodes = $a_val;
        }

        function getSecondaryHighlightedNodes()
        {
                return $this->sec_highl_nodes;
        }
        
        function setNodeOpen($a_id)
        {
                if (!in_array($a_id, $this->custom_open_nodes))
                {
                        $this->custom_open_nodes[] = $a_id;
                }
        }       

        final protected function getNodeToggleOnClick($a_node)
        {
                return "$('#".$this->getContainerId()."').jstree('toggle_node' , '#".
                        $this->getDomNodeIdForNodeId($this->getNodeId($a_node))."'); return false;";
        }

        final protected function getSelectOnClick($a_node)
        {
                $dn_id = $this->getDomNodeIdForNodeId($this->getNodeId($a_node));
                $oc = "il.Explorer2.selectOnClick('".$dn_id."'); return false;";
                return $oc;
        }       
        
        function setSelectMode($a_postvar, $a_multi = false)
        {
                $this->select_postvar = $a_postvar;
                $this->select_multi = $a_multi;
        }
        
        function setNodeSelected($a_id)
        {
                if (!in_array($a_id, $this->selected_nodes))
                {
                        $this->selected_nodes[] = $a_id;
                }
        }

        function setOfflineMode($a_val)
        {
                $this->offline_mode = $a_val;
        }

        function getOfflineMode()
        {
                return $this->offline_mode;
        }

        //
        // Standard functions that usually are not overwritten / internal use
        //

        function handleCommand()
        {
                if ($_GET["exp_cmd"] != "" &&
                        $_GET["exp_cont"] == $this->getContainerId())
                {
                        $cmd = $_GET["exp_cmd"];
                        if (in_array($cmd, array("openNode", "closeNode", "getNodeAsync")))
                        {
                                $this->$cmd();
                        }
                        
                        return true;
                }
                return false;
        }
        
        function getContainerId()
        {
                return "il_expl2_jstree_cont_".$this->getId();
        }
        
        function openNode()
        {
                global $ilLog;
                
                $id = $this->getNodeIdForDomNodeId($_GET["node_id"]);
                if (!in_array($id, $this->open_nodes))
                {
                        $this->open_nodes[] = $id;
                }
                $this->store->set("on_".$this->id, serialize($this->open_nodes));
                exit;
        }
        
        function closeNode()
        {
                global $ilLog;
                
                $id = $this->getNodeIdForDomNodeId($_GET["node_id"]);
                if (in_array($id, $this->open_nodes))
                {
                        $k = array_search($id, $this->open_nodes);
                        unset($this->open_nodes[$k]);
                }
                $this->store->set("on_".$this->id, serialize($this->open_nodes));
                exit;
        }
        
        function getNodeAsync()
        {
                $this->beforeRendering();

                if ($_GET["node_id"] != "")
                {
                        $id = $this->getNodeIdForDomNodeId($_GET["node_id"]);
                }
                else
                {
                        $id = $this->getNodeId($this->getRootNode());
                }
                
                $etpl = new ilTemplate("tpl.explorer2.html", true, true, "Services/UIComponent/Explorer2");
                $this->renderChilds($id, $etpl);
                echo $etpl->get("tag");
                exit;
        }

        function beforeRendering()
        {

        }

        function getOnLoadCode()
        {
                global $ilCtrl;

                $container_id = $this->getContainerId();
                $container_outer_id = "il_expl2_jstree_cont_out_".$this->getId();

                // collect open nodes
                $open_nodes = array($this->getDomNodeIdForNodeId($this->getNodeId($this->getRootNode())));
                foreach ($this->open_nodes as $nid)
                {
                        $open_nodes[] = $this->getDomNodeIdForNodeId($nid);
                }
                foreach ($this->custom_open_nodes as $nid)
                {
                        $dnode = $this->getDomNodeIdForNodeId($nid);
                        if (!in_array($dnode, $open_nodes))
                        {
                                $open_nodes[] = $dnode;
                        }
                }

                // ilias config options
                $url = "";
                if (!$this->getOfflineMode())
                {
                        if (is_object($this->parent_obj))
                        {
                                $url = $ilCtrl->getLinkTarget($this->parent_obj, $this->parent_cmd, "", true);
                        }
                        else
                        {
                                $url = $ilCtrl->getLinkTargetByClass($this->parent_obj, $this->parent_cmd, "", true);
                        }
                }

                // secondary highlighted nodes
                $shn = array();
                foreach ($this->sec_highl_nodes as $sh)
                {
                        $shn[] = $this->getDomNodeIdForNodeId($sh);
                }
                $config = array(
                        "container_id" => $container_id,
                        "container_outer_id" => $container_outer_id,
                        "url" => $url,
                        "second_hnodes" => $shn,
                        "ajax" => $this->getAjax(),
                );


                // jstree config options
                $js_tree_config = array(
                        "core" => array(
                                "animation" => 300,
                                "initially_open" => $open_nodes,
                                "open_parents" => false,
                                "strings" => array("loading" => "Loading ...", "new_node" => "New node")
                        ),
                        "plugins" => $this->getJSTreePlugins(),
                        "themes" => array("dots" => false, "icons" => false, "theme" => ""),
                        "html_data" => array()
                );

                return 'il.Explorer2.init('.json_encode($config).', '.json_encode($js_tree_config).');';
        }

        protected function getJSTreePlugins() {
                $plugins = array("html_data", "themes", "json_data");
                if($this->isEnableDnd()) {
                        $plugins[] = "crrm";
                        $plugins[] = "dnd";
                }
                return $plugins;
        }


        static function init()
        {
                global $tpl;

                include_once("./Services/jQuery/classes/class.iljQueryUtil.php");
                iljQueryUtil::initjQuery();

                $tpl->addJavascript(self::getLocalExplorerJsPath());
                $tpl->addJavascript(self::getLocalJsTreeJsPath());
        }
        
        
        function getHTML()
        {
                global $tpl, $ilCtrl;

                $this->beforeRendering();

                self::init();
                $container_id = $this->getContainerId();
                $container_outer_id = "il_expl2_jstree_cont_out_".$this->getId();

                if (!$ilCtrl->isAsynch())
                {
                        $tpl->addOnLoadCode($this->getOnLoadCode());
                }

                $etpl = new ilTemplate("tpl.explorer2.html", true, true, "Services/UIComponent/Explorer2");

                // render childs
                $root_node = $this->getRootNode();
                
                if (!$this->getSkipRootNode() &&
                        $this->isNodeVisible($this->getRootNode()))
                {
                        $this->listStart($etpl);
                        $this->renderNode($this->getRootNode(), $etpl);
                        $this->listEnd($etpl);
                }
                else
                {               
                        $childs = $this->getChildsOfNode($this->getNodeId($root_node));
                        $childs = $this->sortChilds($childs, $this->getNodeId($root_node));
                        $any = false;
                        foreach ($childs as $child_node)
                        {
                                if ($this->isNodeVisible($child_node))
                                {
                                        if (!$any)
                                        {
                                                $this->listStart($etpl);
                                                $any = true;
                                        }
                                        $this->renderNode($child_node, $etpl);
                                }
                        }
                        if ($any)
                        {
                                $this->listEnd($etpl);
                        }
                }
                
                $etpl->setVariable("CONTAINER_ID", $container_id);
                $etpl->setVariable("CONTAINER_OUTER_ID", $container_outer_id);

                $add = "";
                if ($ilCtrl->isAsynch())
                {
                        $add = "<script>".$this->getOnLoadCode()."</script>";
                }

                return $etpl->get().$add;
        }
        
        function renderNode($a_node, $tpl)
        {
                $this->listItemStart($tpl, $a_node);
                
                // select mode?
                if ($this->select_postvar != "" && $this->isNodeSelectable($a_node))
                {
                        if ($this->select_multi)
                        {
                                $tpl->setCurrentBlock("cb");
                                if (in_array($this->getNodeId($a_node), $this->selected_nodes))
                                {
                                        $tpl->setVariable("CHECKED", 'checked="checked"');
                                }
                                $tpl->setVariable("CB_VAL", $this->getNodeId($a_node));
                                $tpl->setVariable("CB_NAME", $this->select_postvar."[]");
                                $tpl->parseCurrentBlock();
                        }
                        else
                        {
                                $tpl->setCurrentBlock("rd");
                                if (in_array($this->getNodeId($a_node), $this->selected_nodes))
                                {
                                        $tpl->setVariable("SELECTED", 'checked="checked"');
                                }
                                $tpl->setVariable("RD_VAL", $this->getNodeId($a_node));
                                $tpl->setVariable("RD_NAME", $this->select_postvar);
                                $tpl->parseCurrentBlock();
                        }
                }
                
                
                if ($this->isNodeHighlighted($a_node))
                {
                        $tpl->touchBlock("hl");
                }
                $tpl->setCurrentBlock("content");
                if ($this->getNodeIcon($a_node) != "")
                {
                        $tpl->setVariable("ICON", ilUtil::img($this->getNodeIcon($a_node), $this->getNodeIconAlt($a_node))." ");
                }
                $tpl->setVariable("CONTENT", $this->getNodeContent($a_node));
                $tpl->setVariable("HREF", $this->getNodeHref($a_node));
                $target = $this->getNodeTarget($a_node);
                if ($target != "")
                {
                        $targetRelatedParams = array(
                                'target="' . $target . '"'
                        );

                        if ('_blank' === $target) {
                                $targetRelatedParams[] = 'rel="noopener"';
                        }

                        $tpl->setVariable('TARGET', implode(' ', $targetRelatedParams));
                }
                if (!$this->isNodeOnclickEnabled() || !$this->isNodeClickable($a_node))
                {
                        $tpl->setVariable("ONCLICK", 'onclick="return false;"');
                        $tpl->setVariable("A_CLASS", 'class="disabled"');
                }
                else
                {
                        $onclick = $this->getNodeOnClick($a_node);
                        if ($onclick != "")
                        {
                                $tpl->setVariable("ONCLICK", 'onclick="'.$onclick.'"');
                        }
                }
                $tpl->parseCurrentBlock();
                
                $tpl->touchBlock("tag");
                
                if (!$this->getAjax() || in_array($this->getNodeId($a_node), $this->open_nodes)
                        || in_array($this->getNodeId($a_node), $this->custom_open_nodes))
                {
                        $this->renderChilds($this->getNodeId($a_node), $tpl);
                }
                
                $this->listItemEnd($tpl);
        }
        
        final function renderChilds($a_node_id, $tpl)
        {
                $childs = $this->getChildsOfNode($a_node_id);
                $childs = $this->sortChilds($childs, $a_node_id);

                if (count($childs) > 0)
                {
                        $any = false;
                        foreach ($childs as $child)
                        {
                                if ($this->isNodeVisible($child))
                                {
                                        if (!$any)
                                        {
                                                $this->listStart($tpl);
                                                $any = true;
                                        }
                                        $this->renderNode($child, $tpl);
                                }
                        }
                        if ($any)
                        {
                                $this->listEnd($tpl);
                        }
                }
        }

        function getDomNodeIdForNodeId($a_node_id)
        {
                return "exp_node_".$this->getId()."_".$a_node_id;
        }
        
        function getNodeIdForDomNodeId($a_dom_node_id)
        {
                $i = strlen("exp_node_".$this->getId()."_");
                return substr($a_dom_node_id, $i);
        }
                
        function listItemStart($tpl, $a_node)
        {
                $tpl->setCurrentBlock("list_item_start");
                if ($this->getAjax() && $this->nodeHasVisibleChilds($a_node))
                {
                        $tpl->touchBlock("li_closed");
                }
                $tpl->setVariable("DOM_NODE_ID",
                        $this->getDomNodeIdForNodeId($this->getNodeId($a_node)));
                $tpl->parseCurrentBlock();
                $tpl->touchBlock("tag");
        }

        function listItemEnd($tpl)
        {
                $tpl->touchBlock("list_item_end");
                $tpl->touchBlock("tag");
        }

        function listStart($tpl)
        {
                $tpl->touchBlock("list_start");
                $tpl->touchBlock("tag");
        }

        function listEnd($tpl)
        {
                $tpl->touchBlock("list_end");
                $tpl->touchBlock("tag");
        }

        public function isNodeOnclickEnabled()
        {
                return $this->nodeOnclickEnabled;
        }

        public function setNodeOnclickEnabled($nodeOnclickEnabled)
        {
                $this->nodeOnclickEnabled = $nodeOnclickEnabled;
        }

        public function isEnableDnd() {
                return $this->enable_dnd;
        }

        public function setEnableDnd($enable_dnd) {
                $this->enable_dnd = $enable_dnd;
        }
}

?>