Manages skill profile completion. More...

Collaboration diagram for ILIAS\Skill\Profile\SkillProfileCompletionManager:

Public Member Functions
	__construct (SkillProfileManager $profile_manager, ?SkillProfileCompletionDBRepository $profile_completion_repo=null)

	getActualMaxLevels (int $user_id, array $skills, string $gap_mode="", string $gap_mode_type="", int $gap_mode_obj_id=0)

	getActualLastLevels (int $user_id, array $skills, string $gap_mode="", string $gap_mode_type="", int $gap_mode_obj_id=0)

	getActualNextLevelFulfilments (int $user_id, array $skills, string $gap_mode="", string $gap_mode_type="", int $gap_mode_obj_id=0)

	getProfileProgress (int $user_id, int $profile_id)
	Get progress in percent for a profile. More...

	isProfileFulfilled (int $user_id, int $profile_id)
	Check if a profile is fulfilled (progress = 100%) More...

	getAllProfileCompletionsForUser (int $user_id)
	Get all profiles of user which are fulfilled or non-fulfilled. More...

	getEntries (int $user_id, int $profile_id)
	Get profile completion entries for given user-profile-combination. More...

	getFulfilledEntriesForUser (int $user_id)
	Get all profile completion entries for a user. More...

	getAllEntriesForUser (int $user_id)
	Get all profile completion entries for a user. More...

	getAllEntriesForProfile (int $profile_id)
	Get all completion entries for a single profile. More...

	writeCompletionEntryForAllProfiles (int $user_id)
	Write profile completion entries (fulfilled or non-fulfilled) of user for all profiles. More...

	writeCompletionEntryForSingleProfile (int $user_id, int $profile_id)
	Write profile completion entry (fulfilled or non-fulfilled) of user for given profile. More...

	deleteEntriesForProfile (int $profile_id)
	Delete all profile completion entries for a profile. More...

	deleteEntriesForUser (int $user_id)
	Delete all profile completion entries for a user. More...

Protected Attributes
SkillProfileManager	$profile_manager

SkillProfileCompletionDBRepository	$profile_completion_repo

ilTree	$tree_service

ilObjectDefinition	$obj_definition

Detailed Description

Manages skill profile completion.

(business logic)

Author: Thomas Famula famul.nosp@m.a@le.nosp@m.ifos..nosp@m.de

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

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Skill\Profile\SkillProfileCompletionManager::__construct	(	SkillProfileManager	$profile_manager,
		?SkillProfileCompletionDBRepository	$profile_completion_repo = `null`
	)

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

      {
        global $DIC;
 
        $this->profile_manager = $profile_manager;
        $this->profile_completion_repo = ($profile_completion_repo)
            ?: $DIC->skills()->internal()->repo()->getProfileCompletionRepo();
        $this->tree_service = $DIC->repositoryTree();
        $this->obj_definition = $DIC["objDefinition"];
    }

References $DIC, ILIAS\Skill\Profile\SkillProfileCompletionManager\$profile_completion_repo, and ILIAS\Skill\Profile\SkillProfileCompletionManager\$profile_manager.

Member Function Documentation

◆ deleteEntriesForProfile()

ILIAS\Skill\Profile\SkillProfileCompletionManager::deleteEntriesForProfile ( int $profile_id )

Delete all profile completion entries for a profile.

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

                                                            : void
    {
        $this->profile_completion_repo->deleteEntriesForProfile($profile_id);
    }

◆ deleteEntriesForUser()

ILIAS\Skill\Profile\SkillProfileCompletionManager::deleteEntriesForUser ( int $user_id )

Delete all profile completion entries for a user.

Definition at line 266 of file class.SkillProfileCompletionManager.php.

                                                      : void
    {
        $this->profile_completion_repo->deleteEntriesForUser($user_id);
    }

◆ getActualLastLevels()

ILIAS\Skill\Profile\SkillProfileCompletionManager::getActualLastLevels	(	int	$user_id,
		array	$skills,
		string	$gap_mode = `""`,
		string	$gap_mode_type = `""`,
		int	$gap_mode_obj_id = `0`
	)

Definition at line 93 of file class.SkillProfileCompletionManager.php.

     : array {
        // todo for coming feature
        return [];
    }

◆ getActualMaxLevels()

