Skill usage. More...

Inheritance diagram for ilSkillUsage:

Collaboration diagram for ilSkillUsage:

Public Member Functions
	__construct ()

	getAllUsagesInfo (array $a_cskill_ids)

	getAllUsagesInfoOfTrees (array $a_tree_ids)

	getAllUsagesInfoOfSubtree (int $a_skill_id, int $a_tref_id=0)

	getAllUsagesInfoOfSubtrees (array $a_cskill_ids)

	getAllUsagesOfTemplate (int $a_template_id)

	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 (int $a_obj_id, int $a_skill_id, int $a_tref_id, bool $a_use=true)

static	removeUsagesFromObject (int $a_obj_id)

static	getUsages (int $a_skill_id, int $a_tref_id)

static	getUsageInfo (array $a_cskill_ids)

static	getUsageInfoGeneric (array $a_cskill_ids, string $a_usage_type, string $a_table, string $a_key_field, string $a_skill_field="skill_id", string $a_tref_field="tref_id")
	Get standard usage query. More...

static	getTypeInfoString (string $a_type)

static	getObjTypeString (string $a_type)

static	getUsageInfo (array $a_cskill_ids)
	Get title of an assigned item. 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
array	$classes

ilSkillTreeRepository	$tree_repo

SkillInternalFactoryService	$tree_factory

SkillProfileManager	$profile_manager

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 41 of file class.ilSkillUsage.php.

Constructor & Destructor Documentation

◆ __construct()

ilSkillUsage::__construct ( )

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

    {
        global $DIC;
 
        $this->tree_repo = $DIC->skills()->internal()->repo()->getTreeRepo();
        $this->tree_factory = $DIC->skills()->internal()->factory();
        $this->profile_manager = $DIC->skills()->internal()->manager()->getProfileManager();
    }

References $DIC.

Member Function Documentation

◆ getAllUsagesInfo()

ilSkillUsage::getAllUsagesInfo ( array $a_cskill_ids )

Parameters

array{skill_id int, tref_id: int}[] $a_cskill_ids array of common skill ids ("skill_id" => skill_id, "tref_id" => tref_id)

Returns: array<string, array<string, array{key: string}[]>>

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

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

◆ getAllUsagesInfoOfSubtree()

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

Returns: array<string, array<string, array{key: string}[]>>

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

                                                                                  : array
    {
        // get nodes
        $vtree = $this->tree_repo->getVirtualTreeForNodeId($a_skill_id);
        $nodes = $vtree->getSubTreeForCSkillId($a_skill_id . ":" . $a_tref_id);
 
        return $this->getAllUsagesInfo($nodes);
    }

◆ getAllUsagesInfoOfSubtrees()

ilSkillUsage::getAllUsagesInfoOfSubtrees ( array $a_cskill_ids )

Parameters

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

Returns: array<string, array<string, array{key: string}[]>>

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

                                                                   : array
    {
        // get nodes
        $allnodes = [];
        foreach ($a_cskill_ids as $s) {
            $vtree = $this->tree_repo->getVirtualTreeForNodeId($s["skill_id"]);
            $nodes = $vtree->getSubTreeForCSkillId($s["skill_id"] . ":" . $s["tref_id"]);
            foreach ($nodes as $n) {
                $allnodes[] = $n;
            }
        }
 
        return $this->getAllUsagesInfo($allnodes);
    }

◆ getAllUsagesInfoOfTrees()

ilSkillUsage::getAllUsagesInfoOfTrees ( array $a_tree_ids )

Parameters

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

Returns: array<string, array<string, array{key: string}[]>>

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

                                                              : array
    {
        // get nodes
 
        $allnodes = [];
        foreach ($a_tree_ids as $t) {
            $vtree = $this->tree_factory->tree()->getGlobalVirtualTree();
            $nodes = $vtree->getSubTreeForTreeId($t);
            foreach ($nodes as $n) {
                $allnodes[] = $n;
            }
        }
 
        return $this->getAllUsagesInfo($allnodes);
    }

◆ getAllUsagesOfTemplate()

ilSkillUsage::getAllUsagesOfTemplate ( int $a_template_id )

