class.ilVirtualSkillTree.php

Go to the documentation of this file.

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


class ilVirtualSkillTree
{
    protected $lng;

    protected static $order_node_data = null;
    protected $include_drafts = false;
    protected $drafts = array();
    protected $include_outdated = false;
    protected $outdated = array();

    public function __construct()
    {
        global $DIC;

        $this->lng = $DIC->language();
        include_once("./Services/Skill/classes/class.ilSkillTree.php");
        $this->tree = new ilSkillTree();
    }
    
    public function getRootNode()
    {
        $root_id = $this->tree->readRootId();
        $root_node = $this->tree->getNodeData($root_id);
        unset($root_node["child"]);
        $root_node["id"] = $root_id . ":0";
        $root_node["cskill_id"] = $root_id . ":0";

        return $root_node;
    }
    
    public function setIncludeDrafts($a_val)
    {
        $this->include_drafts = $a_val;
    }

    public function getIncludeDrafts()
    {
        return $this->include_drafts;
    }

    public function setIncludeOutdated($a_val)
    {
        $this->include_outdated = $a_val;
    }

    public function getIncludeOutdated()
    {
        return $this->include_outdated;
    }
    
    public function getNode($a_id)
    {
        $id_parts = explode(":", $a_id);
        $skl_tree_id = $id_parts[0];
        $skl_template_tree_id = $id_parts[1];
    
        if ($skl_template_tree_id == 0 || (ilSkillTemplateReference::_lookupTemplateId($skl_tree_id)
                    == $skl_template_tree_id)) {
            $node_data = $this->tree->getNodeData($skl_tree_id);
            $node_data["parent"] = $node_data["parent"] . ":0";
        } else {
            $node_data = $this->tree->getNodeData($skl_template_tree_id);
            $node_data["parent"] = $skl_tree_id . ":" . $node_data["parent"];
        }

        unset($node_data["child"]);
        unset($node_data["skl_tree_id"]);
        unset($node_data["lft"]);
        unset($node_data["rgt"]);
        unset($node_data["depth"]);

        $node_data["id"] = $a_id;
        $cid = $this->getCSkillIdForVTreeId($a_id);
        $cid_parts = explode(":", $cid);
        $node_data["skill_id"] = $cid_parts[0];
        $node_data["tref_id"] = $cid_parts[1];
        $node_data["cskill_id"] = $cid;


        return $node_data;
    }

    
    public function getChildsOfNode($a_parent_id)
    {
        $a_parent_id_parts = explode(":", $a_parent_id);
        $a_parent_skl_tree_id = $a_parent_id_parts[0];
        $a_parent_skl_template_tree_id = $a_parent_id_parts[1];

        if ($a_parent_skl_template_tree_id == 0) {
            $childs = $this->tree->getChildsByTypeFilter($a_parent_skl_tree_id, array("scat", "skll", "sktr"), "order_nr");
        } else {
            $childs = $this->tree->getChildsByTypeFilter($a_parent_skl_template_tree_id, array("sktp", "sctp"), "order_nr");
        }
        
        include_once("./Services/Skill/classes/class.ilSkillTreeNode.php");
        $drafts = array();
        $outdated = array();
        foreach ($childs as $k => $c) {
            if ($a_parent_skl_template_tree_id > 0) {
                // we are in template tree only
                $child_id = $a_parent_skl_tree_id . ":" . $c["child"];
            } elseif (!in_array($c["type"], array("sktr", "sctr"))) {
                // we are in main tree only
                $child_id = $c["child"] . ":0";
            } else {
                // get template id for references
                include_once("./Services/Skill/classes/class.ilSkillTemplateReference.php");
                $child_id = $c["child"] . ":" . ilSkillTemplateReference::_lookupTemplateId($c["child"]);
            }
            unset($childs[$k]["child"]);
            unset($childs[$k]["skl_tree_id"]);
            unset($childs[$k]["lft"]);
            unset($childs[$k]["rgt"]);
            unset($childs[$k]["depth"]);
            $childs[$k]["id"] = $child_id;
            //echo "-".$child_id."-";
            $cid = $this->getCSkillIdForVTreeId($child_id);
            //echo "-".$cid."-";
            $cid_parts = explode(":", $cid);
            $childs[$k]["skill_id"] = $cid_parts[0];
            $childs[$k]["tref_id"] = $cid_parts[1];
            $childs[$k]["cskill_id"] = $cid;
            $childs[$k]["parent"] = $a_parent_id;
            
            $this->parent[$c["id"]] = $a_parent_id;
            
            // @todo: prepare this for tref id?
            if (ilSkillTreeNode::_lookupStatus($c["child"]) == ilSkillTreeNode::STATUS_DRAFT ||
                in_array($a_parent_id, $this->drafts)) {
                $this->drafts[] = $child_id;
                $drafts[] = $k;
            }
            if (ilSkillTreeNode::_lookupStatus($c["child"]) == ilSkillTreeNode::STATUS_OUTDATED ||
                in_array($a_parent_id, $this->outdated)) {
                $this->outdated[] = $child_id;
                $outdated[] = $k;
            }
        }
        if (!$this->getIncludeDrafts()) {
            foreach ($drafts as $d) {
                unset($childs[$d]);
            }
        }
        if (!$this->getIncludeOutdated()) {
            foreach ($outdated as $d) {
                unset($childs[$d]);
            }
        }

        return $childs;
    }

    public function getChildsOfNodeForCSkillId($a_cskill_id)
    {
        $id_parts = explode(":", $a_cskill_id);
        if ($id_parts[1] == 0) {
            $id = $id_parts[0] . ":0";
        } else {
            $id = $id_parts[1] . ":" . $id_parts[0];
        }
        return $this->getChildsOfNode($id);
    }