ILIAS\Skill\Profile\SkillProfileCompletionManager::getActualMaxLevels	(	int	$user_id,
		array	$skills,
		string	$gap_mode = `""`,
		string	$gap_mode_type = `""`,
		int	$gap_mode_obj_id = `0`
	)

Parameters

array{base_skill_id int, tref_id: int, level_id: int} $skills

Returns: array<int, array<int, int>>

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

     : array {
        // get actual levels for gap analysis
        $actual_levels = [];
        foreach ($skills as $sk) {
            $bs = new \ilBasicSkill($sk["base_skill_id"]);
            if ($gap_mode == "max_per_type") {
                $max = $bs->getMaxLevelPerType($sk["tref_id"], $gap_mode_type, $user_id);
            } elseif ($gap_mode == "max_per_object") {
                if ($this->obj_definition->isContainer(\ilObject::_lookupType($gap_mode_obj_id))) {
                    $sub_objects = $this->tree_service->getSubTree(
                        $this->tree_service->getNodeData((int) current(\ilObject::_getAllReferences($gap_mode_obj_id))),
                        false,
                        \ilObjectLP::getSupportedObjectTypes()
                    );
                    $max = 0;
                    foreach ($sub_objects as $ref_id) {
                        $obj_id = \ilContainerReference::_lookupObjectId($ref_id);
                        $max_tmp = $bs->getMaxLevelPerObject($sk["tref_id"], $obj_id, $user_id);
                        if ($max_tmp > $max) {
                            $max = $max_tmp;
                        }
                    }
                } else {
                    $max = $bs->getMaxLevelPerObject($sk["tref_id"], $gap_mode_obj_id, $user_id);
                }
            } else {
                $max = $bs->getMaxLevel($sk["tref_id"], $user_id);
            }
            $actual_levels[$sk["base_skill_id"]][$sk["tref_id"]] = $max;
        }
 
        return $actual_levels;
    }

References $ref_id, ilObject\_getAllReferences(), ilObject\_lookupObjectId(), ilObject\_lookupType(), and ilObjectLP\getSupportedObjectTypes().

Here is the call graph for this function:

◆ getActualNextLevelFulfilments()

ILIAS\Skill\Profile\SkillProfileCompletionManager::getActualNextLevelFulfilments	(	int	$user_id,
		array	$skills,
		string	$gap_mode = `""`,
		string	$gap_mode_type = `""`,
		int	$gap_mode_obj_id = `0`
	)

Parameters

array{base_skill_id int, tref_id: int, level_id: int} $skills

Returns: array<int, array<int, float>>

Definition at line 108 of file class.SkillProfileCompletionManager.php.

     : array {
        // get actual next level fulfilments for gap analysis
        $fuls = [];
        foreach ($skills as $sk) {
            $bs = new \ilBasicSkill($sk["base_skill_id"]);
            if ($gap_mode == "max_per_type") {
                $perc = $bs->getNextLevelFulfilmentPerType($sk["tref_id"], $gap_mode_type, $user_id);
            } elseif ($gap_mode == "max_per_object") {
                $perc = $bs->getNextLevelFulfilmentPerObject($sk["tref_id"], $gap_mode_obj_id, $user_id);
            } else {
                $perc = $bs->getNextLevelFulfilment($sk["tref_id"], $user_id);
            }
            $fuls[$sk["base_skill_id"]][$sk["tref_id"]] = $perc;
        }
 
        return $fuls;
    }

◆ getAllEntriesForProfile()

ILIAS\Skill\Profile\SkillProfileCompletionManager::getAllEntriesForProfile ( int $profile_id )

Get all completion entries for a single profile.

Definition at line 223 of file class.SkillProfileCompletionManager.php.

                                                            : array
    {
        return $this->profile_completion_repo->getAllEntriesForProfile($profile_id);
    }

◆ getAllEntriesForUser()

ILIAS\Skill\Profile\SkillProfileCompletionManager::getAllEntriesForUser ( int $user_id )

Get all profile completion entries for a user.

Definition at line 215 of file class.SkillProfileCompletionManager.php.

                                                      : array
    {
        return $this->profile_completion_repo->getAllEntriesForUser($user_id);
    }

◆ getAllProfileCompletionsForUser()

ILIAS\Skill\Profile\SkillProfileCompletionManager::getAllProfileCompletionsForUser ( int $user_id )

Get all profiles of user which are fulfilled or non-fulfilled.