Returns: array<string, array<string, array{key: string}[]>>

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

                                                              : array
    {
        $skill_logger = ilLoggerFactory::getLogger('skll');
        $skill_logger->debug("ilSkillUsage: getAllUsagesOfTemplate(" . $a_template_id . ")");
 
        // get all trefs for template id
        $trefs = ilSkillTemplateReference::_lookupTrefIdsForTemplateId($a_template_id);
 
        // get all usages of subtrees of template_id:tref
        $cskill_ids = [];
        foreach ($trefs as $tref) {
            $cskill_ids[] = array("skill_id" => $a_template_id, "tref_id" => $tref);
            $skill_logger->debug("ilSkillUsage: ... skill_id: " . $a_template_id . ", tref_id: " . $tref . ".");
        }
 
        $skill_logger->debug("ilSkillUsage: ... count cskill_ids: " . count($cskill_ids) . ".");
 
        return $this->getAllUsagesInfoOfSubtrees($cskill_ids);
    }

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

Here is the call graph for this function:

◆ getAssignedObjectsForSkill()

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

Returns: int[]

Definition at line 313 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 )

Returns: int[]

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

                                                                        : array
    {
        $profile = $this->profile_manager->getById($a_profile_id);
        $skills = $profile->getSkillLevels();
        $objects = [];
 
        // 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 = $this->profile_manager->getAssignedRoles($profile->getId());
        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;
    }

References $id.

◆ getAssignedObjectsForSkillTemplate()

ilSkillUsage::getAssignedObjectsForSkillTemplate ( int $a_template_id )

Returns: string[]

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

                                                                          : array
    {
        $usages = $this->getAllUsagesOfTemplate($a_template_id);
        $obj_usages = array_column($usages, "gen");
 
        return array_column(current(array_reverse($obj_usages)) ?: [], 'key');
    }

◆ getObjTypeString()

static ilSkillUsage::getObjTypeString ( string $a_type )

static

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

                                                           : string
    {
        global $DIC;
 
        $lng = $DIC->language();
 
        switch ($a_type) {
            case self::TYPE_GENERAL:
            case self::RESOURCE:
                return $lng->txt("skmg_usage_obj_objects");
 
            case self::USER_ASSIGNED:
            case self::PERSONAL_SKILL:
            case self::USER_MATERIAL:
            case self::SELF_EVAL:
                return $lng->txt("skmg_usage_obj_users");
 
            case self::PROFILE:
                return $lng->txt("skmg_usage_obj_profiles");
 
            default:
                return $lng->txt("skmg_usage_type_info_" . $a_type);
        }
    }

References $DIC, and $lng.

Referenced by ilSkillUsageTableGUI\fillRow().

Here is the caller graph for this function:

◆ getTypeInfoString()

static ilSkillUsage::getTypeInfoString ( string $a_type )

static

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

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

References $DIC, and $lng.

Referenced by ilSkillUsageTableGUI\fillRow().

Here is the caller graph for this function:

◆ getUsageInfo()

static ilSkillUsage::getUsageInfo ( array $a_cskill_ids )

static

Parameters

array{skill_id int, tref_id: int}[] $a_cskill_ids

Returns: array<string, array<string, array{key: string}[]>>

Implements ilSkillUsageInfo.

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

                                                            : array
    {
        return self::getUsageInfoGeneric(
            $a_cskill_ids,
            ilSkillUsage::TYPE_GENERAL,
            "skl_usage",
            "obj_id"
        );
    }

References getUsageInfoGeneric(), and TYPE_GENERAL.

Here is the call graph for this function:

◆ getUsageInfoGeneric()

static ilSkillUsage::getUsageInfoGeneric	(	array	$a_cskill_ids,
		string	$a_usage_type,
		string	$a_table,
		string	$a_key_field,
		string	$a_skill_field = `"skill_id"`,
		string	$a_tref_field = `"tref_id"`
	)

static

Get standard usage query.

Parameters

array{skill_id int, tref_id: int}[] $a_cskill_ids

Returns: array<string, array<string, array{key: string}[]>>

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

     : array {
        global $DIC;
 
        $a_usages = [];
 
        $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]);
        }
 
        return $a_usages;
    }

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

Here is the caller graph for this function:

◆ getUsages()

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

