ILIAS  release_10 Revision v10.1-43-ga1241a92c2f
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, string $trigger_user="")
 
 getLastLevelPerObjectAndTriggerUser (int $user_id, array $skills, int $obj_id, string $trigger_user)
 This does not include any container logic currently only used for survey, individual assessment. More...
 
 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.

44  {
45  global $DIC;
46 
47  $this->profile_manager = $profile_manager;
48  $this->profile_completion_repo = ($profile_completion_repo)
49  ?: $DIC->skills()->internal()->repo()->getProfileCompletionRepo();
50  $this->tree_service = $DIC->repositoryTree();
51  $this->obj_definition = $DIC["objDefinition"];
52  }
global $DIC
Definition: shib_login.php:25

Member Function Documentation

◆ deleteEntriesForProfile()

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

Delete all profile completion entries for a profile.

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

307  : void
308  {
309  $this->profile_completion_repo->deleteEntriesForProfile($profile_id);
310  }

◆ deleteEntriesForUser()

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

Delete all profile completion entries for a user.

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

315  : void
316  {
317  $this->profile_completion_repo->deleteEntriesForUser($user_id);
318  }

◆ 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 125 of file class.SkillProfileCompletionManager.php.

131  : array {
132  // todo for coming feature
133  return [];
134  }

◆ getActualMaxLevels()

ILIAS\Skill\Profile\SkillProfileCompletionManager::getActualMaxLevels ( int  $user_id,
array  $skills,
string  $gap_mode = "",
string  $gap_mode_type = "",
int  $gap_mode_obj_id = 0,
string  $trigger_user = "" 
)
Parameters
GapAnalysisSkill[]$skills
Returns
array<int, array<int, int>>

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

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

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

65  : array {
66  // get actual levels for gap analysis
67  $actual_levels = [];
68  foreach ($skills as $sk) {
69  $bs = new \ilBasicSkill($sk->getBaseSkillId());
70  if ($gap_mode == "max_per_type") {
71  $max = $bs->getMaxLevelPerType($sk->getTrefId(), $gap_mode_type, $user_id);
72  } elseif ($gap_mode == "max_per_object") {
73  if ($this->obj_definition->isContainer(\ilObject::_lookupType($gap_mode_obj_id))) {
74  $sub_objects = $this->tree_service->getSubTree(
75  $this->tree_service->getNodeData((int) current(\ilObject::_getAllReferences($gap_mode_obj_id))),
76  false,
78  );
79  $max = 0;
80  foreach ($sub_objects as $ref_id) {
81  $obj_id = \ilContainerReference::_lookupObjectId($ref_id);
82  $max_tmp = $bs->getMaxLevelPerObject($sk->getTrefId(), $obj_id, $user_id, 0, $trigger_user);
83  if ($max_tmp > $max) {
84  $max = $max_tmp;
85  }
86  }
87  } else {
88  $max = $bs->getMaxLevelPerObject($sk->getTrefId(), $gap_mode_obj_id, $user_id, 0, $trigger_user);
89  }
90  } else {
91  $max = $bs->getMaxLevel($sk->getTrefId(), $user_id);
92  }
93  $actual_levels[$sk->getBaseSkillId()][$sk->getTrefId()] = $max;
94  }
95 
96  return $actual_levels;
97  }
static getSupportedObjectTypes()
static _getAllReferences(int $id)
get all reference ids for object ID
$ref_id
Definition: ltiauth.php:66
static _lookupObjectId(int $ref_id)
static _lookupType(int $id, bool $reference=false)
+ 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 140 of file class.SkillProfileCompletionManager.php.

References $user_id.

146  : array {
147  // get actual next level fulfilments for gap analysis
148  $fuls = [];
149  foreach ($skills as $sk) {
150  $bs = new \ilBasicSkill($sk->getBaseSkillId());
151  if ($gap_mode == "max_per_type") {
152  $perc = $bs->getNextLevelFulfilmentPerType($sk->getTrefId(), $gap_mode_type, $user_id);
153  } elseif ($gap_mode == "max_per_object") {
154  $perc = $bs->getNextLevelFulfilmentPerObject($sk->getTrefId(), $gap_mode_obj_id, $user_id);
155  } else {
156  $perc = $bs->getNextLevelFulfilment($sk->getTrefId(), $user_id);
157  }
158  $fuls[$sk->getBaseSkillId()][$sk->getTrefId()] = $perc;
159  }
160 
161  return $fuls;
162  }

◆ getAllEntriesForProfile()

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

Get all completion entries for a single profile.

Returns
SkillProfileCompletion[]

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

250  : array
251  {
252  return $this->profile_completion_repo->getAllEntriesForProfile($profile_id);
253  }

◆ getAllEntriesForUser()

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

Get all profile completion entries for a user.

Returns
SkillProfileCompletion[]

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

241  : array
242  {
243  return $this->profile_completion_repo->getAllEntriesForUser($user_id);
244  }

◆ 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 204 of file class.SkillProfileCompletionManager.php.

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

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