Returns: array<int, bool>

Definition at line 180 of file class.SkillProfileCompletionManager.php.

                                                                 : array
    {
        $user_profiles = $this->profile_manager->getProfilesOfUser($user_id);
        $profile_comps = [];
        foreach ($user_profiles as $p) {
            if ($this->isProfileFulfilled($user_id, $p["id"])) {
                $profile_comps[$p["id"]] = true;
            } else {
                $profile_comps[$p["id"]] = false;
            }
        }
 
        return $profile_comps;
    }

◆ getEntries()

ILIAS\Skill\Profile\SkillProfileCompletionManager::getEntries	(	int	$user_id,
		int	$profile_id
	)

Get profile completion entries for given user-profile-combination.

Definition at line 198 of file class.SkillProfileCompletionManager.php.

                                                             : array
    {
        return $this->profile_completion_repo->getEntries($user_id, $profile_id);
    }

◆ getFulfilledEntriesForUser()

ILIAS\Skill\Profile\SkillProfileCompletionManager::getFulfilledEntriesForUser ( int $user_id )

Get all profile completion entries for a user.

Returns: array{profile_id: int, user_id: int, date: string, fulfilled: int}[]

Definition at line 207 of file class.SkillProfileCompletionManager.php.

                                                            : array
    {
        return $this->profile_completion_repo->getFulfilledEntriesForUser($user_id);
    }

◆ getProfileProgress()

ILIAS\Skill\Profile\SkillProfileCompletionManager::getProfileProgress	(	int	$user_id,
		int	$profile_id
	)

Get progress in percent for a profile.

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

                                                                     : int
    {
        $profile = $this->profile_manager->getById($profile_id);
        $profile_levels = $profile->getSkillLevels();
        $skills = [];
        foreach ($profile_levels as $l) {
            $skills[] = array(
                "base_skill_id" => $l["base_skill_id"],
                "tref_id" => $l["tref_id"],
                "level_id" => $l["level_id"]
            );
        }
        $actual_levels = $this->getActualMaxLevels($user_id, $skills);
 
        $profile_count = 0;
        $achieved_count = 0;
        foreach ($profile_levels as $profile) {
            if ($actual_levels[$profile["base_skill_id"]][$profile["tref_id"]] >= $profile["level_id"]) {
                $achieved_count++;
            }
            $profile_count++;
        }
        if ($profile_count == 0) {
            return 0;
        }
        $progress = $achieved_count / $profile_count * 100;
 
        return (int) $progress;
    }

◆ isProfileFulfilled()

ILIAS\Skill\Profile\SkillProfileCompletionManager::isProfileFulfilled	(	int	$user_id,
		int	$profile_id
	)

Check if a profile is fulfilled (progress = 100%)

Definition at line 168 of file class.SkillProfileCompletionManager.php.

                                                                     : bool
    {
        if ($this->getProfileProgress($user_id, $profile_id) == 100) {
            return true;
        }
        return false;
    }

◆ writeCompletionEntryForAllProfiles()

ILIAS\Skill\Profile\SkillProfileCompletionManager::writeCompletionEntryForAllProfiles ( int $user_id )

Write profile completion entries (fulfilled or non-fulfilled) of user for all profiles.

Definition at line 231 of file class.SkillProfileCompletionManager.php.

                                                                    : void
    {
        $completions = $this->getAllProfileCompletionsForUser($user_id);
        foreach ($completions as $profile_id => $fulfilled) {
            if ($fulfilled) {
                $this->profile_completion_repo->addFulfilmentEntry($user_id, $profile_id);
            } else {
                $this->profile_completion_repo->addNonFulfilmentEntry($user_id, $profile_id);
            }
        }
    }

◆ writeCompletionEntryForSingleProfile()

ILIAS\Skill\Profile\SkillProfileCompletionManager::writeCompletionEntryForSingleProfile	(	int	$user_id,
		int	$profile_id
	)

Write profile completion entry (fulfilled or non-fulfilled) of user for given profile.

Definition at line 246 of file class.SkillProfileCompletionManager.php.

                                                                                       : void
    {
        if ($this->isProfileFulfilled($user_id, $profile_id)) {
            $this->profile_completion_repo->addFulfilmentEntry($user_id, $profile_id);
        } else {
            $this->profile_completion_repo->addNonFulfilmentEntry($user_id, $profile_id);
        }
    }