ILIAS  release_7 Revision v7.30-3-g800a261c036
Static Public Member Functions | Static Private Member Functions
ilStudyProgrammeAppEventListener Class Reference

Event listener for study programs. More...

+ Collaboration diagram for ilStudyProgrammeAppEventListener:

Static Public Member Functions

static handleEvent ($a_component, $a_event, $a_parameter)
 

Static Private Member Functions

static onServiceUserDeleteUser ($a_parameter)
 
static onServiceTrackingUpdateStatus ($a_par)
 
static onServiceTreeInsertNode ($a_parameter)
 
static onServiceTreeMoveTree ($a_parameter)
 
static onServiceObjectDeleteOrToTrash ($a_parameter)
 
static getStudyProgramme ($a_ref_id)
 
static adjustProgrammeLPMode ($a_ref_id)
 
static addMissingProgresses ($a_ref_id)
 
static addCrsToProgrammes (int $crs_ref_id, int $cat_ref_id)
 
static removeCrsFromProgrammes (int $crs_ref_id, int $cat_ref_id)
 
static addMemberToProgrammes (string $src_type, array $params)
 
static removeMemberFromProgrammes (string $src_type, array $params)
 
static sendReAssignedMail (array $params)
 
static sendInformToReAssignMail (array $params)
 
static sendRiskyToFailMail (array $params)
 

Detailed Description

Event listener for study programs.

Has the following tasks:

  • Remove all assignments of a user on all study programms when the user is removed.
  • Add/Remove courses to/trom study programms, if upper category is under surveillance
Author
Richard Klees richa.nosp@m.rd.k.nosp@m.lees@.nosp@m.conc.nosp@m.epts-.nosp@m.and-.nosp@m.train.nosp@m.ing..nosp@m.de

Definition at line 17 of file class.ilStudyProgrammeAppEventListener.php.

Member Function Documentation

◆ addCrsToProgrammes()

static ilStudyProgrammeAppEventListener::addCrsToProgrammes ( int  $crs_ref_id,
int  $cat_ref_id 
)
staticprivate

Definition at line 255 of file class.ilStudyProgrammeAppEventListener.php.

256 {
257 ilObjStudyProgramme::addCrsToProgrammes($crs_ref_id, $cat_ref_id);
258 }
ilObjStudyProgramme\addCrsToProgrammes
static addCrsToProgrammes(int $crs_ref_id, int $cat_ref_id)
Check, if a category is under surveilllance and automatically add the course.
Definition: class.ilObjStudyProgramme.php:1453

References ilObjStudyProgramme\addCrsToProgrammes().

Referenced by onServiceTreeInsertNode(), and onServiceTreeMoveTree().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ addMemberToProgrammes()

static ilStudyProgrammeAppEventListener::addMemberToProgrammes ( string  $src_type,
array  $params 
)
staticprivate

Definition at line 265 of file class.ilStudyProgrammeAppEventListener.php.

266 {
267 $usr_id = $params['usr_id'];
268 $id = $params['obj_id'];
269 if (
270 $src_type === ilStudyProgrammeAutoMembershipSource::TYPE_GROUP ||
271 $src_type === ilStudyProgrammeAutoMembershipSource::TYPE_COURSE
272 ) {
273 $id = array_shift(ilObject::_getAllReferences($id));
274 }
275 if ($src_type === ilStudyProgrammeAutoMembershipSource::TYPE_ROLE) {
276 $id = $params['role_id'];
277 }
278
279 ilObjStudyProgramme::addMemberToProgrammes($src_type, $id, $usr_id);
280 }
ilObjStudyProgramme\addMemberToProgrammes
static addMemberToProgrammes(string $src_type, int $src_id, int $usr_id)
Definition: class.ilObjStudyProgramme.php:1631
ilObject\_getAllReferences
static _getAllReferences($a_id)
get all reference ids of object
Definition: class.ilObject.php:968

References ilObject\_getAllReferences(), ilObjStudyProgramme\addMemberToProgrammes(), ilStudyProgrammeAutoMembershipSource\TYPE_COURSE, ilStudyProgrammeAutoMembershipSource\TYPE_GROUP, and ilStudyProgrammeAutoMembershipSource\TYPE_ROLE.

Referenced by handleEvent().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ addMissingProgresses()

static ilStudyProgrammeAppEventListener::addMissingProgresses (   $a_ref_id)
staticprivate

