ILIAS\Skill\Usage\SkillUsageManager Class Reference

Skill usage. More...

Inheritance diagram for ILIAS\Skill\Usage\SkillUsageManager:

Collaboration diagram for ILIAS\Skill\Usage\SkillUsageManager:

Public Member Functions
	__construct (?SkillUsageDBRepository $usage_repo=null, ?SkillTreeFactory $tree_factory=null, ?\ilSkillTreeRepository $tree_repo=null, ?SkillProfileManager $profile_manager=null)
	addUsage (int $obj_id, int $skill_id, int $tref_id)
	removeUsage (int $obj_id, int $skill_id, int $tref_id)
	removeUsagesFromObject (int $obj_id)
	removeUsagesForSkill (int $node_id, bool $is_referenece=false)
	getUsages (int $skill_id, int $tref_id)
	getUsageInfoGeneric (array $cskill_ids, string $usage_type, string $table, string $key_field, string $skill_field="skill_id", string $tref_field="tref_id")
	Get standard usage query. More...
	getAllUsagesInfo (array $cskill_ids)
	getAllUsagesInfoOfTrees (array $tree_ids)
	getAllUsagesInfoOfSubtree (int $skill_id, int $tref_id=0)
	getAllUsagesInfoOfSubtrees (array $cskill_ids)
	getAllUsagesOfTemplate (int $template_id)
	getTypeInfoString (string $type)
	getObjTypeString (string $type)
	getAssignedObjectsForSkill (int $skill_id, int $tref_id)
	getAssignedObjectsForSkillTemplate (int $template_id)
	getAssignedObjectsForSkillProfile (int $profile_id)

Static Public Member Functions
static	getUsageInfo (array $a_cskill_ids)
	Get title of an assigned item. Parameters array{skill_id int, tref_id: int}[] $a_cskill_ids array of common skill ids Returns array<string, array<string, array{key: string}[]>> More...
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
SkillUsageDBRepository	$usage_repo
SkillTreeFactory	$tree_factory
ilSkillTreeRepository	$tree_repo
SkillProfileManager	$profile_manager
ilLanguage	$lng

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 killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..com

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

Constructor & Destructor Documentation

__construct()

ILIAS\Skill\Usage\SkillUsageManager::__construct	(	?SkillUsageDBRepository	$usage_repo = null,
		?SkillTreeFactory	$tree_factory = null,
		?\ilSkillTreeRepository	$tree_repo = null,
		?SkillProfileManager	$profile_manager = null
	)

Definition at line 67 of file class.SkillUsageManager.php.

      {
        global $DIC;
 
        $this->usage_repo = ($usage_repo) ?: $DIC->skills()->internal()->repo()->getUsageRepo();
        $this->tree_factory = ($tree_factory) ?: $DIC->skills()->internal()->factory()->tree();
        $this->tree_repo = ($tree_repo) ?: $DIC->skills()->internal()->repo()->getTreeRepo();
        $this->profile_manager = ($profile_manager) ?: $DIC->skills()->internal()->manager()->getProfileManager();
        $this->lng = $DIC->language();
    }

References $DIC, ILIAS\Skill\Usage\SkillUsageManager\$profile_manager, ILIAS\Skill\Usage\SkillUsageManager\$tree_factory, ILIAS\Skill\Usage\SkillUsageManager\$tree_repo, ILIAS\Skill\Usage\SkillUsageManager\$usage_repo, and ILIAS\Repository\lng().

Here is the call graph for this function:

Member Function Documentation

addUsage()

ILIAS\Skill\Usage\SkillUsageManager::addUsage	(	int	$obj_id,
		int	$skill_id,
		int	$tref_id
	)

Definition at line 82 of file class.SkillUsageManager.php.

                                                                      : void
    {
        $this->usage_repo->add($obj_id, $skill_id, $tref_id);
    }

getAllUsagesInfo()

ILIAS\Skill\Usage\SkillUsageManager::getAllUsagesInfo

(

array

$cskill_ids

)

Parameters

array{skill_id

int, tref_id: int}[] $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 160 of file class.SkillUsageManager.php.

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

getAllUsagesInfoOfSubtree()

ILIAS\Skill\Usage\SkillUsageManager::getAllUsagesInfoOfSubtree	(	int	$skill_id,
		int	$tref_id = 0
	)

Returns

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

Definition at line 194 of file class.SkillUsageManager.php.

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

getAllUsagesInfoOfSubtrees()

ILIAS\Skill\Usage\SkillUsageManager::getAllUsagesInfoOfSubtrees

(

array

$cskill_ids

)

Parameters

array

