ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
ilStudyProgrammeEvents Class Reference

Events for the StudyProgramme. More...

+ Collaboration diagram for ilStudyProgrammeEvents:

Static Public Member Functions

static userAssigned (ilStudyProgrammeUserAssignment $a_assignment)
 
static userDeassigned (ilStudyProgrammeUserAssignment $a_assignment)
 
static userSuccessful (ilStudyProgrammeUserProgress $a_progress)
 

Static Public Attributes

static $app_event_handler = null
 

Static Protected Member Functions

static initAppEventHandler ()
 
static raise ($a_event, $a_parameter)
 

Static Protected Attributes

static $component = "Modules/StudyProgramme"
 

Detailed Description

Member Function Documentation

◆ initAppEventHandler()

static ilStudyProgrammeEvents::initAppEventHandler ( )
staticprotected

Definition at line 14 of file class.ilStudyProgrammeEvents.php.

14 {
15 if (self::$app_event_handler === null) {
16 global $ilAppEventHandler;
17 self::$app_event_handler = $ilAppEventHandler;
18 }
19 }

Referenced by raise().

+ Here is the caller graph for this function:

◆ raise()

static ilStudyProgrammeEvents::raise (   $a_event,
  $a_parameter 
)
staticprotected

Definition at line 21 of file class.ilStudyProgrammeEvents.php.

21 {
23 self::$app_event_handler->raise(self::$component, $a_event, $a_parameter);
24 }

References initAppEventHandler().

Referenced by userAssigned(), userDeassigned(), and userSuccessful().

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

◆ userAssigned()

static ilStudyProgrammeEvents::userAssigned ( ilStudyProgrammeUserAssignment  $a_assignment)
static

Definition at line 26 of file class.ilStudyProgrammeEvents.php.

26 {
27 self::raise("userAssigned", array
28 ( "root_prg_id" => $a_assignment->getStudyProgramme()->getId()
29 , "usr_id" => $a_assignment->getUserId()
30 , "ass_id" => $a_assignment->getId()
31 ));
32 }
static raise($a_event, $a_parameter)
getStudyProgramme()
Get the program node where this assignment was made.
getUserId()
Get the id of the user who is assigned.

References ilStudyProgrammeUserAssignment\getId(), ilStudyProgrammeUserAssignment\getStudyProgramme(), ilStudyProgrammeUserAssignment\getUserId(), and raise().

Referenced by ilObjStudyProgramme\assignUser().

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

◆ userDeassigned()

static ilStudyProgrammeEvents::userDeassigned ( ilStudyProgrammeUserAssignment  $a_assignment)
static

Definition at line 34 of file class.ilStudyProgrammeEvents.php.

34 {
35 self::raise("userDeassigned", array
36 ( "root_prg_id" => $a_assignment->getStudyProgramme()->getId()
37 , "usr_id" => $a_assignment->getUserId()
38 , "ass_id" => $a_assignment->getId()
39 ));
40 }

References ilStudyProgrammeUserAssignment\getId(), ilStudyProgrammeUserAssignment\getStudyProgramme(), ilStudyProgrammeUserAssignment\getUserId(), and raise().

Referenced by ilObjStudyProgramme\removeAssignment().

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

◆ userSuccessful()

static ilStudyProgrammeEvents::userSuccessful ( ilStudyProgrammeUserProgress  $a_progress)
static

Definition at line 42 of file class.ilStudyProgrammeEvents.php.

42 {
43 $ass = $a_progress->getAssignment();
44 self::raise("userSuccessful", array
45 ( "root_prg_id" => $ass->getStudyProgramme()->getId()
46 , "prg_id" => $a_progress->getStudyProgramme()->getId()
47 , "usr_id" => $ass->getUserId()
48 , "ass_id" => $ass->getId()
49 ));
50 }
getAssignment()
Get the assignment this progress belongs to.
getStudyProgramme()
Get the program node where this progress belongs to was made.

References ilStudyProgrammeUserProgress\getAssignment(), ilStudyProgrammeUserProgress\getStudyProgramme(), and raise().

Referenced by ilStudyProgrammeUserProgress\markAccredited(), ilStudyProgrammeUserProgress\setLPCompleted(), and ilStudyProgrammeUserProgress\updateStatus().

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

Field Documentation

◆ $app_event_handler

ilStudyProgrammeEvents::$app_event_handler = null
static

Definition at line 12 of file class.ilStudyProgrammeEvents.php.

Referenced by ilStudyProgrammeEventsTest\setUp().

◆ $component

ilStudyProgrammeEvents::$component = "Modules/StudyProgramme"
staticprotected

Definition at line 11 of file class.ilStudyProgrammeEvents.php.


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