Definition at line 249 of file class.ilStudyProgrammeAppEventListener.php.

250 {
251 $obj = self::getStudyProgramme($a_ref_id);
252 $obj->addMissingProgresses();
253 }

References getStudyProgramme().

Referenced by onServiceTreeInsertNode().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ adjustProgrammeLPMode()

static ilStudyProgrammeAppEventListener::adjustProgrammeLPMode (   $a_ref_id)
staticprivate

Definition at line 243 of file class.ilStudyProgrammeAppEventListener.php.

244 {
245 $obj = self::getStudyProgramme($a_ref_id);
246 $obj->adjustLPMode();
247 }

References getStudyProgramme().

Referenced by onServiceObjectDeleteOrToTrash(), onServiceTreeInsertNode(), and onServiceTreeMoveTree().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getStudyProgramme()

static ilStudyProgrammeAppEventListener::getStudyProgramme (   $a_ref_id)
staticprivate

Definition at line 237 of file class.ilStudyProgrammeAppEventListener.php.

238 {
239 require_once("Modules/StudyProgramme/classes/class.ilObjStudyProgramme.php");
240 return ilObjStudyProgramme::getInstanceByRefId($a_ref_id);
241 }
ilObjStudyProgramme\getInstanceByRefId
static getInstanceByRefId($a_ref_id)
Definition: class.ilObjStudyProgramme.php:210

References ilObjStudyProgramme\getInstanceByRefId().

Referenced by addMissingProgresses(), and adjustProgrammeLPMode().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ handleEvent()

static ilStudyProgrammeAppEventListener::handleEvent (   $a_component,
  $a_event,
  $a_parameter 
)
static
Exceptions
ilException

Definition at line 23 of file class.ilStudyProgrammeAppEventListener.php.

24 {
25 switch ($a_component) {
26 case "Services/User":
27 switch ($a_event) {
28 case "deleteUser":
29 self::onServiceUserDeleteUser($a_parameter);
30 break;
31 }
32 break;
33 case "Services/Tracking":
34 switch ($a_event) {
35 case "updateStatus":
36 self::onServiceTrackingUpdateStatus($a_parameter);
37 break;
38 }
39 break;
40 case "Services/Tree":
41 switch ($a_event) {
42 case "insertNode":
43 self::onServiceTreeInsertNode($a_parameter);
44 break;
45 case "moveTree":
46 self::onServiceTreeMoveTree($a_parameter);
47 break;
48 }
49 break;
50 case "Services/Object":
51 switch ($a_event) {
52 case "delete":
53 case "toTrash":
54 self::onServiceObjectDeleteOrToTrash($a_parameter);
55 break;
56 }
57 break;
58 case "Services/ContainerReference":
59 switch ($a_event) {
60 case "deleteReference":
61 self::onServiceObjectDeleteOrToTrash($a_parameter);
62 break;
63 }
64 break;
65
66 case "Modules/Course":
67 switch ($a_event) {
68 case "addParticipant":
69 self::addMemberToProgrammes(
70 ilStudyProgrammeAutoMembershipSource::TYPE_COURSE,
71 $a_parameter
72 );
73 break;
74 case "deleteParticipant":
75 self::removeMemberFromProgrammes(
76 ilStudyProgrammeAutoMembershipSource::TYPE_COURSE,
77 $a_parameter
78 );
79 break;
80 }
81 break;
82 case "Modules/Group":
83 switch ($a_event) {
84 case "addParticipant":
85 self::addMemberToProgrammes(
86 ilStudyProgrammeAutoMembershipSource::TYPE_GROUP,
87 $a_parameter
88 );
89 break;
90 case "deleteParticipant":
91 self::removeMemberFromProgrammes(
92 ilStudyProgrammeAutoMembershipSource::TYPE_GROUP,
93 $a_parameter
94 );
95 break;
96 }
97 break;
98 case "Services/AccessControl":
99 switch ($a_event) {
100 case "assignUser":
101 self::addMemberToProgrammes(
102 ilStudyProgrammeAutoMembershipSource::TYPE_ROLE,
103 $a_parameter
104 );
105 break;
106 case "deassignUser":
107 self::removeMemberFromProgrammes(
108 ilStudyProgrammeAutoMembershipSource::TYPE_ROLE,
109 $a_parameter
110 );
111 break;
112 }
113 break;
114 case "Modules/OrgUnit":
115 switch ($a_event) {
116 case "assignUserToPosition":
117 self::addMemberToProgrammes(
118 ilStudyProgrammeAutoMembershipSource::TYPE_ORGU,
119 $a_parameter
120 );
121 break;
122 case "deassignUserFromPosition":
123 //case "delete":
124 self::removeMemberFromProgrammes(
125 ilStudyProgrammeAutoMembershipSource::TYPE_ORGU,
126 $a_parameter
127 );
128 break;
129 }
130 break;
131 case "Modules/StudyProgramme":
132 switch ($a_event) {
133 case "userReAssigned":
134 self::sendReAssignedMail($a_parameter);
135 break;
136 case 'informUserToRestart':
137 self::sendInformToReAssignMail($a_parameter);
138 break;
139 case 'userRiskyToFail':
140 self::sendRiskyToFailMail($a_parameter);
141 }
142 break;#
143 default:
144 throw new ilException("ilStudyProgrammeAppEventListener::handleEvent: "
145 . "Won't handle events of '$a_component'.");
146 }
147 }
ilException
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
Definition: class.ilException.php:28
ilStudyProgrammeAppEventListener\removeMemberFromProgrammes
static removeMemberFromProgrammes(string $src_type, array $params)
Definition: class.ilStudyProgrammeAppEventListener.php:282
ilStudyProgrammeAppEventListener\addMemberToProgrammes
static addMemberToProgrammes(string $src_type, array $params)
Definition: class.ilStudyProgrammeAppEventListener.php:265

