ilSkillUsage Class Reference

Skill usage. More...

Inheritance diagram for ilSkillUsage:

Collaboration diagram for ilSkillUsage:

Public Member Functions
	getAllUsagesInfo ($a_cskill_ids)
	Get all usages info. More...
	getAllUsagesInfoOfSubtree ($a_skill_id, $a_tref_id=0)
	Get all usages info of subtree. More...
	getAllUsagesInfoOfSubtrees ($a_cskill_ids)
	Get all usages info of subtree. More...
	getAllUsagesOfTemplate ($a_tempate_id)
	Get all usages of template. More...
	getAssignedObjectsForSkill (int $a_skill_id, int $a_tref_id)
	getAssignedObjectsForSkillTemplate (int $a_template_id)
	getAssignedObjectsForSkillProfile (int $a_profile_id)

Static Public Member Functions
static	setUsage ($a_obj_id, $a_skill_id, $a_tref_id, $a_use=true)
	Set usage. More...
static	removeUsagesFromObject ($a_obj_id)
static	getUsages ($a_skill_id, $a_tref_id)
	Get usages. More...
static	getUsageInfo ($a_cskill_ids, &$a_usages)
	Get usage info. More...
static	getUsageInfoGeneric ( $a_cskill_ids, &$a_usages, $a_usage_type, $a_table, $a_key_field, $a_skill_field="skill_id", $a_tref_field="tref_id")
	Get standard usage query. More...
static	getTypeInfoString ($a_type)
	Get type info string. More...
static	getObjTypeString ($a_type)
	Get type info string. More...

Data Fields
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"

Protected Attributes
	$classes = array("ilBasicSkill", "ilPersonalSkill", "ilSkillProfile", "ilSkillResources", "ilSkillUsage")

Detailed Description

Skill usage.

With this class a general skill use by an object (identified by its obj_id) is registered or unregistered.

The class maintains skill usages of the following types

• GENERAL: General use submitted by an object, saved in table "skl_usage"
• USER_ASSIGNED: Skill level is assigned to a user (tables skl_user_skill_level and skl_user_has_level)
• PERSONAL_SKILL: table skl_personal_skill (do we need that?)
• USER_MATERIAL: User has assigned material to the skill
• SELF_EVAL: User has self evaluated (may be USER_ASSIGNED in the future)
• PROFILE: Skill is used in skill profile (table "skl_profile_level")
• RESOURCE: A resource is assigned to a skill level (table "skl_skill_resource")

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Definition at line 22 of file class.ilSkillUsage.php.

Member Function Documentation

getAllUsagesInfo()

ilSkillUsage::getAllUsagesInfo

(

$a_cskill_ids

)

Get all usages info.

Parameters

array

of common skill ids ("skill_id" => skill_id, "tref_id" => tref_id)

Returns

array usages

Definition at line 178 of file class.ilSkillUsage.php.

References $classes.

Referenced by getAllUsagesInfoOfSubtree(), and getAllUsagesInfoOfSubtrees().

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

Here is the caller graph for this function:

getAllUsagesInfoOfSubtree()

ilSkillUsage::getAllUsagesInfoOfSubtree	(		$a_skill_id,
			$a_tref_id = 0
	)

Get all usages info of subtree.

Parameters

int	$a_skill_id	skill node id
int	$a_tref_id	tref id

Returns

array usages

Definition at line 196 of file class.ilSkillUsage.php.

References getAllUsagesInfo().

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

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

Here is the call graph for this function:

getAllUsagesInfoOfSubtrees()

ilSkillUsage::getAllUsagesInfoOfSubtrees

(

$a_cskill_ids

)

Get all usages info of subtree.

Parameters

array

$a_cskill_ids

array of common skill ids ("skill_id" => skill_id, "tref_id" => tref_id)

Returns

array usages

Definition at line 211 of file class.ilSkillUsage.php.

References $n, and getAllUsagesInfo().

Referenced by getAllUsagesOfTemplate().

    {
        // 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);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getAllUsagesOfTemplate()

ilSkillUsage::getAllUsagesOfTemplate

(

$a_tempate_id

)

Get all usages of template.

Parameters

int

$a_tempate_id

template

Returns

array usages array

Definition at line 232 of file class.ilSkillUsage.php.

References ilSkillTemplateReference\_lookupTrefIdsForTemplateId(), getAllUsagesInfoOfSubtrees(), and ilLoggerFactory\getLogger().

Referenced by getAssignedObjectsForSkillTemplate().

    {
        $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);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getAssignedObjectsForSkill()

ilSkillUsage::getAssignedObjectsForSkill	(	int	$a_skill_id,
		int	$a_tref_id
	)

Parameters

int	$a_skill_id
int	$a_tref_id

Returns

array

Definition at line 305 of file class.ilSkillUsage.php.

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

        return $objects;
    }

getAssignedObjectsForSkillProfile()

ilSkillUsage::getAssignedObjectsForSkillProfile

(

int

$a_profile_id

)

Parameters

int

$a_profile_id

Returns

array

Definition at line 332 of file class.ilSkillUsage.php.

                                                                         : 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;
    }

getAssignedObjectsForSkillTemplate()

ilSkillUsage::getAssignedObjectsForSkillTemplate

(

int

$a_template_id

)

Parameters

int

$a_template_id

Returns

array

Definition at line 317 of file class.ilSkillUsage.php.

References getAllUsagesOfTemplate().

                                                                           : 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"];
    }