static

Returns: int[]

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

                                                                     : array
    {
        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 = [];
        while ($rec = $ilDB->fetchAssoc($set)) {
            $obj_ids[] = (int) $rec["obj_id"];
        }
 
        return $obj_ids;
    }

References $DIC, $ilDB, and ILIAS\Repository\int().

Here is the call graph for this function:

◆ removeUsagesFromObject()

static ilSkillUsage::removeUsagesFromObject ( int $a_obj_id )

static

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

                                                                : void
    {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $ilDB->manipulate(
            $q = "DELETE FROM skl_usage WHERE " .
                " obj_id = " . $ilDB->quote($a_obj_id, "integer")
        );
    }

References $DIC, and $ilDB.

Referenced by ilSkillObjDeletionHandler\processDeletion().

Here is the caller graph for this function:

◆ setUsage()

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

static

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

                                                                                                       : void
    {
        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)
                    ),
                []
            );
        } 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")
            );
        }
    }

References $DIC, and $ilDB.

Referenced by assQuestion\delete(), assQuestion\duplicateSkillAssignments(), ilAssQuestionSkillAssignmentImporter\import(), ilContSkillAdminGUI\removeSelectedSkill(), ilContSkillAdminGUI\saveSelectedSkill(), ilAssQuestionSkillAssignmentsGUI\saveSkillPointsCmd(), ilAssQuestionSkillAssignmentsGUI\saveSkillQuestionAssignmentPropertiesFormCmd(), assQuestion\syncSkillAssignments(), and ilAssQuestionSkillAssignmentsGUI\updateSkillQuestionAssignmentsCmd().

Here is the caller graph for this function:

Field Documentation

◆ $classes

array ilSkillUsage::$classes

protected

Initial value:

= [ilBasicSkill::class, ilPersonalSkill::class, SkillProfile::class,

ilSkillResources::class, ilSkillUsage::class]

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

◆ $profile_manager

SkillProfileManager ilSkillUsage::$profile_manager

protected

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

◆ $tree_factory

SkillInternalFactoryService ilSkillUsage::$tree_factory

protected

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

◆ $tree_repo

ilSkillTreeRepository ilSkillUsage::$tree_repo

protected

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

◆ PERSONAL_SKILL

const ilSkillUsage::PERSONAL_SKILL = "pers"

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

Referenced by ilPersonalSkill\getUsageInfo().

◆ PROFILE

const ilSkillUsage::PROFILE = "prof"

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

Referenced by ILIAS\Skill\Profile\SkillProfile\getUsageInfo().

◆ RESOURCE

const ilSkillUsage::RESOURCE = "res"

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

Referenced by ilSkillResources\getUsageInfo().

◆ SELF_EVAL

const ilSkillUsage::SELF_EVAL = "seval"

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

◆ TYPE_GENERAL

const ilSkillUsage::TYPE_GENERAL = "gen"

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

Referenced by getUsageInfo().

◆ USER_ASSIGNED

const ilSkillUsage::USER_ASSIGNED = "user"

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

Referenced by ilBasicSkill\getUsageInfo().

◆ USER_MATERIAL

const ilSkillUsage::USER_MATERIAL = "mat"

Definition at line 46 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

Public Member Functions

Static Public Member Functions

Data Fields

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getAllUsagesInfo()

◆ getAllUsagesInfoOfSubtree()

◆ getAllUsagesInfoOfSubtrees()

◆ getAllUsagesInfoOfTrees()

◆ getAllUsagesOfTemplate()

◆ getAssignedObjectsForSkill()

◆ getAssignedObjectsForSkillProfile()

◆ getAssignedObjectsForSkillTemplate()

◆ getObjTypeString()

◆ getTypeInfoString()

◆ getUsageInfo()

◆ getUsageInfoGeneric()

◆ getUsages()

◆ removeUsagesFromObject()

◆ setUsage()

Field Documentation

◆ $classes

◆ $profile_manager

◆ $tree_factory

◆ $tree_repo

◆ PERSONAL_SKILL

◆ PROFILE

◆ RESOURCE

◆ SELF_EVAL

◆ TYPE_GENERAL

◆ USER_ASSIGNED

◆ USER_MATERIAL