References addMemberToProgrammes(), onServiceObjectDeleteOrToTrash(), onServiceTrackingUpdateStatus(), onServiceTreeInsertNode(), onServiceTreeMoveTree(), onServiceUserDeleteUser(), removeMemberFromProgrammes(), sendInformToReAssignMail(), sendReAssignedMail(), sendRiskyToFailMail(), ilStudyProgrammeAutoMembershipSource\TYPE_COURSE, ilStudyProgrammeAutoMembershipSource\TYPE_GROUP, ilStudyProgrammeAutoMembershipSource\TYPE_ORGU, and ilStudyProgrammeAutoMembershipSource\TYPE_ROLE.

+ Here is the call graph for this function:

◆ onServiceObjectDeleteOrToTrash()

static ilStudyProgrammeAppEventListener::onServiceObjectDeleteOrToTrash (   $a_parameter)
staticprivate

Definition at line 222 of file class.ilStudyProgrammeAppEventListener.php.

223 {
224 $node_ref_id = $a_parameter["ref_id"];
225 $old_parent_ref_id = $a_parameter["old_parent_ref_id"];
226
227 $node_type = $a_parameter["type"];
228 $old_parent_type = ilObject::_lookupType($old_parent_ref_id, true);
229
230 if ($old_parent_type !== "prg") {
231 return;
232 }
233
234 self::adjustProgrammeLPMode($old_parent_ref_id);
235 }
ilObject\_lookupType
static _lookupType($a_id, $a_reference=false)
lookup object type
Definition: class.ilObject.php:1281

References ilObject\_lookupType(), and adjustProgrammeLPMode().

Referenced by handleEvent().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ onServiceTrackingUpdateStatus()

static ilStudyProgrammeAppEventListener::onServiceTrackingUpdateStatus (   $a_par)
staticprivate

Definition at line 158 of file class.ilStudyProgrammeAppEventListener.php.

159 {
160 require_once("./Services/Tracking/classes/class.ilLPStatus.php");
161 if ($a_par["status"] != ilLPStatus::LP_STATUS_COMPLETED_NUM) {
162 return;
163 }
164
165 require_once("./Modules/StudyProgramme/classes/class.ilObjStudyProgramme.php");
166 ilObjStudyProgramme::setProgressesCompletedFor((int) $a_par["obj_id"], (int) $a_par["usr_id"]);
167 }
ilLPStatus\LP_STATUS_COMPLETED_NUM
const LP_STATUS_COMPLETED_NUM
Definition: class.ilLPStatus.php:30
ilObjStudyProgramme\setProgressesCompletedFor
static setProgressesCompletedFor(int $a_obj_id, int $a_user_id)
Set all progresses to completed where the object with given id is a leaf and that belong to the user.
Definition: class.ilObjStudyProgramme.php:1745

References ilLPStatus\LP_STATUS_COMPLETED_NUM, and ilObjStudyProgramme\setProgressesCompletedFor().

Referenced by handleEvent().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ onServiceTreeInsertNode()

static ilStudyProgrammeAppEventListener::onServiceTreeInsertNode (   $a_parameter)
staticprivate

Definition at line 169 of file class.ilStudyProgrammeAppEventListener.php.

170 {
171 $node_ref_id = $a_parameter["node_id"];
172 $parent_ref_id = $a_parameter["parent_id"];
173
174 $node_type = ilObject::_lookupType($node_ref_id, true);
175 $parent_type = ilObject::_lookupType($parent_ref_id, true);
176
177 if ($node_type == "crsr" && $parent_type == "prg") {
178 self::adjustProgrammeLPMode($parent_ref_id);
179 }
180 if (in_array($node_type, ["prg", "prgr"]) && $parent_type == "prg") {
181 self::addMissingProgresses($parent_ref_id);
182 }
183 if ($node_type == "crs" && $parent_type == "cat") {
184 self::addCrsToProgrammes($node_ref_id, $parent_ref_id);
185 }
186 }
ilStudyProgrammeAppEventListener\addCrsToProgrammes
static addCrsToProgrammes(int $crs_ref_id, int $cat_ref_id)
Definition: class.ilStudyProgrammeAppEventListener.php:255

References ilObject\_lookupType(), addCrsToProgrammes(), addMissingProgresses(), and adjustProgrammeLPMode().

Referenced by handleEvent().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ onServiceTreeMoveTree()

static ilStudyProgrammeAppEventListener::onServiceTreeMoveTree (   $a_parameter)
staticprivate

Definition at line 188 of file class.ilStudyProgrammeAppEventListener.php.

189 {
190 $node_ref_id = $a_parameter["source_id"];
191 $new_parent_ref_id = $a_parameter["target_id"];
192 $old_parent_ref_id = $a_parameter["old_parent_id"];
193
194 $node_type = ilObject::_lookupType($node_ref_id, true);
195 $new_parent_type = ilObject::_lookupType($new_parent_ref_id, true);
196 $old_parent_type = ilObject::_lookupType($old_parent_ref_id, true);
197
198 if (!in_array($node_type, ["crsr","crs"])
199 || (
200 ($new_parent_type != "prg" && $old_parent_type != "prg")
201 &&
202 $old_parent_type != "cat"
203 )
204 ) {
205 return;
206 }
207
208 if ($node_type === 'crs') {
209 self::removeCrsFromProgrammes($node_ref_id, $old_parent_ref_id);
210 if ($new_parent_type === 'cat') {
211 self::addCrsToProgrammes($node_ref_id, $new_parent_ref_id);
212 }
213 }
214
215 if ($new_parent_type == "prg") {
216 self::adjustProgrammeLPMode($new_parent_ref_id);
217 } elseif ($old_parent_type == "prg") {
218 self::adjustProgrammeLPMode($old_parent_ref_id);
219 }
220 }
ilStudyProgrammeAppEventListener\removeCrsFromProgrammes
static removeCrsFromProgrammes(int $crs_ref_id, int $cat_ref_id)
Definition: class.ilStudyProgrammeAppEventListener.php:260

References ilObject\_lookupType(), addCrsToProgrammes(), adjustProgrammeLPMode(), and removeCrsFromProgrammes().

Referenced by handleEvent().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ onServiceUserDeleteUser()

static ilStudyProgrammeAppEventListener::onServiceUserDeleteUser (   $a_parameter)
staticprivate

Definition at line 149 of file class.ilStudyProgrammeAppEventListener.php.

150 {
151 $assignments = ilStudyProgrammeDIC::dic()['ilStudyProgrammeUserAssignmentDB']->getInstancesOfUser((int) $a_parameter["usr_id"]);
152 foreach ($assignments as $ass) {
153 $prg = ilObjStudyProgramme::getInstanceByObjId($ass->getRootId());
154 $prg->removeAssignment($ass);
155 }
156 }

References ilStudyProgrammeDIC\dic(), and ilObjStudyProgramme\getInstanceByObjId().

Referenced by handleEvent().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ removeCrsFromProgrammes()

static ilStudyProgrammeAppEventListener::removeCrsFromProgrammes ( int  $crs_ref_id,
int  $cat_ref_id 
)
staticprivate

