class.ilSkillTreeNodeGUI.php

Go to the documentation of this file.

<?php

/* Copyright (c) 1998-2010 ILIAS open source, Extended GPL, see docs/LICENSE */

include_once("./Services/Skill/classes/class.ilSkillTreeNode.php");

class ilSkillTreeNodeGUI
{
    protected $ctrl;

    protected $lng;

    protected $locator;

    protected $tpl;

    protected $user;

    public $node_object;
    public $in_use = false;
    public $use_checked = false;
    public $access;
    public $ref_id;

    public function __construct($a_node_id = 0)
    {
        global $DIC;

        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
        $this->locator = $DIC["ilLocator"];
        $this->tpl = $DIC["tpl"];
        $this->user = $DIC->user();
        $ilAccess = $DIC->access();

        $this->node_object = null;
        $this->access = $ilAccess;
        $this->ref_id = (int) $_GET["ref_id"];

        if ($a_node_id > 0 &&
            $this->getType() == ilSkillTreeNode::_lookupType($a_node_id)) {
            $this->readNodeObject((int) $a_node_id);
        }
    }

    public function isInUse()
    {
        if (!is_object($this->node_object)) {
            return false;
        }
        if ($this->use_checked) {
            return $this->in_use;
        }
        $cskill_ids = ilSkillTreeNode::getAllCSkillIdsForNodeIds(array($this->node_object->getId()));
        include_once("./Services/Skill/classes/class.ilSkillUsage.php");
        $u = new ilSkillUsage();
        $usages = $u->getAllUsagesInfoOfSubtrees($cskill_ids);
        if (count($usages) > 0) {
            $this->in_use = true;
        } else {
            $this->in_use = false;
        }
        return $this->in_use;
    }

    public function checkPermissionBool($a_perm)
    {
        return $this->access->checkAccess($a_perm, "", $this->ref_id);
    }


    public function setParentGUI($a_parentgui)
    {
        $this->parentgui = $a_parentgui;
    }

    public function getParentGUI()
    {
        return $this->parentgui;
    }

    public function readNodeObject($a_node_id)
    {
        include_once("./Services/Skill/classes/class.ilSkillTreeNodeFactory.php");
        $this->node_object = ilSkillTreeNodeFactory::getInstance($a_node_id);
    }
    
    public function saveAllTitles()
    {
        $ilCtrl = $this->ctrl;
        
        $this->getParentGUI()->saveAllTitles(false);
        $ilCtrl->redirect($this, "showOrganization");
    }

    public function deleteNodes()
    {
        $ilCtrl = $this->ctrl;

        $ilCtrl->setParameter($this, "backcmd", $_GET["backcmd"]);
        $this->getParentGUI()->deleteNodes($this);
    }

    public function cutItems()
    {
        $lng = $this->lng;

        include_once("./Services/Skill/classes/class.ilSkillTreeNode.php");

        if (!is_array($_POST["id"]) || count($_POST["id"]) == 0) {
            $this->redirectToParent();
        }
        
        $items = ilUtil::stripSlashesArray($_POST["id"]);
        $todel = array();                       // delete IDs < 0 (needed for non-js editing)
        foreach ($items as $k => $item) {
            if ($item < 0) {
                $todel[] = $k;
            }
        }
        foreach ($todel as $k) {
            unset($items[$k]);
        }

        if (!ilSkillTreeNode::uniqueTypesCheck($items)) {
            ilUtil::sendInfo($lng->txt("skmg_insert_please_choose_one_type_only"), true);
            $this->redirectToParent();
        }

        ilSkillTreeNode::clipboardCut(1, $items);

        include_once("./Modules/LearningModule/classes/class.ilEditClipboard.php");
        ilEditClipboard::setAction("cut");

        ilUtil::sendInfo($lng->txt("skmg_selected_items_have_been_cut"), true);
        
        ilSkillTreeNode::saveChildsOrder(
            (int) $_GET["obj_id"],
            array(),
            $_GET["tmpmode"]
        );

        $this->redirectToParent();
    }

    public function copyItems()
    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;

        if (!is_array($_POST["id"]) || count($_POST["id"]) == 0) {
            $this->redirectToParent();
        }

        include_once("./Services/Skill/classes/class.ilSkillTreeNode.php");

        $items = ilUtil::stripSlashesArray($_POST["id"]);
        $todel = array();                               // delete IDs < 0 (needed for non-js editing)
        foreach ($items as $k => $item) {
            if ($item < 0) {
                $todel[] = $k;
            }
        }
        foreach ($todel as $k) {
            unset($items[$k]);
        }
        if (!ilSkillTreeNode::uniqueTypesCheck($items)) {
            ilUtil::sendInfo($lng->txt("skmg_insert_please_choose_one_type_only"), true);
            $this->redirectToParent();
        }
        ilSkillTreeNode::clipboardCopy(1, $items);