    public function getCSkillIdForVTreeId($a_vtree_id)
    {
        $id_parts = explode(":", $a_vtree_id);
        if ($id_parts[1] == 0) {
            // skill in main tree
            $skill_id = $id_parts[0];
            $tref_id = 0;
        } else {
            // skill in template
            $tref_id = $id_parts[0];
            $skill_id = $id_parts[1];
        }
        return $skill_id . ":" . $tref_id;
    }

    public function getVTreeIdForCSkillId($a_cskill_id)
    {
        $id_parts = explode(":", $a_cskill_id);
        if ($id_parts[1] == 0) {
            $id = $id_parts[0] . ":0";
        } else {
            $id = $id_parts[1] . ":" . $id_parts[0];
        }
        return $id;
    }


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

        $a_parent_id_parts = explode(":", $a_node["id"]);
        $a_parent_skl_tree_id = $a_parent_id_parts[0];
        $a_parent_skl_template_tree_id = $a_parent_id_parts[1];
        
        // title
        $title = $a_node["title"];
        
        // root?
        if ($a_node["type"] == "skrt") {
            $lng->txt("skmg_skills");
        } else {
            if ($a_node["type"] == "sktr") {
                //                              include_once("./Services/Skill/classes/class.ilSkillTemplateReference.php");
//                              $title.= " (".ilSkillTreeNode::_lookupTitle($a_parent_skl_template_tree_id).")";
            }
        }
        
        return $title;
    }
    
    public function getSubTreeForCSkillId($a_cskill_id, $a_only_basic = false)
    {
        $id_parts = explode(":", $a_cskill_id);
        if ($id_parts[1] == 0) {
            $id = $id_parts[0] . ":0";
        } else {
            $id = $id_parts[1] . ":" . $id_parts[0];
        }
        
        $result = array();

        $node = $this->getNode($id);
        if (!$a_only_basic || in_array($node["type"], array("skll", "sktp")) ||
            ($node["type"] == "sktr" && ilSkillTreeNode::_lookupType($node["skill_id"]) == "sktp")) {
            $result[] = $node;
        }
        $this->__getSubTreeRec($id, $result, $a_only_basic);
                
        return $result;
    }

    private function __getSubTreeRec($id, &$result, $a_only_basic)
    {
        $childs = $this->getChildsOfNode($id);
        foreach ($childs as $c) {
            if (!$a_only_basic || in_array($c["type"], array("skll", "sktp")) ||
                ($c["type"] == "sktr" && ilSkillTreeNode::_lookupType($c["skill_id"]) == "sktp")) {
                $result[] = $c;
            }
            $this->__getSubTreeRec($c["id"], $result, $a_only_basic);
        }
    }

    public function isDraft($a_node_id)
    {
        return in_array($a_node_id, $this->drafts);
    }

    public function isOutdated($a_node_id)
    {
        return in_array($a_node_id, $this->outdated);
    }

    public function getOrderedNodeset($c_skill_ids, $a_skill_id_key = "", $a_tref_id_key = "")
    {
        global $DIC;

        $db = $DIC->database();

        if (self::$order_node_data == null) {
            $node_data = array();
            $set = $db->query("SELECT t.child, t.parent, t.lft, n.order_nr FROM skl_tree t JOIN skl_tree_node n ON (t.child = n.obj_id)");
            while ($rec = $db->fetchAssoc($set)) {
                $node_data[$rec["child"]] = array(
                    "parent" => $rec["parent"],
                    "lft" => $rec["lft"],
                    "order_nr" => $rec["order_nr"],
                );
            }
            self::$order_node_data = $node_data;
        } else {
            $node_data = self::$order_node_data;
        }

        uasort($c_skill_ids, function ($a, $b) use ($node_data, $a_skill_id_key, $a_tref_id_key) {

            // normalize to cskill strings
            if (is_array($a)) {
                $cskilla = $a[$a_skill_id_key] . ":" . $a[$a_tref_id_key];
                $cskillb = $b[$a_skill_id_key] . ":" . $b[$a_tref_id_key];
            } else {
                $cskilla = $a;
                $cskillb = $b;
            }

            // get vtree ids
            $vida = explode(":", $this->getVTreeIdForCSkillId($cskilla));
            $vidb = explode(":", $this->getVTreeIdForCSkillId($cskillb));

            $ua = $this->getFirstUncommonAncestors($vida[0], $vidb[0], $node_data);
            if (is_array($ua)) {
                return ($node_data[$ua[0]]["order_nr"] - $node_data[$ua[1]]["order_nr"]);
            }
            // if we did not find a first uncommon ancestor, we are in the same node in the
            // main tree, here, if we have tref ids, we let the template tree decide
            if ($vida[1] > 0 && $vidb[1] > 0) {
                $ua = $this->getFirstUncommonAncestors($vida[1], $vidb[1], $node_data);
                if (is_array($ua)) {
                    return ($node_data[$ua[0]]["order_nr"] - $node_data[$ua[1]]["order_nr"]);
                }
            }

            return 0;
        });
        
        return $c_skill_ids;
    }

    // get path in node data
    protected function getPath($a, $node_data)
    {
        $path[] = $a;
        while ($node_data[$a]["parent"] != 0) {
            $a = $node_data[$a]["parent"];
            $path[] = $a;
        }
        return array_reverse($path);
    }

    // get first uncommon ancestors of $a and $b in $node_data
    protected function getFirstUncommonAncestors($a, $b, $node_data)
    {
        $path_a = $this->getPath($a, $node_data);
        $path_b = $this->getPath($b, $node_data);
        foreach ($path_a as $k => $v) {
            if ($v != $path_b[$k]) {
                return array($v, $path_b[$k]);
            }
        }
        return false;
    }
}