PRGEventsDelayed Class Reference

Inheritance diagram for PRGEventsDelayed:

Collaboration diagram for PRGEventsDelayed:

Public Member Functions
	__construct (ilStudyProgrammeEvents $prg_events)
	collect (string $event, array $parameter)
	raiseCollected ()
	userAssigned (ilPRGAssignment $assignment)
	userReAssigned (ilPRGAssignment $assignment)
	userDeassigned (ilPRGAssignment $a_assignment)
	informUserByMailToRestart (ilPRGAssignment $assignment)
	userRiskyToFail (ilPRGAssignment $assignment)
	userSuccessful (ilPRGAssignment $assignment, int $pgs_node_id)
	validityChange (ilPRGAssignment $assignment, int $pgs_node_id)
	deadlineChange (ilPRGAssignment $assignment, int $pgs_node_id)
	scoreChange (ilPRGAssignment $assignment, int $pgs_node_id)
	userRevertSuccessful (ilPRGAssignment $assignment, int $pgs_node_id)

Protected Attributes
array	$events = []
ilStudyProgrammeEvents	$prg_events

Additional Inherited Members
Data Fields inherited from StudyProgrammeEvents
const	COMPONENT = "Modules/StudyProgramme"
const	EVENT_USER_ASSIGNED = 'userAssigned'
const	EVENT_USER_REASSIGNED = 'userReAssigned'
const	EVENT_USER_DEASSIGNED = 'userDeassigned'
const	EVENT_USER_SUCCESSFUL = 'userSuccessful'
const	EVENT_USER_TO_RESTART = 'informUserToRestart'
const	EVENT_USER_ABOUT_TO_FAIL = 'userRiskyToFail'
const	EVENT_VALIDITY_CHANGE = 'vqChange'
const	EVENT_DEADLINE_CHANGE = 'deadlineChange'
const	EVENT_SCORE_CHANGE = 'currentPointsChange'
const	EVENT_USER_NOT_SUCCESSFUL = 'userNotSuccessful'

Detailed Description

Definition at line 20 of file class.PRGEventsDelayed.php.

Constructor & Destructor Documentation

__construct()

PRGEventsDelayed::__construct

(

ilStudyProgrammeEvents

$prg_events

)

Definition at line 25 of file class.PRGEventsDelayed.php.

References $prg_events.

      {
        $this->prg_events = $prg_events;
    }

Member Function Documentation

collect()

PRGEventsDelayed::collect	(	string	$event,
		array	$parameter
	)

Definition at line 31 of file class.PRGEventsDelayed.php.

Referenced by deadlineChange(), informUserByMailToRestart(), scoreChange(), userAssigned(), userDeassigned(), userReAssigned(), userRevertSuccessful(), userRiskyToFail(), userSuccessful(), and validityChange().

                                                            : void
    {
        $this->events[] = [$event, $parameter];
    }

Here is the caller graph for this function:

deadlineChange()

PRGEventsDelayed::deadlineChange	(	ilPRGAssignment	$assignment,
		int	$pgs_node_id
	)

Implements StudyProgrammeEvents.

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

References collect(), ilPRGAssignment\getId(), ilPRGAssignment\getRootId(), and ilPRGAssignment\getUserId().

                                                                                 : void
    {
        $this->collect(self::EVENT_DEADLINE_CHANGE, [
            "ass_id" => $assignment->getId(),
            "root_prg_id" => $assignment->getRootId(),
            "prg_id" => $pgs_node_id,
            "usr_id" => $assignment->getUserId()
        ]);
    }

Here is the call graph for this function:

informUserByMailToRestart()

PRGEventsDelayed::informUserByMailToRestart

(

ilPRGAssignment

$assignment

)

Implements StudyProgrammeEvents.

Definition at line 77 of file class.PRGEventsDelayed.php.

References collect(), ilPRGAssignment\getId(), ilPRGAssignment\getRootId(), and ILIAS\Repository\int().

                                                                          : void
    {
        $this->collect(self::EVENT_USER_TO_RESTART, [
            "ass_id" => (int) $assignment->getId(),
            "root_prg_id" => (int) $assignment->getRootId()
        ]);
    }

Here is the call graph for this function:

raiseCollected()

PRGEventsDelayed::raiseCollected

(

)

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

                                    : void
    {
        $accounted_for = [];
        foreach (array_filter($this->events) as $entry) {
            list($event, $parameter) = $entry;
            $k = $event . print_r($parameter, true);
            if (!array_key_exists($k, $accounted_for)) {
                $accounted_for[$k] = true;
                $this->prg_events->raise($event, $parameter);
            }
        }
        $this->events[] = [];
    }

scoreChange()

PRGEventsDelayed::scoreChange	(	ilPRGAssignment	$assignment,
		int	$pgs_node_id
	)

Implements StudyProgrammeEvents.

Definition at line 123 of file class.PRGEventsDelayed.php.

References collect(), ilPRGAssignment\getId(), ilPRGAssignment\getRootId(), and ilPRGAssignment\getUserId().

                                                                              : void
    {
        $this->collect(self::EVENT_SCORE_CHANGE, [
            "ass_id" => $assignment->getId(),
            "root_prg_id" => $assignment->getRootId(),
            "prg_id" => $pgs_node_id,
            "usr_id" => $assignment->getUserId()
        ]);
    }