        // @todo: move this to a service since it can be used here, too
        include_once("./Modules/LearningModule/classes/class.ilEditClipboard.php");
        ilEditClipboard::setAction("copy");
        ilUtil::sendInfo($lng->txt("skmg_selected_items_have_been_copied"), true);

        $this->redirectToParent();
    }

    public function cancelDelete()
    {
        $ilCtrl = $this->ctrl;
        
        $this->redirectToParent();
    }

    public function confirmedDelete()
    {
        $ilCtrl = $this->ctrl;

        if (!$this->checkPermissionBool("write")) {
            return;
        }

        $this->getParentGUI()->confirmedDelete(false);
        ilSkillTreeNode::saveChildsOrder(
            (int) $_GET["obj_id"],
            array(),
            $_GET["tmpmode"]
        );

        $this->redirectToParent();
    }

    public function setLocator()
    {
        $ilLocator = $this->locator;
        $tpl = $this->tpl;
        $ilCtrl = $this->ctrl;
        
        $ilLocator->addRepositoryItems($_GET["ref_id"]);
        $this->getParentGUI()->addLocatorItems();
        
        if ($_GET["obj_id"] > 0) {
            include_once("./Services/Skill/classes/class.ilSkillTree.php");
            $tree = new ilSkillTree();
            $path = $tree->getPathFull($_GET["obj_id"]);
            for ($i = 1; $i < count($path); $i++) {
                switch ($path[$i]["type"]) {
                    case "scat":
                        $ilCtrl->setParameterByClass(
                            "ilskillcategorygui",
                            "obj_id",
                            $path[$i]["child"]
                        );
                        $ilLocator->addItem(
                            $path[$i]["title"],
                            $ilCtrl->getLinkTargetByClass(
                                "ilskillmanagementgui",
                                "ilskillcategorygui"
                            ),
                            "",
                            0,
                            $path[$i]["type"],
                            ilUtil::getImagePath("icon_skmg.svg")
                        );
                        break;

                    case "skll":
                        $ilCtrl->setParameterByClass(
                            "ilbasicskillgui",
                            "obj_id",
                            $path[$i]["child"]
                        );
                        $ilLocator->addItem(
                            $path[$i]["title"],
                            $ilCtrl->getLinkTargetByClass(
                                "ilskillmanagementgui",
                                "ilbasicskillgui"
                            ),
                            "",
                            0,
                            $path[$i]["type"],
                            ilUtil::getImagePath("icon_skmg.svg")
                        );
                        break;
                        
                }
            }
        }
        $ilCtrl->setParameter($this, "obj_id", $_GET["obj_id"]);
        
        $tpl->setLocator();
    }
    
    public function setSkillNodeDescription()
    {
        $tpl = $this->tpl;
        
        if (is_object($this->node_object)) {
            include_once("./Services/Skill/classes/class.ilSkillTree.php");
            $tree = new ilSkillTree();
            $path = $this->node_object->skill_tree->getSkillTreePath(
                $this->node_object->getId(),
                $this->tref_id
            );
            $desc = "";
            foreach ($path as $p) {
                if (in_array($p["type"], array("scat", "skll", "sktr"))) {
                    $desc .= $sep . $p["title"];
                    $sep = " > ";
                }
            }
        }
        $tpl->setDescription($desc);
    }

    public function create()
    {
        $tpl = $this->tpl;
        
        $this->initForm("create");
        $tpl->setContent($this->form->getHTML());
    }
    
    public function addStatusInput(ilPropertyFormGUI $a_form)
    {
        $lng = $this->lng;

        // status
        $radg = new ilRadioGroupInputGUI($lng->txt("skmg_status"), "status");
        foreach (ilSkillTreeNode::getAllStatus() as $k => $op) {
            $op = new ilRadioOption($op, $k, ilSkillTreeNode::getStatusInfo($k));
            $radg->addOption($op);
        }
        $a_form->addItem($radg);
    }
    
    public function editProperties()
    {
        $tpl = $this->tpl;
        $lng = $this->lng;

        if ($this->isInUse()) {
            ilUtil::sendInfo($lng->txt("skmg_skill_in_use"));
        }

        $this->initForm("edit");
        $this->getPropertyValues();
        $tpl->setContent($this->form->getHTML());
    }
    
    public function getPropertyValues()
    {
        $values = array();
        
        $values["title"] = $this->node_object->getTitle();
        $values["description"] = $this->node_object->getDescription();
        $values["order_nr"] = $this->node_object->getOrderNr();
        $values["self_eval"] = $this->node_object->getSelfEvaluation();
        $values["status"] = $this->node_object->getStatus();
        
        $this->form->setValuesByArray($values);
    }
    
    public function save()
    {
        $tpl = $this->tpl;
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;

        if (!$this->checkPermissionBool("write")) {
            return;
        }

        $this->initForm("create");
        if ($this->form->checkInput()) {
            $this->saveItem();
            ilUtil::sendSuccess($lng->txt("msg_obj_modified"), true);
            ilSkillTreeNode::saveChildsOrder(
                (int) $_GET["obj_id"],
                array(),
                in_array($this->getType(), array("sktp", "sctp"))
            );
            $this->afterSave();
        } else {
            $this->form->setValuesByPost();
            $tpl->setContent($this->form->getHtml());
        }
    }
    
    public function afterSave()
    {
        $this->redirectToParent();
    }
    
    
    public function update()
    {
        $tpl = $this->tpl;
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;

        if (!$this->checkPermissionBool("write")) {
            return;
        }

        $this->initForm("edit");
        if ($this->form->checkInput()) {
            $this->updateItem();
            ilUtil::sendSuccess($lng->txt("msg_obj_modified"), true);
            $this->afterUpdate();
        } else {
            $this->form->setValuesByPost();
            $tpl->setContent($this->form->getHtml());
        }
    }
    
    public function afterUpdate()
    {
        $ilCtrl = $this->ctrl;
        
        $ilCtrl->redirect($this, "editProperties");
    }
    
    public function initForm($a_mode = "edit")
    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
    
        include_once("Services/Form/classes/class.ilPropertyFormGUI.php");
        $this->form = new ilPropertyFormGUI();
    
        // title
        $ti = new ilTextInputGUI($lng->txt("title"), "title");
        $ti->setMaxLength(200);
        $ti->setSize(50);
        $ti->setRequired(true);
        $this->form->addItem($ti);

        // description
        $ta = new ilTextAreaInputGUI($lng->txt("description"), "description");
        $ta->setRows(5);
        $this->form->addItem($ta);
        
        // order nr
        $ni = new ilNumberInputGUI($lng->txt("skmg_order_nr"), "order_nr");
        $ni->setInfo($lng->txt("skmg_order_nr_info"));
        $ni->setMaxLength(6);
        $ni->setSize(6);
        $ni->setRequired(true);
        if ($a_mode == "create") {
            include_once("./Services/Skill/classes/class.ilSkillTree.php");
            $tree = new ilSkillTree();
            $max = $tree->getMaxOrderNr((int) $_GET["obj_id"]);
            $ni->setValue($max + 10);
        }
        $this->form->addItem($ni);
        
        // save and cancel commands
        if ($this->checkPermissionBool("write")) {
            if ($a_mode == "create") {
                $this->form->addCommandButton("save", $lng->txt("save"));
                $this->form->addCommandButton("cancelSave", $lng->txt("cancel"));
                $this->form->setTitle($lng->txt("skmg_create_" . $this->getType()));
            } else {
                $this->form->addCommandButton("update", $lng->txt("save"));
                $this->form->setTitle($lng->txt("skmg_edit_" . $this->getType()));
            }
        }
        
        $ilCtrl->setParameter($this, "obj_id", $_GET["obj_id"]);
        $this->form->setFormAction($ilCtrl->getFormAction($this));
    }

    public function cancelSave()
    {
        $this->redirectToParent();
    }

    public function redirectToParent($a_tmp_mode = false)
    {
        $ilCtrl = $this->ctrl;
        
        if ($_GET["tmpmode"]) {
            $a_tmp_mode = true;
        }
        
        $t = ilSkillTreeNode::_lookupType((int) $_GET["obj_id"]);

        switch ($t) {
            case "skrt":
                $ilCtrl->setParameterByClass("ilskillrootgui", "obj_id", (int) $_GET["obj_id"]);
                if ($a_tmp_mode) {
                    $ilCtrl->redirectByClass("ilskillrootgui", "listTemplates");
                } else {
                    $ilCtrl->redirectByClass("ilskillrootgui", "listSkills");
                }
                break;

            case "sctp":
                $ilCtrl->setParameterByClass("ilskilltemplatecategorygui", "obj_id", (int) $_GET["obj_id"]);
                $ilCtrl->redirectByClass("ilskilltemplatecategorygui", "listItems");
                break;

            case "scat":
                $ilCtrl->setParameterByClass("ilskillcategorygui", "obj_id", (int) $_GET["obj_id"]);
                $ilCtrl->redirectByClass("ilskillcategorygui", "listItems");
                break;
        }
    }
    
    public function saveOrder()
    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;

        if (!$this->checkPermissionBool("write")) {
            return;
        }

        ilSkillTreeNode::saveChildsOrder(
            (int) $_GET["obj_id"],
            $_POST["order"],
            (int) $_GET["tmpmode"]
        );
        ilUtil::sendSuccess($lng->txt("msg_obj_modified"), true);
        $this->redirectToParent((int) $_GET["tmpmode"]);
    }

    public function insertBasicSkillClip()
    {
        $ilCtrl = $this->ctrl;
        $ilUser = $this->user;

        include_once("./Services/Skill/classes/class.ilSkillTreeNode.php");
        $nodes = ilSkillTreeNode::insertItemsFromClip("skll", (int) $_GET["obj_id"]);
        $this->redirectToParent();
    }

    public function insertSkillCategoryClip()
    {
        $ilCtrl = $this->ctrl;
        $ilUser = $this->user;

        include_once("./Services/Skill/classes/class.ilSkillTreeNode.php");
        $nodes = ilSkillTreeNode::insertItemsFromClip("scat", (int) $_GET["obj_id"]);
        $this->redirectToParent();
    }
    
    public function insertTemplateReferenceClip()
    {
        $ilCtrl = $this->ctrl;
        $ilUser = $this->user;

        include_once("./Services/Skill/classes/class.ilSkillTreeNode.php");
        $nodes = ilSkillTreeNode::insertItemsFromClip("sktr", (int) $_GET["obj_id"]);
        $this->redirectToParent();
    }
    
    public function insertSkillTemplateClip()
    {
        $ilCtrl = $this->ctrl;
        $ilUser = $this->user;

        include_once("./Services/Skill/classes/class.ilSkillTreeNode.php");
        $nodes = ilSkillTreeNode::insertItemsFromClip("sktp", (int) $_GET["obj_id"]);
        $this->redirectToParent();
    }

    public function insertTemplateCategoryClip()
    {
        $ilCtrl = $this->ctrl;
        $ilUser = $this->user;

        include_once("./Services/Skill/classes/class.ilSkillTreeNode.php");
        $nodes = ilSkillTreeNode::insertItemsFromClip("sctp", (int) $_GET["obj_id"]);
        $this->redirectToParent();
    }
    
    public function setTitleIcon()
    {
        $tpl = $this->tpl;
        
        $obj_id = (is_object($this->node_object))
            ? $this->node_object->getId()
            :0;
        $tpl->setTitleIcon(
            ilSkillTreeNode::getIconPath(
                $obj_id,
                $this->getType(),
                "",
                (ilSkillTreeNode::_lookupStatus($obj_id) == ilSkillTreeNode::STATUS_DRAFT)
            )
        );
    }


    public function addUsageTab($a_tabs)
    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;

        $a_tabs->addTab(
            "usage",
            $lng->txt("skmg_usage"),
            $ilCtrl->getLinkTarget($this, "showUsage")
        );
    }


    public function showUsage()
    {
        $tpl = $this->tpl;

        $this->setTabs("usage");

        include_once("./Services/Skill/classes/class.ilSkillUsage.php");
        $usage_info = new ilSkillUsage();
        $base_skill_id = ($this->base_skill_id > 0)
            ? $this->base_skill_id
            : $this->node_object->getId();
        $usages = $usage_info->getAllUsagesInfoOfSubtree($base_skill_id . ":" . $this->tref_id);

        $html = "";
        include_once("./Services/Skill/classes/class.ilSkillUsageTableGUI.php");
        foreach ($usages as $k => $usage) {
            $tab = new ilSkillUsageTableGUI($this, "showUsage", $k, $usage);
            $html .= $tab->getHTML() . "<br/><br/>";
        }

        $tpl->setContent($html);
    }
    
    public function exportSelectedNodes()
    {
        $ilCtrl = $this->ctrl;

        if (!is_array($_POST["id"]) || count($_POST["id"]) == 0) {
            $this->redirectToParent();
        }

        include_once("./Services/Export/classes/class.ilExport.php");
        $exp = new ilExport();
        $conf = $exp->getConfig("Services/Skill");
        $conf->setSelectedNodes($_POST["id"]);
        $exp->exportObject("skmg", ilObject::_lookupObjId((int) $_GET["ref_id"]));

        $ilCtrl->redirectByClass(array("iladministrationgui", "ilobjskillmanagementgui", "ilexportgui"), "");
    }
}