Inheritance diagram for ilStudyProgrammeEvents:

Collaboration diagram for ilStudyProgrammeEvents:

Public Member Functions
	__construct (protected ilLogger $logger, protected ilAppEventHandler $app_event_handler, protected PRGEventHandler $prg_event_handler)

	raise (string $event, array $parameter)

	userAssigned (ilPRGAssignment $assignment)

	userDeassigned (ilPRGAssignment $a_assignment)

	userReAssigned (ilPRGAssignment $assignment)

	userSuccessful (ilPRGAssignment $assignment, int $pgs_node_id)

	informUserByMailToRestart (ilPRGAssignment $assignment)

	userRiskyToFail (ilPRGAssignment $assignment)

	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)

	userAssigned (ilPRGAssignment $assignment)

	userReAssigned (ilPRGAssignment $assignment)

	userDeassigned (ilPRGAssignment $a_assignment)

	userSuccessful (ilPRGAssignment $assignment, int $pgs_node_id)

	userRevertSuccessful (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)

	userRiskyToFail (ilPRGAssignment $assignment)

	informUserByMailToRestart (ilPRGAssignment $assignment)

Data Fields
const	PUBLIC_EVENTS

Data Fields inherited from StudyProgrammeEvents
const	COMPONENT = "components/ILIAS/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 21 of file class.ilStudyProgrammeEvents.php.

Constructor & Destructor Documentation

◆ __construct()

ilStudyProgrammeEvents::__construct	(	protected ilLogger	$logger,
		protected ilAppEventHandler	$app_event_handler,
		protected PRGEventHandler	$prg_event_handler
	)

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

43 {

44 }

Member Function Documentation

◆ deadlineChange()

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

Implements StudyProgrammeEvents.

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

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

References StudyProgrammeEvents\EVENT_DEADLINE_CHANGE, ilPRGAssignment\getId(), ilPRGAssignment\getRootId(), and ilPRGAssignment\getUserId().

Here is the call graph for this function:

◆ informUserByMailToRestart()

ilStudyProgrammeEvents::informUserByMailToRestart ( ilPRGAssignment $assignment )

Implements StudyProgrammeEvents.

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

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

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

Here is the call graph for this function:

◆ raise()

ilStudyProgrammeEvents::raise	(	string	$event,
		array	$parameter
	)

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

                                                          : void
    {
        $parameter_formatter = static function ($value) use (&$parameter_formatter) {
            if (is_object($value)) {
                return get_class($value);
            }
 
            if (is_array($value)) {
                return array_map(
                    $parameter_formatter,
                    $value
                );
            }
 
            return $value;
        };
 
        $this->logger->debug("PRG raised: " . $event . ' (' . var_export(array_map(
            $parameter_formatter,
            $parameter
        ), true) . ')');
 
        if (in_array($event, [
            self::EVENT_USER_ASSIGNED,
            self::EVENT_USER_DEASSIGNED,
            self::EVENT_USER_SUCCESSFUL,
            self::EVENT_USER_NOT_SUCCESSFUL,
            self::EVENT_VALIDITY_CHANGE
        ])) {
            $this->prg_event_handler->updateLPStatus($parameter['prg_id'], $parameter['usr_id']);
        }
 
        if (in_array($event, [
                self::EVENT_USER_SUCCESSFUL,
                self::EVENT_USER_NOT_SUCCESSFUL,
                self::EVENT_VALIDITY_CHANGE,
                self::EVENT_SCORE_CHANGE
            ])
            && $parameter["root_prg_id"] === $parameter["prg_id"]
        ) {
            $cert = fn() => $this->app_event_handler->raise(self::COMPONENT, self::EVENT_USER_SUCCESSFUL, $parameter);
            $this->prg_event_handler->triggerCertificateOnce($cert, $parameter["root_prg_id"], $parameter["usr_id"]);
        }
 
        if ($event === self::EVENT_USER_ABOUT_TO_FAIL) {
            $this->prg_event_handler->sendRiskyToFailMail($parameter['ass_id'], $parameter['root_prg_id']);
        }
        if ($event === self::EVENT_USER_TO_RESTART) {
            $this->prg_event_handler->sendInformToReAssignMail($parameter['ass_id'], $parameter['root_prg_id']);
        }
        if ($event === self::EVENT_USER_REASSIGNED) {
            $this->prg_event_handler->sendReAssignedMail($parameter['ass_id'], $parameter['root_prg_id']);
        }
        if ($event === self::EVENT_VALIDITY_CHANGE) {
            $this->prg_event_handler->resetMailFlagValidity($parameter['ass_id'], $parameter['root_prg_id']);
        }
        if ($event === self::EVENT_DEADLINE_CHANGE) {
            $this->prg_event_handler->resetMailFlagDeadline($parameter['ass_id'], $parameter['root_prg_id']);
        }
 
        if (in_array($event, self::PUBLIC_EVENTS)) {
            $this->app_event_handler->raise(self::COMPONENT, $event, $parameter);
        }
    }

References ILIAS\Repository\logger().

Here is the call graph for this function:

◆ scoreChange()

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

Implements StudyProgrammeEvents.

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

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

References StudyProgrammeEvents\EVENT_SCORE_CHANGE, ilPRGAssignment\getId(), ilPRGAssignment\getRootId(), and ilPRGAssignment\getUserId().

Here is the call graph for this function:

◆ userAssigned()

ilStudyProgrammeEvents::userAssigned ( ilPRGAssignment $assignment )

Implements StudyProgrammeEvents.

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

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

References StudyProgrammeEvents\EVENT_USER_ASSIGNED, ilPRGAssignment\getId(), ilPRGAssignment\getRootId(), and ilPRGAssignment\getUserId().

Here is the call graph for this function:

◆ userDeassigned()

ilStudyProgrammeEvents::userDeassigned ( ilPRGAssignment $a_assignment )

Implements StudyProgrammeEvents.

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

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

References StudyProgrammeEvents\EVENT_USER_DEASSIGNED, ilPRGAssignment\getId(), ilPRGAssignment\getRootId(), and ilPRGAssignment\getUserId().

Here is the call graph for this function:

◆ userReAssigned()

ilStudyProgrammeEvents::userReAssigned ( ilPRGAssignment $assignment )

Implements StudyProgrammeEvents.

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

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

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

Here is the call graph for this function:

◆ userRevertSuccessful()

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

Implements StudyProgrammeEvents.

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

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

References StudyProgrammeEvents\EVENT_USER_NOT_SUCCESSFUL, ilPRGAssignment\getId(), ilPRGAssignment\getRootId(), and ilPRGAssignment\getUserId().

Here is the call graph for this function:

◆ userRiskyToFail()

ilStudyProgrammeEvents::userRiskyToFail ( ilPRGAssignment $assignment )

Implements StudyProgrammeEvents.

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

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

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

Here is the call graph for this function:

◆ userSuccessful()

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

Implements StudyProgrammeEvents.

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

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

References StudyProgrammeEvents\EVENT_USER_SUCCESSFUL, ilPRGAssignment\getId(), ilPRGAssignment\getRootId(), and ilPRGAssignment\getUserId().

Here is the call graph for this function:

◆ validityChange()

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

Implements StudyProgrammeEvents.

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

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

References StudyProgrammeEvents\EVENT_VALIDITY_CHANGE, ilPRGAssignment\getId(), ilPRGAssignment\getRootId(), and ilPRGAssignment\getUserId().

Here is the call graph for this function:

Field Documentation

◆ PUBLIC_EVENTS

const ilStudyProgrammeEvents::PUBLIC_EVENTS

Initial value:

= [
        self::EVENT_USER_ASSIGNED,
        self::EVENT_USER_DEASSIGNED,
        self::EVENT_USER_REASSIGNED,
    ]

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

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

components/ILIAS/StudyProgramme/classes/Events/class.ilStudyProgrammeEvents.php

Public Member Functions

Data Fields

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ deadlineChange()

◆ informUserByMailToRestart()

◆ raise()

◆ scoreChange()

◆ userAssigned()

◆ userDeassigned()

◆ userReAssigned()

◆ userRevertSuccessful()

◆ userRiskyToFail()

◆ userSuccessful()

◆ validityChange()

Field Documentation

◆ PUBLIC_EVENTS