204  : array
205  {
206  $user_profiles = $this->profile_manager->getProfilesOfUser($user_id);
207  $profile_comps = [];
208  foreach ($user_profiles as $p) {
209  if ($this->isProfileFulfilled($user_id, $p->getId())) {
210  $profile_comps[$p->getId()] = true;
211  } else {
212  $profile_comps[$p->getId()] = false;
213  }
214  }
215 
216  return $profile_comps;
217  }
isProfileFulfilled(int $user_id, int $profile_id)
Check if a profile is fulfilled (progress = 100%)
+ 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 223 of file class.SkillProfileCompletionManager.php.

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

◆ getFulfilledEntriesForUser()

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

Get all fulfilled profile completion entries for a user.

Returns
SkillProfileCompletion[]

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

232  : array
233  {
234  return $this->profile_completion_repo->getFulfilledEntriesForUser($user_id);
235  }

◆ getLastLevelPerObjectAndTriggerUser()

ILIAS\Skill\Profile\SkillProfileCompletionManager::getLastLevelPerObjectAndTriggerUser ( int  $user_id,
array  $skills,
int  $obj_id,
string  $trigger_user 
)

This does not include any container logic currently only used for survey, individual assessment.

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

References $user_id.

108  : array {
109  // get actual levels for gap analysis
110  $last_levels = [];
111  foreach ($skills as $sk) {
112  $bs = new \ilBasicSkill($sk->getBaseSkillId());
113  $last = $bs->getLastLevelEntryOfUser(
114  $sk->getTrefId(),
115  $user_id,
116  $obj_id,
117  0,
118  $trigger_user
119  );
120  $last_levels[$sk->getBaseSkillId()][$sk->getTrefId()] = $last;
121  }
122  return $last_levels;
123  }

◆ getProfileProgress()

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

Get progress in percent for a profile.

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

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

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

167  : int
168  {
169  $profile_levels = $this->profile_manager->getSkillLevels($profile_id);
170  $actual_levels = $this->getActualMaxLevels($user_id, $profile_levels);
171 
172  $profile_count = 0;
173  $achieved_count = 0;
174  foreach ($profile_levels as $level) {
175  if (isset($actual_levels[$level->getBaseSkillId()][$level->getTrefId()]) &&
176  $actual_levels[$level->getBaseSkillId()][$level->getTrefId()] >= $level->getLevelId()) {
177  $achieved_count++;
178  }
179  $profile_count++;
180  }
181  if ($profile_count == 0) {
182  return 0;
183  }
184  $progress = $achieved_count / $profile_count * 100;
185 
186  return (int) $progress;
187  }
getActualMaxLevels(int $user_id, array $skills, string $gap_mode="", string $gap_mode_type="", int $gap_mode_obj_id=0, string $trigger_user="")
+ 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 192 of file class.SkillProfileCompletionManager.php.

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

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

192  : bool
193  {
194  if ($this->getProfileProgress($user_id, $profile_id) == 100) {
195  return true;
196  }
197  return false;
198  }
getProfileProgress(int $user_id, int $profile_id)
Get progress in percent for a profile.
+ 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 285 of file class.SkillProfileCompletionManager.php.

References $user_id, and ILIAS\Skill\Profile\SkillProfileCompletionManager\writeCompletionEntryForSingleProfileOfUser().

285  : void
286  {
287  $users = $this->profile_manager->getAssignedUserIdsIncludingRoleAssignments($profile_id);
288  foreach ($users as $user_id) {
289  $this->writeCompletionEntryForSingleProfileOfUser($user_id, $profile_id);
290  }
291  }
writeCompletionEntryForSingleProfileOfUser(int $user_id, int $profile_id)
Write profile completion entry (fulfilled or non-fulfilled) of user for given profile.
+ 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 258 of file class.SkillProfileCompletionManager.php.

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

258  : void
259  {
260  $completions = $this->getAllProfileCompletionsForUser($user_id);
261  foreach ($completions as $profile_id => $fulfilled) {
262  if ($fulfilled) {
263  $this->profile_completion_repo->addFulfilmentEntry($user_id, $profile_id);
264  } else {
265  $this->profile_completion_repo->addNonFulfilmentEntry($user_id, $profile_id);
266  }
267  }
268  }
getAllProfileCompletionsForUser(int $user_id)
Get all profiles of user which are fulfilled or non-fulfilled.
+ 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 296 of file class.SkillProfileCompletionManager.php.

References $user_id, and ILIAS\Skill\Profile\SkillProfileCompletionManager\writeCompletionEntryForSingleProfileOfUser().

296  : void
297  {
298  $r_users = $this->profile_manager->getAssignedUsersForRole($role_id);
299  foreach ($r_users as $user_id) {
300  $this->writeCompletionEntryForSingleProfileOfUser($user_id, $profile_id);
301  }
302  }
writeCompletionEntryForSingleProfileOfUser(int $user_id, int $profile_id)
Write profile completion entry (fulfilled or non-fulfilled) of user for given profile.
+ 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 273 of file class.SkillProfileCompletionManager.php.

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

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

273  : void
274  {
275  if ($this->isProfileFulfilled($user_id, $profile_id)) {
276  $this->profile_completion_repo->addFulfilmentEntry($user_id, $profile_id);
277  } else {
278  $this->profile_completion_repo->addNonFulfilmentEntry($user_id, $profile_id);
279  }
280  }
isProfileFulfilled(int $user_id, int $profile_id)
Check if a profile is fulfilled (progress = 100%)
+ 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

◆ $profile_manager

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

◆ $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: