class.ilSkillUsage.php

Go to the documentation of this file.

<?php

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

class ilSkillUsage implements ilSkillUsageInfo
{
    const TYPE_GENERAL = "gen";
    const USER_ASSIGNED = "user";
    const PERSONAL_SKILL = "pers";
    const USER_MATERIAL = "mat";
    const SELF_EVAL = "seval";
    const PROFILE = "prof";
    const RESOURCE = "res";
    
    // these classes implement the ilSkillUsageInfo interface
    // currently this array is ok, we do not need any subscription model here
    /*protected $classes = array("ilBasicSkill", "ilPersonalSkill",
        "ilSkillSelfEvaluation", "ilSkillProfile", "ilSkillResources", "ilSkillUsage");*/
    protected $classes = array("ilBasicSkill", "ilPersonalSkill", "ilSkillProfile",  "ilSkillResources", "ilSkillUsage");
    
    public static function setUsage($a_obj_id, $a_skill_id, $a_tref_id, $a_use = true)
    {
        global $DIC;

        $ilDB = $DIC->database();
        
        if ($a_use) {
            $ilDB->replace(
                "skl_usage",
                array(
                    "obj_id" => array("integer", $a_obj_id),
                    "skill_id" => array("integer", $a_skill_id),
                    "tref_id" => array("integer", $a_tref_id)
                    ),
                array()
                );
        } else {
            $ilDB->manipulate(
                $q = "DELETE FROM skl_usage WHERE " .
                " obj_id = " . $ilDB->quote($a_obj_id, "integer") .
                " AND skill_id = " . $ilDB->quote($a_skill_id, "integer") .
                " AND tref_id = " . $ilDB->quote($a_tref_id, "integer")
                );
            //echo $q; exit;
        }
    }
    
    public static function removeUsagesFromObject($a_obj_id)
    {
        global $DIC;

        $ilDB = $DIC->database();

        $ilDB->manipulate(
            $q = "DELETE FROM skl_usage WHERE " .
                " obj_id = " . $ilDB->quote($a_obj_id, "integer")
        );
    }

    public static function getUsages($a_skill_id, $a_tref_id)
    {
        global $DIC;

        $ilDB = $DIC->database();
        
        $set = $ilDB->query(
            "SELECT obj_id FROM skl_usage " .
            " WHERE skill_id = " . $ilDB->quote($a_skill_id, "integer") .
            " AND tref_id = " . $ilDB->quote($a_tref_id, "integer")
            );
        $obj_ids = array();
        while ($rec = $ilDB->fetchAssoc($set)) {
            $obj_ids[] = $rec["obj_id"];
        }
        
        return $obj_ids;
    }
    
    public static function getUsageInfo($a_cskill_ids, &$a_usages)
    {
        global $DIC;

        $ilDB = $DIC->database();
        
        self::getUsageInfoGeneric(
            $a_cskill_ids,
            $a_usages,
            ilSkillUsage::TYPE_GENERAL,
            "skl_usage",
            "obj_id"
        );
    }
    
    public static function getUsageInfoGeneric(
        $a_cskill_ids,
        &$a_usages,
        $a_usage_type,
        $a_table,
        $a_key_field,
        $a_skill_field = "skill_id",
        $a_tref_field = "tref_id"
    ) {
        global $DIC;

        $ilDB = $DIC->database();

        if (count($a_cskill_ids) == 0) {
            return;
        }

        $w = "WHERE";
        $q = "SELECT " . $a_key_field . ", " . $a_skill_field . ", " . $a_tref_field . " FROM " . $a_table . " ";
        foreach ($a_cskill_ids as $sk) {
            $q .= $w . " (" . $a_skill_field . " = " . $ilDB->quote($sk["skill_id"], "integer") .
            " AND " . $a_tref_field . " = " . $ilDB->quote($sk["tref_id"], "integer") . ") ";
            $w = "OR";
        }
        $q .= " GROUP BY " . $a_key_field . ", " . $a_skill_field . ", " . $a_tref_field;

        $set = $ilDB->query($q);
        while ($rec = $ilDB->fetchAssoc($set)) {
            $a_usages[$rec[$a_skill_field] . ":" . $rec[$a_tref_field]][$a_usage_type][] =
                    array("key" => $rec[$a_key_field]);
        }
    }

    
    public function getAllUsagesInfo($a_cskill_ids)
    {
        $classes = $this->classes;
        
        $usages = array();
        foreach ($classes as $class) {
            $class::getUsageInfo($a_cskill_ids, $usages);
        }
        return $usages;
    }

    public function getAllUsagesInfoOfSubtree($a_skill_id, $a_tref_id = 0)
    {
        // get nodes
        $vtree = new ilVirtualSkillTree();
        $nodes = $vtree->getSubTreeForCSkillId($a_skill_id . ":" . $a_tref_id);

        return $this->getAllUsagesInfo($nodes);
    }

    public function getAllUsagesInfoOfSubtrees($a_cskill_ids)
    {
        // get nodes
        $vtree = new ilVirtualSkillTree();
        $allnodes = array();
        foreach ($a_cskill_ids as $s) {
            $nodes = $vtree->getSubTreeForCSkillId($s["skill_id"] . ":" . $s["tref_id"]);
            foreach ($nodes as $n) {
                $allnodes[] = $n;
            }
        }

        return $this->getAllUsagesInfo($allnodes);
    }

    public function getAllUsagesOfTemplate($a_tempate_id)
    {
        $skill_logger = ilLoggerFactory::getLogger('skll');
        $skill_logger->debug("ilSkillUsage: getAllUsagesOfTemplate(" . $a_tempate_id . ")");

        // get all trefs for template id
        $trefs = ilSkillTemplateReference::_lookupTrefIdsForTemplateId($a_tempate_id);

        // get all usages of subtrees of template_id:tref
        $cskill_ids = array();
        foreach ($trefs as $tref) {
            $cskill_ids[] = array("skill_id" => $a_tempate_id, "tref_id" => $tref);
            $skill_logger->debug("ilSkillUsage: ... skill_id: " . $a_tempate_id . ", tref_id: " . $tref . ".");
        }

        $skill_logger->debug("ilSkillUsage: ... count cskill_ids: " . count($cskill_ids) . ".");

        return $this->getAllUsagesInfoOfSubtrees($cskill_ids);
    }

    public static function getTypeInfoString($a_type)
    {
        global $DIC;

        $lng = $DIC->language();
        
        return $lng->txt("skmg_usage_type_info_" . $a_type);
    }

    public static function getObjTypeString($a_type)
    {
        global $DIC;

        $lng = $DIC->language();
        
        switch ($a_type) {
            case self::TYPE_GENERAL:
            case self::RESOURCE:
                return $lng->txt("skmg_usage_obj_objects");
                break;
            
            case self::USER_ASSIGNED:
            case self::PERSONAL_SKILL:
            case self::USER_MATERIAL:
            case self::SELF_EVAL:
                return $lng->txt("skmg_usage_obj_users");
                break;

            case self::PROFILE:
                return $lng->txt("skmg_usage_obj_profiles");
                break;
        }
        
        return $lng->txt("skmg_usage_type_info_" . $a_type);
    }

    public function getAssignedObjectsForSkill(int $a_skill_id, int $a_tref_id) : array
    {
        //$objects = $this->getAllUsagesInfoOfSubtree($a_skill_id, $a_tref_id);
        $objects = self::getUsages($a_skill_id, $a_tref_id);

        return $objects;
    }

    public function getAssignedObjectsForSkillTemplate(int $a_template_id) : array
    {
        $usages = $this->getAllUsagesOfTemplate($a_template_id);
        $obj_usages = array_column($usages, "gen");
        foreach ($obj_usages as $obj) {
            $objects["objects"] = array_column($obj, "key");
        }

        return $objects["objects"];
    }

    public function getAssignedObjectsForSkillProfile(int $a_profile_id) : array
    {
        $profile = new ilSkillProfile($a_profile_id);
        $skills = $profile->getSkillLevels();
        $objects = array();

        // usages for skills within skill profile
        foreach ($skills as $skill) {
            $obj_usages = self::getUsages($skill["base_skill_id"], $skill["tref_id"]);
            foreach ($obj_usages as $id) {
                if (!in_array($id, $objects)) {
                    $objects[] = $id;
                }
            }
        }

        // courses and groups which are using skill profile
        $roles = $profile->getAssignedRoles();
        foreach ($roles as $role) {
            if (($role["object_type"] == "crs" || $role["object_type"] == "grp")
                && !in_array($role["object_id"], $objects)) {
                $objects[] = $role["object_id"];
            }
        }

        return $objects;
    }
}