Definition at line 260 of file class.ilStudyProgrammeAppEventListener.php.

261 {
262 ilObjStudyProgramme::removeCrsFromProgrammes($crs_ref_id, $cat_ref_id);
263 }
ilObjStudyProgramme\removeCrsFromProgrammes
static removeCrsFromProgrammes(int $crs_ref_id, int $cat_ref_id)
Check, if a category is under surveilllance and automatically remove the deleted course.
Definition: class.ilObjStudyProgramme.php:1477

References ilObjStudyProgramme\removeCrsFromProgrammes().

Referenced by onServiceTreeMoveTree().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ removeMemberFromProgrammes()

static ilStudyProgrammeAppEventListener::removeMemberFromProgrammes ( string  $src_type,
array  $params 
)
staticprivate

Definition at line 282 of file class.ilStudyProgrammeAppEventListener.php.

283 {
284 $usr_id = $params['usr_id'];
285 $id = $params['obj_id'];
286 if (
287 $src_type === ilStudyProgrammeAutoMembershipSource::TYPE_GROUP ||
288 $src_type === ilStudyProgrammeAutoMembershipSource::TYPE_COURSE
289 ) {
290 $id = array_shift(ilObject::_getAllReferences($id));
291 }
292 if ($src_type === ilStudyProgrammeAutoMembershipSource::TYPE_ROLE) {
293 $id = $params['role_id'];
294 }
295
296 ilObjStudyProgramme::removeMemberFromProgrammes($src_type, $id, $usr_id);
297 }
ilObjStudyProgramme\removeMemberFromProgrammes
static removeMemberFromProgrammes(string $src_type, int $src_id, int $usr_id)
Definition: class.ilObjStudyProgramme.php:1642

References ilObject\_getAllReferences(), ilObjStudyProgramme\removeMemberFromProgrammes(), ilStudyProgrammeAutoMembershipSource\TYPE_COURSE, ilStudyProgrammeAutoMembershipSource\TYPE_GROUP, and ilStudyProgrammeAutoMembershipSource\TYPE_ROLE.

Referenced by handleEvent().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ sendInformToReAssignMail()

static ilStudyProgrammeAppEventListener::sendInformToReAssignMail ( array  $params)
staticprivate

Definition at line 306 of file class.ilStudyProgrammeAppEventListener.php.

306 : void
307 {
308 $usr_id = $params['usr_id'];
309 $progress_id = $params['progress_id'];
310 ilObjStudyProgramme::sendInformToReAssignMail($progress_id, $usr_id);
311 }
ilObjStudyProgramme\sendInformToReAssignMail
static sendInformToReAssignMail(int $progress_id, int $usr_id)
Definition: class.ilObjStudyProgramme.php:1960

References ilObjStudyProgramme\sendInformToReAssignMail().

Referenced by handleEvent().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ sendReAssignedMail()

static ilStudyProgrammeAppEventListener::sendReAssignedMail ( array  $params)
staticprivate

Definition at line 299 of file class.ilStudyProgrammeAppEventListener.php.

299 : void
300 {
301 $usr_id = $params['usr_id'];
302 $ref_id = $params['root_prg_ref_id'];
303 ilObjStudyProgramme::sendReAssignedMail($ref_id, $usr_id);
304 }
ilObjStudyProgramme\sendReAssignedMail
static sendReAssignedMail(int $ref_id, int $usr_id)
Definition: class.ilObjStudyProgramme.php:1880

References ilObjStudyProgramme\sendReAssignedMail().

Referenced by handleEvent().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ sendRiskyToFailMail()

static ilStudyProgrammeAppEventListener::sendRiskyToFailMail ( array  $params)
staticprivate
Exceptions
ilException

Definition at line 316 of file class.ilStudyProgrammeAppEventListener.php.

316 : void
317 {
318 $usr_id = $params['usr_id'];
319 $progress_id = $params['progress_id'];
320 ilObjStudyProgramme::sendRiskyToFailMail($progress_id, $usr_id);
321 }
ilObjStudyProgramme\sendRiskyToFailMail
static sendRiskyToFailMail(int $progress_id, int $usr_id)
Definition: class.ilObjStudyProgramme.php:2012

References ilObjStudyProgramme\sendRiskyToFailMail().

Referenced by handleEvent().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:
The documentation for this class was generated from the following file: