class.ilObjStudyProgrammeTreeExplorerGUI.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2013 ILIAS open source, Extended GPL, see docs/LICENSE */
require_once("./Services/UIComponent/Explorer2/classes/class.ilTreeExplorerGUI.php");
require_once("./Services/UIComponent/AdvancedSelectionList/classes/class.ilAdvancedSelectionListGUI.php");
require_once("./Services/UIComponent/Glyph/classes/class.ilGlyphGUI.php");
require_once("./Services/UIComponent/Button/classes/class.ilLinkButton.php");
require_once("./Modules/StudyProgramme/classes/class.ilObjStudyProgrammeSettingsGUI.php");
class ilObjStudyProgrammeTreeExplorerGUI extends ilExplorerBaseGUI {
        protected $js_study_programme_path = "./Modules/StudyProgramme/templates/js/ilStudyProgramme.js";
        protected $css_study_programme_path = "./Modules/StudyProgramme/templates/css/ilStudyProgrammeTree.css";

        //protected $stay_with_command = array( "", "render", "view", "infoScreen", "performPaste", "cut", "tree_view");

        protected $tree_root_id;

        protected $access;
        protected $lng;

        protected $tpl;

        protected $toolbar;

        protected $ctrl;

        protected $modal_id;

        protected $js_conf;

        protected $class_configuration = array(
                'node' => array(
                        'node_title' => 'title',
                        'node_point' => 'points',
                        'node_current' => 'ilHighlighted current_node',
                        'node_buttons' => 'tree_button'
                ),
                'lp_object' => 'lp-object',
        );

        protected $node_template;

        public function __construct($a_tree_root_id, $modal_id, $a_expl_id, $a_parent_obj, $a_parent_cmd) {
                global $ilAccess, $lng, $tpl, $ilToolbar, $ilCtrl;

                parent::__construct($a_expl_id, $a_parent_obj, $a_parent_cmd);

                $this->tree_root_id = $a_tree_root_id;

                $this->access = $ilAccess;
                $this->lng = $lng;
                $this->tpl = $tpl;
                $this->toolbar = $ilToolbar;
                $this->ctrl = $ilCtrl;
                $this->modal_id = $modal_id;
                $this->js_conf = array();

                $lng->loadLanguageModule("prg");

                $this->setAjax(true);

                if($this->checkAccess('write', $a_tree_root_id)) {
                        $this->setEnableDnd(true);
                }
        }


        public function getNodeContent($node) {
                global $lng, $ilAccess;

                $current_ref_id = (isset($_GET["ref_id"]))? $_GET["ref_id"] : -1;

                $is_current_node = ($node->getRefId() == $current_ref_id);
                $is_study_programme = ($node instanceof ilObjStudyProgramme);
                $is_root_node = ($is_study_programme && $node->getRoot() == null);

                // show delete only on not current elements and not root
                $is_delete_enabled = ($is_study_programme && ($is_current_node || $is_root_node))? false : $this->checkAccess("delete", $current_ref_id);

                $is_creation_enabled = ($this->checkAccess("create", $current_ref_id));

                $node_config = array(
                        'current_ref_id' =>$current_ref_id,
                        'is_current_node' => $is_current_node,
                        'is_delete_enabled' => $is_delete_enabled,
                        'is_creation_enabled' => $is_creation_enabled,
                        'is_study_programme' => $is_study_programme,
                        'is_root_node' => $is_root_node
                );

                // TODO: find way to remove a-tag around the content, to create valid html
                $tpl = $this->getNodeTemplateInstance();

                $tpl->setCurrentBlock('node-content-block');
                $tpl->setVariable('NODE_TITLE_CLASSES', implode(' ', $this->getNodeTitleClasses($node_config)));
                $tpl->setVariable('NODE_TITLE', $node->getTitle());

                if($is_study_programme) {
                        $tpl->setVariable('NODE_POINT_CLASSES', $this->class_configuration['node']['node_point']);
                        $tpl->setVariable('NODE_POINTS', $this->formatPointValue($node->getPoints()));
                }

                $tpl->parseCurrentBlock('node-content-block');

                // add the tree buttons
                if($this->checkAccess('write', $node->getRefId())) {
                        if($is_study_programme) {
                                $this->parseStudyProgrammeNodeButtons($node, $node_config, $tpl);
                        } else {
                                $this->parseLeafNodeButtons($node, $node_config, $tpl);
                        }
                }

                return $tpl->get();
        }

        protected function getNodeTitleClasses($node_config) {
                $node_title_classes = array($this->class_configuration['node']['node_title']);
                if($node_config['is_study_programme']){
                        if ($node_config['is_current_node']) {
                                array_push($node_title_classes, $this->class_configuration['node']['node_current']);
                        }
                } else {
                        array_push($node_title_classes, $this->class_configuration['lp_object']);
                }

                return $node_title_classes;
        }


        protected function parseStudyProgrammeNodeButtons($node, $node_config, $tpl) {
                $tpl->setCurrentBlock('enable-tree-buttons');
                $tpl->touchBlock('enable-tree-buttons');

                // show info button only when it not the current node           
                $info_button = $this->getNodeButtonActionLink('ilObjStudyProgrammeSettingsGUI', 'view', array('ref_id'=>$node->getRefId(), 'currentNode'=>$node_config['is_current_node']), ilGlyphGUI::get(ilGlyphGUI::INFO));
                $tpl->setVariable('NODE_INFO_BUTTON', $info_button);

                // only show add button when create permission is set
                if($node_config['is_creation_enabled']) {
                        $create_button = $this->getNodeButtonActionLink('ilObjStudyProgrammeTreeGUI', 'create', array('ref_id'=>$node->getRefId()), ilGlyphGUI::get(ilGlyphGUI::ADD));
                        $tpl->setVariable('NODE_CREATE_BUTTON', $create_button);
                }

                // only show delete button when its not the current node, not the root-node and delete permissions are set
                if($node_config['is_delete_enabled']) {
                        $delete_button = $this->getNodeButtonActionLink('ilObjStudyProgrammeTreeGUI', 'delete', array('ref_id'=>$node->getRefId(), 'item_ref_id'=>$node_config['current_ref_id']), ilGlyphGUI::get(ilGlyphGUI::REMOVE));
                        $tpl->setVariable('NODE_DELETE_BUTTON', $delete_button);
                }

                $tpl->parseCurrentBlock('enable-tree-buttons');
        }

        protected function parseLeafNodeButtons($node, $node_config, $tpl) {
                $tpl->setCurrentBlock('enable-tree-buttons');
                $tpl->touchBlock('enable-tree-buttons');

                // only show delete button when its not the current node
                if($node_config['is_delete_enabled']) {
                        $delete_button = $this->getNodeButtonActionLink('ilObjStudyProgrammeTreeGUI', 'delete', array('ref_id'=>$node->getRefId(), 'item_ref_id'=>$node_config['current_ref_id']), ilGlyphGUI::get(ilGlyphGUI::REMOVE));
                        $tpl->setVariable('NODE_DELETE_BUTTON', $delete_button);
                }

                $tpl->parseCurrentBlock('enable-tree-buttons');
        }

        protected function getNodeTemplateInstance() {
                return new ilTemplate("tpl.tree_node_content.html", true, true, "Modules/StudyProgramme");
        }

        protected function formatPointValue($points) {
                return '('. $points ." ".$this->lng->txt('prg_points').')';
        }
        
        protected function getNodeButtonActionLink($target_class, $cmd, $params, $content, $async = true) {
                foreach($params as $param_name=>$param_value) {
                        $this->ctrl->setParameterByClass($target_class, $param_name, $param_value);
                }

                $tpl = $this->getNodeTemplateInstance();
                //$tpl->free();
                $tpl->setCurrentBlock('tree-button-block');

                $classes = array($this->class_configuration['node']['node_buttons']);
                $classes[] = 'cmd_'.$cmd;

                $tpl->setVariable('LINK_HREF', $this->ctrl->getLinkTargetByClass($target_class, $cmd, '', true, false));
                $tpl->setVariable('LINK_CLASSES', implode(' ', $classes));

                if($async) {
                        $tpl->touchBlock('enable-async-link');
                        $tpl->setVariable('LINK_DATA_TARGET', '#'.$this->modal_id);
                }

                $tpl->setVariable('LINK_CONTENT', $content);

                //$tpl->parseCurrentBlock('tree-button-block');

                return $tpl->get();
        }