Here is the call graph for this function:

userAssigned()

PRGEventsDelayed::userAssigned

(

ilPRGAssignment

$assignment

)

Implements StudyProgrammeEvents.

Definition at line 50 of file class.PRGEventsDelayed.php.

References collect(), ilPRGAssignment\getId(), ilPRGAssignment\getRootId(), and ilPRGAssignment\getUserId().

                                                             : void
    {
        $this->collect(self::EVENT_USER_ASSIGNED, [
            "root_prg_id" => $assignment->getRootId(),
            "usr_id" => $assignment->getUserId(),
            "ass_id" => $assignment->getId()
        ]);
    }

Here is the call graph for this function:

userDeassigned()

PRGEventsDelayed::userDeassigned

(

ilPRGAssignment

$a_assignment

)

Implements StudyProgrammeEvents.

Definition at line 67 of file class.PRGEventsDelayed.php.

References collect(), ilPRGAssignment\getId(), ilPRGAssignment\getRootId(), and ilPRGAssignment\getUserId().

                                                                 : void
    {
        $this->collect(self::EVENT_USER_DEASSIGNED, [
            "root_prg_id" => $a_assignment->getRootId(),
            "usr_id" => $a_assignment->getUserId(),
            "ass_id" => $a_assignment->getId()
        ]);
    }

Here is the call graph for this function:

userReAssigned()

PRGEventsDelayed::userReAssigned

(

ilPRGAssignment

$assignment

)

Implements StudyProgrammeEvents.

Definition at line 59 of file class.PRGEventsDelayed.php.

References collect(), ilPRGAssignment\getId(), ilPRGAssignment\getRootId(), and ILIAS\Repository\int().

                                                               : void
    {
        $this->collect(self::EVENT_USER_REASSIGNED, [
            "ass_id" => $assignment->getId(),
            "root_prg_id" => (int) $assignment->getRootId()
        ]);
    }

Here is the call graph for this function:

userRevertSuccessful()

PRGEventsDelayed::userRevertSuccessful	(	ilPRGAssignment	$assignment,
		int	$pgs_node_id
	)

Implements StudyProgrammeEvents.

Definition at line 133 of file class.PRGEventsDelayed.php.

References collect(), ilPRGAssignment\getId(), ilPRGAssignment\getRootId(), and ilPRGAssignment\getUserId().

                                                                                       : void
    {
        $this->collect(self::EVENT_USER_NOT_SUCCESSFUL, [
            "ass_id" => $assignment->getId(),
            "root_prg_id" => $assignment->getRootId(),
            "prg_id" => $pgs_node_id,
            "usr_id" => $assignment->getUserId()
        ]);
    }

Here is the call graph for this function:

userRiskyToFail()

PRGEventsDelayed::userRiskyToFail

(

ilPRGAssignment

$assignment

)

Implements StudyProgrammeEvents.

Definition at line 85 of file class.PRGEventsDelayed.php.

References collect(), ilPRGAssignment\getId(), ilPRGAssignment\getRootId(), and ILIAS\Repository\int().

                                                                : void
    {
        $this->collect(self::EVENT_USER_ABOUT_TO_FAIL, [
            "ass_id" => (int) $assignment->getId(),
            "root_prg_id" => (int) $assignment->getRootId()
        ]);
    }

Here is the call graph for this function:

userSuccessful()

PRGEventsDelayed::userSuccessful	(	ilPRGAssignment	$assignment,
		int	$pgs_node_id
	)

Implements StudyProgrammeEvents.

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

References collect(), ilPRGAssignment\getId(), ilPRGAssignment\getRootId(), and ilPRGAssignment\getUserId().

                                                                                 : void
    {
        $this->collect(self::EVENT_USER_SUCCESSFUL, [
            "root_prg_id" => $assignment->getRootId(),
            "prg_id" => $pgs_node_id,
            "usr_id" => $assignment->getUserId(),
            "ass_id" => $assignment->getId()
        ]);
    }

Here is the call graph for this function:

validityChange()

PRGEventsDelayed::validityChange	(	ilPRGAssignment	$assignment,
		int	$pgs_node_id
	)

Implements StudyProgrammeEvents.

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

References collect(), ilPRGAssignment\getId(), ilPRGAssignment\getRootId(), and ilPRGAssignment\getUserId().

                                                                                 : void
    {
        $this->collect(self::EVENT_VALIDITY_CHANGE, [
            "ass_id" => $assignment->getId(),
            "root_prg_id" => $assignment->getRootId(),
            "prg_id" => $pgs_node_id,
            "usr_id" => $assignment->getUserId()
        ]);
    }

Here is the call graph for this function:

Field Documentation

$events

array PRGEventsDelayed::$events = []

protected

Definition at line 22 of file class.PRGEventsDelayed.php.

$prg_events

ilStudyProgrammeEvents PRGEventsDelayed::$prg_events

protected

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

Referenced by __construct().

---

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

• Modules/StudyProgramme/classes/Events/class.PRGEventsDelayed.php