ILIAS\Skill\Profile\SkillProfileCompletionManager Class Reference

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 fulfilled 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...
	writeCompletionEntryForAllProfilesOfUser (int $user_id)
	Write profile completion entries (fulfilled or non-fulfilled) of user for all profiles. More...
	writeCompletionEntryForSingleProfileOfUser (int $user_id, int $profile_id)
	Write profile completion entry (fulfilled or non-fulfilled) of user for given profile. More...
	writeCompletionEntryForAllAssignedUsersOfProfile (int $profile_id)
	Write completion entries for a profile for all assigned users of the given profile. More...
	writeCompletionEntryForRole (int $role_id, int $profile_id)
	Write completion entries for a profile for assigned users of a role. 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 34 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 41 of file class.SkillProfileCompletionManager.php.

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

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

Member Function Documentation

deleteEntriesForProfile()

ILIAS\Skill\Profile\SkillProfileCompletionManager::deleteEntriesForProfile

(

int

$profile_id

)

Delete all profile completion entries for a profile.

Definition at line 279 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 287 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 98 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

GapAnalysisSkill[]

$skills

Returns

array<int, array<int, int>>

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

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

Referenced by ILIAS\Skill\Profile\SkillProfileCompletionManager\getProfileProgress().

     : array {
        // get actual levels for gap analysis
        $actual_levels = [];
        foreach ($skills as $sk) {
            $bs = new \ilBasicSkill($sk->getBaseSkillId());
            if ($gap_mode == "max_per_type") {
                $max = $bs->getMaxLevelPerType($sk->getTrefId(), $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->getTrefId(), $obj_id, $user_id);
                        if ($max_tmp > $max) {
                            $max = $max_tmp;
                        }
                    }
                } else {
                    $max = $bs->getMaxLevelPerObject($sk->getTrefId(), $gap_mode_obj_id, $user_id);
                }
            } else {
                $max = $bs->getMaxLevel($sk->getTrefId(), $user_id);
            }
            $actual_levels[$sk->getBaseSkillId()][$sk->getTrefId()] = $max;
        }

        return $actual_levels;
    }

Here is the call graph for this function:

Here is the caller 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

GapAnalysisSkill[]

$skills

Returns

array<int, array<int, float>>

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

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

        return $fuls;
    }

getAllEntriesForProfile()

ILIAS\Skill\Profile\SkillProfileCompletionManager::getAllEntriesForProfile

(

int

$profile_id

)

Get all completion entries for a single profile.

Returns

SkillProfileCompletion[]

Definition at line 222 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.

Returns

SkillProfileCompletion[]

Definition at line 213 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 176 of file class.SkillProfileCompletionManager.php.

References ILIAS\Skill\Profile\SkillProfileCompletionManager\isProfileFulfilled().

Referenced by ILIAS\Skill\Profile\SkillProfileCompletionManager\writeCompletionEntryForAllProfilesOfUser().

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

        return $profile_comps;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getEntries()

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

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

Returns

SkillProfileCompletion[]

Definition at line 195 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 fulfilled profile completion entries for a user.

Returns

SkillProfileCompletion[]

Definition at line 204 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 140 of file class.SkillProfileCompletionManager.php.

References ILIAS\Skill\Profile\SkillProfileCompletionManager\getActualMaxLevels().

Referenced by ILIAS\Skill\Profile\SkillProfileCompletionManager\isProfileFulfilled().

                                                                     : int
    {
        $profile_levels = $this->profile_manager->getSkillLevels($profile_id);
        $actual_levels = $this->getActualMaxLevels($user_id, $profile_levels);

        $profile_count = 0;
        $achieved_count = 0;
        foreach ($profile_levels as $level) {
            if ($actual_levels[$level->getBaseSkillId()][$level->getTrefId()] >= $level->getLevelId()) {
                $achieved_count++;
            }
            $profile_count++;
        }
        if ($profile_count == 0) {
            return 0;
        }
        $progress = $achieved_count / $profile_count * 100;

        return (int) $progress;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isProfileFulfilled()

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

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

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

References ILIAS\Skill\Profile\SkillProfileCompletionManager\getProfileProgress().

Referenced by ILIAS\Skill\Profile\SkillProfileCompletionManager\getAllProfileCompletionsForUser(), and ILIAS\Skill\Profile\SkillProfileCompletionManager\writeCompletionEntryForSingleProfileOfUser().

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

Here is the call graph for this function:

Here is the caller graph for this function:

writeCompletionEntryForAllAssignedUsersOfProfile()

ILIAS\Skill\Profile\SkillProfileCompletionManager::writeCompletionEntryForAllAssignedUsersOfProfile

(

int

$profile_id

)

Write completion entries for a profile for all assigned users of the given profile.

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

References ILIAS\Skill\Profile\SkillProfileCompletionManager\writeCompletionEntryForSingleProfileOfUser().

                                                                                     : void
    {
        $users = $this->profile_manager->getAssignedUserIdsIncludingRoleAssignments($profile_id);
        foreach ($users as $user_id) {
            $this->writeCompletionEntryForSingleProfileOfUser($user_id, $profile_id);
        }
    }

Here is the call graph for this function:

writeCompletionEntryForAllProfilesOfUser()

ILIAS\Skill\Profile\SkillProfileCompletionManager::writeCompletionEntryForAllProfilesOfUser

(

int

$user_id

)

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

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

References ILIAS\Skill\Profile\SkillProfileCompletionManager\getAllProfileCompletionsForUser().

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

Here is the call graph for this function:

writeCompletionEntryForRole()

ILIAS\Skill\Profile\SkillProfileCompletionManager::writeCompletionEntryForRole	(	int	$role_id,
		int	$profile_id
	)

Write completion entries for a profile for assigned users of a role.

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

References ILIAS\Skill\Profile\SkillProfileCompletionManager\writeCompletionEntryForSingleProfileOfUser().

                                                                              : void
    {
        $r_users = $this->profile_manager->getAssignedUsersForRole($role_id);
        foreach ($r_users as $user_id) {
            $this->writeCompletionEntryForSingleProfileOfUser($user_id, $profile_id);
        }
    }

Here is the call graph for this function:

writeCompletionEntryForSingleProfileOfUser()

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

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

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

References ILIAS\Skill\Profile\SkillProfileCompletionManager\isProfileFulfilled().

Referenced by ILIAS\Skill\Profile\SkillProfileCompletionManager\writeCompletionEntryForAllAssignedUsersOfProfile(), and ILIAS\Skill\Profile\SkillProfileCompletionManager\writeCompletionEntryForRole().

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

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$obj_definition

ilObjectDefinition ILIAS\Skill\Profile\SkillProfileCompletionManager::$obj_definition

protected

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

$profile_completion_repo

SkillProfileCompletionDBRepository ILIAS\Skill\Profile\SkillProfileCompletionManager::$profile_completion_repo

protected

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

Referenced by ILIAS\Skill\Profile\SkillProfileCompletionManager\__construct().

$profile_manager

SkillProfileManager ILIAS\Skill\Profile\SkillProfileCompletionManager::$profile_manager

protected

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

Referenced by ILIAS\Skill\Profile\SkillProfileCompletionManager\__construct().

$tree_service

ilTree ILIAS\Skill\Profile\SkillProfileCompletionManager::$tree_service

protected

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

---

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

• Services/Skill/Profile/class.SkillProfileCompletionManager.php