Here is the call graph for this function:

getObjTypeString()

static ilSkillUsage::getObjTypeString (   $a_type )

static

Get type info string.

Parameters

Definition at line 273 of file class.ilSkillUsage.php.

References $DIC, and $lng.

Referenced by ilSkillUsageTableGUI\fillRow().

    {
        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);
    }

Here is the caller graph for this function:

getTypeInfoString()

static ilSkillUsage::getTypeInfoString (   $a_type )

static

Get type info string.

Parameters

string

$a_type

usage type

Returns

string lang string

Definition at line 258 of file class.ilSkillUsage.php.

References $DIC, and $lng.

Referenced by ilSkillUsageTableGUI\fillRow().

    {
        global $DIC;

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

Here is the caller graph for this function:

getUsageInfo()

static ilSkillUsage::getUsageInfo (   $a_cskill_ids, &  $a_usages  )

static

Get usage info.

Parameters

array	$a_cskill_ids	skill ids
array	$a_usages	usages array

Implements ilSkillUsageInfo.

Definition at line 117 of file class.ilSkillUsage.php.

References $DIC, $ilDB, and TYPE_GENERAL.

    {
        global $DIC;

        $ilDB = $DIC->database();
        
        self::getUsageInfoGeneric(
            $a_cskill_ids,
            $a_usages,
            ilSkillUsage::TYPE_GENERAL,
            "skl_usage",
            "obj_id"
        );
    }

getUsageInfoGeneric()

static ilSkillUsage::getUsageInfoGeneric (   $a_cskill_ids, &  $a_usages,   $a_usage_type,   $a_table,   $a_key_field,   $a_skill_field = "skill_id",   $a_tref_field = "tref_id"  )

static

Get standard usage query.

Parameters

array	$a_cskill_ids	skill ids
array	$a_usages	usages array

Definition at line 138 of file class.ilSkillUsage.php.

References $DIC, and $ilDB.

Referenced by ilSkillResources\getUsageInfo(), ilPersonalSkill\getUsageInfo(), ilBasicSkill\getUsageInfo(), and ilSkillProfile\getUsageInfo().

      {
        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]);
        }
    }

Here is the caller graph for this function:

getUsages()

static ilSkillUsage::getUsages (   $a_skill_id,   $a_tref_id  )

static

Get usages.

Parameters

int	$a_skill_id	skill id
int	$a_tref_id	tref id

Returns

array of int object ids

Definition at line 92 of file class.ilSkillUsage.php.

References $DIC, and $ilDB.

    {
        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;
    }

removeUsagesFromObject()

static ilSkillUsage::removeUsagesFromObject (   $a_obj_id )

static

Definition at line 73 of file class.ilSkillUsage.php.

References $DIC, and $ilDB.

Referenced by ilSkillObjDeletionHandler\processDeletion().

    {
        global $DIC;

        $ilDB = $DIC->database();

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

Here is the caller graph for this function:

setUsage()

static ilSkillUsage::setUsage (   $a_obj_id,   $a_skill_id,   $a_tref_id,   $a_use = true  )

static

Set usage.

Parameters

int	$a_obj_id	object id
int	$a_skill_id	skill id
int	$a_tref_id	tref id
bool	$a_use	in use true/false

Definition at line 46 of file class.ilSkillUsage.php.

References $DIC, and $ilDB.

Referenced by ilSurveySkill\addQuestionSkillAssignment(), ilContSkillAdminGUI\removeSelectedSkill(), ilSurveySkill\removeUsagesOfSkills(), and ilContSkillAdminGUI\saveSelectedSkill().

    {
        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;
        }
    }

Here is the caller graph for this function:

Field Documentation

$classes

ilSkillUsage::$classes = array("ilBasicSkill", "ilPersonalSkill", "ilSkillProfile", "ilSkillResources", "ilSkillUsage")

protected

Definition at line 36 of file class.ilSkillUsage.php.

Referenced by getAllUsagesInfo().

PERSONAL_SKILL

const ilSkillUsage::PERSONAL_SKILL = "pers"

Definition at line 26 of file class.ilSkillUsage.php.

Referenced by ilPersonalSkill\getUsageInfo().

PROFILE

const ilSkillUsage::PROFILE = "prof"

Definition at line 29 of file class.ilSkillUsage.php.

Referenced by ilSkillProfile\getUsageInfo().

RESOURCE

const ilSkillUsage::RESOURCE = "res"

Definition at line 30 of file class.ilSkillUsage.php.

Referenced by ilSkillResources\getUsageInfo().

SELF_EVAL

const ilSkillUsage::SELF_EVAL = "seval"

Definition at line 28 of file class.ilSkillUsage.php.

Referenced by ilPersonalSkill\getUsageInfo().

TYPE_GENERAL

const ilSkillUsage::TYPE_GENERAL = "gen"

Definition at line 24 of file class.ilSkillUsage.php.

Referenced by getUsageInfo().

USER_ASSIGNED

const ilSkillUsage::USER_ASSIGNED = "user"

Definition at line 25 of file class.ilSkillUsage.php.

Referenced by ilBasicSkill\getUsageInfo().

USER_MATERIAL

const ilSkillUsage::USER_MATERIAL = "mat"

Definition at line 27 of file class.ilSkillUsage.php.

Referenced by ilPersonalSkill\getUsageInfo().

---

The documentation for this class was generated from the following file:

• Services/Skill/classes/class.ilSkillUsage.php