        public function getRootNode() {
                $node = ilObjStudyProgramme::getInstanceByRefId($this->tree_root_id);
                if($node->getRoot() != NULL) {
                        return $node->getRoot();
                }
                return $node;
        }

        public function getNodeIcon($a_node) {
                global $ilias;

                $obj_id = ilObject::_lookupObjId($a_node->getRefId());
                if ($ilias->getSetting('custom_icons')) {
                        //TODO: implement custom icon functionality
                }

                return ilObject::_getIcon($obj_id, "tiny");
        }


        public function getNodeHref($node) {
                global $ilCtrl;

                if ($ilCtrl->getCmd() == "performPaste") {
                        $ilCtrl->setParameterByClass("ilObjStudyProgrammeGUI", "target_node", $node->getRefId());
                }

                $ilCtrl->setParameterByClass("ilObjStudyProgrammeGUI", "ref_id", $node->getRefId());

                return '#';
        }

        public function getChildsOfNode($a_parent_node_id) {
                global $ilAccess;

                $parent_obj = ilObjectFactoryWrapper::singleton()->getInstanceByRefId($a_parent_node_id);

                $children_with_permission = array();

                // its currently only possible to have children on StudyProgrammes
                if($parent_obj instanceof ilObjStudyProgramme) {
                        $children = ($parent_obj->hasChildren())? $parent_obj->getChildren() : $parent_obj->getLPChildren();

                        if(is_array($children)) {
                                foreach($children as $node) {
                                        if($this->checkAccess('visible', $node->getRefId())) {
                                                $children_with_permission[] = $node;
                                        }
                                }
                        }
                }

                return $children_with_permission;
        }

        public function isNodeClickable($a_node) {
                return true;
        }


        public function getNodeId($a_node) {
                if(!is_null($a_node)) {
                        return $a_node->getRefId();
                }
                return null;
        }

        public function listItemStart($tpl, $a_node)
        {
                $tpl->setCurrentBlock("list_item_start");

                if ($this->getAjax() && $this->nodeHasVisibleChilds($a_node) || ($a_node instanceof ilStudyProgramme && $a_node->getParent() === null))
                {
                        $tpl->touchBlock("li_closed");
                }
                $tpl->setVariable("DOM_NODE_ID",
                        $this->getDomNodeIdForNodeId($this->getNodeId($a_node)));
                $tpl->parseCurrentBlock();
                $tpl->touchBlock("tag");
        }


        public function getHTML() {
                $this->tpl->addJavascript($this->js_study_programme_path);
                $this->tpl->addCss($this->css_study_programme_path);

                $this->tpl->addOnLoadCode('$("#'.$this->getContainerId().'").study_programme_tree('.json_encode($this->js_conf).');');

                return parent::getHTML();
        }


        public function closeCertainNode($node_id) {
                if (in_array($node_id, $this->open_nodes))
                {
                        $k = array_search($node_id, $this->open_nodes);
                        unset($this->open_nodes[$k]);
                }
                $this->store->set("on_".$this->id, serialize($this->open_nodes));
        }

        public function openCertainNode($node_id) {
                $id = $this->getNodeIdForDomNodeId($node_id);
                if (!in_array($id, $this->open_nodes))
                {
                        $this->open_nodes[] = $id;
                }
                $this->store->set("on_".$this->id, serialize($this->open_nodes));
        }


        protected function checkAccess($permission, $ref_id) {
                $checker = $this->access->checkAccess($permission, '', $ref_id);

                return $checker;
        }


        protected function checkAccessOrFail($permission, $ref_id) {
                if(!$this->checkAccess($permission, $ref_id)) {
                        throw new ilException("You have no permission for ".$permission." Object with ref_id ".$ref_id."!");
                }
        }

        public function addJsConf($key, $value) {
                $this->js_conf[$key] = $value;
        }

        public function getJsConf($key) {
                return $this->js_conf[$key];
        }

}

?>