ilStudyProgrammeEvents Class Reference

Collaboration diagram for ilStudyProgrammeEvents:

Public Member Functions
	__construct (\ilAppEventHandler $app_event_handler, \ilStudyProgrammeAssignmentRepository $assignment_repo)
	raise ($a_event, $a_parameter)
	userAssigned (ilStudyProgrammeUserAssignment $a_assignment)
	userReAssigned (ilStudyProgrammeUserAssignment $a_assignment)
	userDeassigned (ilStudyProgrammeUserAssignment $a_assignment)
	userSuccessful (ilStudyProgrammeUserProgress $a_progress)
	informUserByMailToRestart (ilStudyProgrammeUserAssignment $assignment)
	userRiskyToFail (ilStudyProgrammeUserProgress $a_progress)

Data Fields
const	COMPONENT = "Modules/StudyProgramme"
	$app_event_handler

Protected Attributes
	$assignment_repo

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilStudyProgrammeEvents::__construct	(	\ilAppEventHandler	$app_event_handler,
		\ilStudyProgrammeAssignmentRepository	$assignment_repo
	)

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

References $app_event_handler, and $assignment_repo.

      {
        $this->app_event_handler = $app_event_handler;
        $this->assignment_repo = $assignment_repo;
    }

Member Function Documentation

informUserByMailToRestart()

ilStudyProgrammeEvents::informUserByMailToRestart

(

ilStudyProgrammeUserAssignment

$assignment

)

Exceptions

ilException

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

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

                                                                                          : void
    {
        $this->raise(
            'informUserToRestart',
            [
                "usr_id" => (int) $assignment->getUserId(),
                "ass_id" => (int) $assignment->getId()
            ]
        );
    }

Here is the call graph for this function:

raise()

ilStudyProgrammeEvents::raise	(		$a_event,
			$a_parameter
	)

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

                                                  : void
    {
        $this->app_event_handler->raise(self::COMPONENT, $a_event, $a_parameter);
    }

userAssigned()

ilStudyProgrammeEvents::userAssigned

(

ilStudyProgrammeUserAssignment

$a_assignment

)

Exceptions

ilException

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

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

                                                                               : void
    {
        $this->raise(
            "userAssigned",
            [
                "root_prg_id" => $a_assignment->getStudyProgramme()->getId(),
                "usr_id" => $a_assignment->getUserId(),
                "ass_id" => $a_assignment->getId()
            ]
        );
    }

Here is the call graph for this function:

userDeassigned()

ilStudyProgrammeEvents::userDeassigned

(

ilStudyProgrammeUserAssignment

$a_assignment

)

Exceptions

ilException

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

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

                                                                                 : void
    {
        $this->raise(
            "userDeassigned",
            [
                "root_prg_id" => $a_assignment->getStudyProgramme()->getId(),
                "usr_id" => $a_assignment->getUserId(),
                "ass_id" => $a_assignment->getId()
            ]
        );
    }

Here is the call graph for this function:

userReAssigned()

ilStudyProgrammeEvents::userReAssigned

(

ilStudyProgrammeUserAssignment

$a_assignment

)

Exceptions

ilException

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

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

                                                                                 : void
    {
        $this->raise(
            "userReAssigned",
            [
                "root_prg_ref_id" => (int) $a_assignment->getStudyProgramme()->getRefId(),
                "usr_id" => (int) $a_assignment->getUserId()
            ]
        );
    }

Here is the call graph for this function:

userRiskyToFail()

ilStudyProgrammeEvents::userRiskyToFail

(

ilStudyProgrammeUserProgress

$a_progress

)

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

References ilStudyProgrammeUserProgress\getAssignmentId(), and ilStudyProgrammeUserProgress\getId().

                                                                              : void
    {
        $ass = $this->assignment_repo->read($a_progress->getAssignmentId());
        $this->raise(
            "userRiskyToFail",
            [
                "progress_id" => $a_progress->getId(),
                "usr_id" => $ass->getUserId()
            ]
        );
    }

Here is the call graph for this function:

userSuccessful()

ilStudyProgrammeEvents::userSuccessful

(

ilStudyProgrammeUserProgress

$a_progress

)

Exceptions

ilException

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

References ilStudyProgrammeUserProgress\getAssignmentId(), and ilStudyProgrammeUserProgress\getStudyProgramme().

                                                                             : void
    {
        $ass = $this->assignment_repo->read($a_progress->getAssignmentId());
        $this->raise(
            "userSuccessful",
            [
                "root_prg_id" => $ass->getRootId(),
                "prg_id" => $a_progress->getStudyProgramme()->getId(),
                "usr_id" => $ass->getUserId(),
                "ass_id" => $ass->getId()
            ]
        );
    }

Here is the call graph for this function:

Field Documentation

$app_event_handler

ilStudyProgrammeEvents::$app_event_handler

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

Referenced by __construct().

$assignment_repo

ilStudyProgrammeEvents::$assignment_repo

protected

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

Referenced by __construct().

COMPONENT

const ilStudyProgrammeEvents::COMPONENT = "Modules/StudyProgramme"

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

---

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

• Modules/StudyProgramme/classes/class.ilStudyProgrammeEvents.php