$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 207 of file class.SkillUsageManager.php.

                                                                 : array
    {
        // get nodes
        $allnodes = [];
        foreach ($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()

ILIAS\Skill\Usage\SkillUsageManager::getAllUsagesInfoOfTrees

(

array

$tree_ids

)

Parameters

array

$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 175 of file class.SkillUsageManager.php.

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

getAllUsagesOfTemplate()

ILIAS\Skill\Usage\SkillUsageManager::getAllUsagesOfTemplate

(

int

$template_id

)

Returns

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

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

                                                            : array
    {
        $skill_logger = \ilLoggerFactory::getLogger("skll");
        $skill_logger->debug("SkillUsageManager: getAllUsagesOfTemplate(" . $template_id . ")");
 
        // get all trefs for template id
        $trefs = \ilSkillTemplateReference::_lookupTrefIdsForTemplateId($template_id);
 
        // get all usages of subtrees of template_id:tref
        $cskill_ids = [];
        foreach ($trefs as $tref) {
            $cskill_ids[] = array("skill_id" => $template_id, "tref_id" => $tref);
            $skill_logger->debug("SkillUsageManager: ... skill_id: " . $template_id . ", tref_id: " . $tref . ".");
        }
 
        $skill_logger->debug("SkillUsageManager: ... 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()

ILIAS\Skill\Usage\SkillUsageManager::getAssignedObjectsForSkill	(	int	$skill_id,
		int	$tref_id
	)

Returns

int[]

Definition at line 274 of file class.SkillUsageManager.php.

                                                                           : array
    {
        //$objects = $this->getAllUsagesInfoOfSubtree($a_skill_id, $a_tref_id);
        $objects = $this->getUsages($skill_id, $tref_id);
 
        return $objects;
    }

getAssignedObjectsForSkillProfile()

ILIAS\Skill\Usage\SkillUsageManager::getAssignedObjectsForSkillProfile

(

int

$profile_id

)

Returns

int[]

Definition at line 296 of file class.SkillUsageManager.php.

                                                                      : array
    {
        $skills = $this->profile_manager->getSkillLevels($profile_id);
        $objects = [];
 
        // usages for skills within skill profile
        foreach ($skills as $skill) {
            $obj_usages = $this->getUsages($skill->getBaseSkillId(), $skill->getTrefId());
            foreach ($obj_usages as $id) {
                if (!in_array($id, $objects) && \ilObject::_hasUntrashedReference($id)) {
                    $objects[] = $id;
                }
            }
        }
 
        // courses and groups which are using skill profile
        $roles = $this->profile_manager->getRoleAssignments($profile_id);
        foreach ($roles as $role) {
            if (($role->getObjType() == "crs" || $role->getObjType() == "grp")
                && !in_array($role->getObjId(), $objects)) {
                $obj_ref_id = \ilObject::_getAllReferences($role->getObjId());
                $obj_ref_id = end($obj_ref_id);
                if ($role->getId() === \ilParticipants::getDefaultMemberRole($obj_ref_id)) {
                    $objects[] = $role->getObjId();
                }
            }
        }
 
        return $objects;
    }

References $id, ilObject\_getAllReferences(), ilObject\_hasUntrashedReference(), and ilParticipants\getDefaultMemberRole().

Here is the call graph for this function:

getAssignedObjectsForSkillTemplate()

ILIAS\Skill\Usage\SkillUsageManager::getAssignedObjectsForSkillTemplate

(

int

$template_id

)

Returns

string[]

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

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

getObjTypeString()

ILIAS\Skill\Usage\SkillUsageManager::getObjTypeString

(

string

$type

)

Definition at line 250 of file class.SkillUsageManager.php.

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

References ILIAS\Repository\lng().

Here is the call graph for this function:

getTypeInfoString()

ILIAS\Skill\Usage\SkillUsageManager::getTypeInfoString

(

string

$type

)

Definition at line 245 of file class.SkillUsageManager.php.

                                                   : string
    {
        return $this->lng->txt("skmg_usage_type_info_" . $type);
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

getUsageInfo()

static ILIAS\Skill\Usage\SkillUsageManager::getUsageInfo ( array  $a_cskill_ids )

static

Get title of an assigned item.

Parameters

array{skill_id

int, tref_id: int}[] $a_cskill_ids array of common skill ids

Returns

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

Implements ILIAS\Skill\Usage\SkillUsageInfo.

Definition at line 115 of file class.SkillUsageManager.php.

                                                            : array
    {
        $class = new self();
        return $class->getUsageInfoGeneric(
            $a_cskill_ids,
            self::TYPE_GENERAL,
            "skl_usage",
            "obj_id"
        );
    }

getUsageInfoGeneric()

ILIAS\Skill\Usage\SkillUsageManager::getUsageInfoGeneric	(	array	$cskill_ids,
		string	$usage_type,
		string	$table,
		string	$key_field,
		string	$skill_field = "skill_id",
		string	$tref_field = "tref_id"
	)

Get standard usage query.

Parameters

array{skill_id

int, tref_id: int}[] $cskill_ids

Returns

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

Definition at line 132 of file class.SkillUsageManager.php.

     : array {
        if (count($cskill_ids) === 0) {
            return [];
        }
 
        $usages = $this->usage_repo->getUsageInfoGeneric(
            $cskill_ids,
            $usage_type,
            $table,
            $key_field,
            $skill_field,
            $tref_field
        );
 
        return $usages;
    }

getUsages()

ILIAS\Skill\Usage\SkillUsageManager::getUsages	(	int	$skill_id,
		int	$tref_id
	)

Returns

int[]

Definition at line 105 of file class.SkillUsageManager.php.

                                                          : array
    {
        $obj_ids = $this->usage_repo->getUsages($skill_id, $tref_id);
 
        return $obj_ids;
    }

removeUsage()

ILIAS\Skill\Usage\SkillUsageManager::removeUsage	(	int	$obj_id,
		int	$skill_id,
		int	$tref_id
	)

Definition at line 87 of file class.SkillUsageManager.php.

                                                                         : void
    {
        $this->usage_repo->remove($obj_id, $skill_id, $tref_id);
    }

removeUsagesForSkill()

ILIAS\Skill\Usage\SkillUsageManager::removeUsagesForSkill	(	int	$node_id,
		bool	$is_referenece = false
	)

Definition at line 97 of file class.SkillUsageManager.php.

                                                                                   : void
    {
        $this->usage_repo->removeForSkill($node_id, $is_referenece);
    }

removeUsagesFromObject()

ILIAS\Skill\Usage\SkillUsageManager::removeUsagesFromObject

(

int

$obj_id

)

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

                                                       : void
    {
        $this->usage_repo->removeFromObject($obj_id);
    }

Field Documentation

$classes

array ILIAS\Skill\Usage\SkillUsageManager::$classes

protected

Initial value:

= [\ilBasicSkill::class, AssignedMaterialManager::class, SkillProfileManager::class,
                                SkillResourcesManager::class, SkillUsageManager::class]

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

$lng

ilLanguage ILIAS\Skill\Usage\SkillUsageManager::$lng

protected

Definition at line 65 of file class.SkillUsageManager.php.

$profile_manager

SkillProfileManager ILIAS\Skill\Usage\SkillUsageManager::$profile_manager

protected

Definition at line 64 of file class.SkillUsageManager.php.

Referenced by ILIAS\Skill\Usage\SkillUsageManager\__construct().

$tree_factory

SkillTreeFactory ILIAS\Skill\Usage\SkillUsageManager::$tree_factory

protected

Definition at line 62 of file class.SkillUsageManager.php.

Referenced by ILIAS\Skill\Usage\SkillUsageManager\__construct().

$tree_repo

ilSkillTreeRepository ILIAS\Skill\Usage\SkillUsageManager::$tree_repo

protected

Definition at line 63 of file class.SkillUsageManager.php.

Referenced by ILIAS\Skill\Usage\SkillUsageManager\__construct().

$usage_repo

SkillUsageDBRepository ILIAS\Skill\Usage\SkillUsageManager::$usage_repo

protected

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

Referenced by ILIAS\Skill\Usage\SkillUsageManager\__construct().

PERSONAL_SKILL

const ILIAS\Skill\Usage\SkillUsageManager::PERSONAL_SKILL = "pers"

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

Referenced by ILIAS\Skill\Personal\PersonalSkillDBRepository\getUsages().

PROFILE

const ILIAS\Skill\Usage\SkillUsageManager::PROFILE = "prof"

Definition at line 52 of file class.SkillUsageManager.php.

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

RESOURCE

const ILIAS\Skill\Usage\SkillUsageManager::RESOURCE = "res"

Definition at line 53 of file class.SkillUsageManager.php.

SELF_EVAL

const ILIAS\Skill\Usage\SkillUsageManager::SELF_EVAL = "seval"

Definition at line 51 of file class.SkillUsageManager.php.

TYPE_GENERAL

const ILIAS\Skill\Usage\SkillUsageManager::TYPE_GENERAL = "gen"

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

USER_ASSIGNED

const ILIAS\Skill\Usage\SkillUsageManager::USER_ASSIGNED = "user"

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

USER_MATERIAL

const ILIAS\Skill\Usage\SkillUsageManager::USER_MATERIAL = "mat"

Definition at line 50 of file class.SkillUsageManager.php.

Referenced by ILIAS\Skill\Personal\AssignedMaterialManager\getUsageInfo().

---

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

• components/ILIAS/Skill/Usage/class.SkillUsageManager.php