ilStudyProgrammeEvents Class Reference

Collaboration diagram for ilStudyProgrammeEvents:

Public Member Functions
	__construct (\ilAppEventHandler $app_event_handler, \ilStudyProgrammeAssignmentRepository $assignment_repo)
	raise ($a_event, $a_parameter)
	userAssigned (ilStudyProgrammeAssignment $a_assignment)
	userReAssigned (ilStudyProgrammeAssignment $a_assignment)
	userDeassigned (ilStudyProgrammeAssignment $a_assignment)
	userSuccessful (ilStudyProgrammeProgress $a_progress)
	informUserByMailToRestart (ilStudyProgrammeProgress $progress)
	userRiskyToFail (ilStudyProgrammeProgress $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

(

ilStudyProgrammeProgress

$progress

)

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

References ilStudyProgrammeProgress\getAssignmentId(), ilStudyProgrammeProgress\getId(), and ilStudyProgrammeProgress\getUserId().

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

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

(

ilStudyProgrammeAssignment

$a_assignment

)

Exceptions

ilException

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

References ilStudyProgrammeAssignment\getId(), ilStudyProgrammeAssignment\getRootId(), and ilStudyProgrammeAssignment\getUserId().

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

Here is the call graph for this function:

userDeassigned()

ilStudyProgrammeEvents::userDeassigned

(

ilStudyProgrammeAssignment

$a_assignment

)

Exceptions

ilException

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

References ilStudyProgrammeAssignment\getId(), ilStudyProgrammeAssignment\getRootId(), and ilStudyProgrammeAssignment\getUserId().

                                                                             : void
    {
        $this->raise(
            "userDeassigned",
            [
                "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()

ilStudyProgrammeEvents::userReAssigned

(

ilStudyProgrammeAssignment

$a_assignment

)

Exceptions

ilException

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

References ilObjStudyProgramme\getRefIdFor(), ilStudyProgrammeAssignment\getRootId(), and ilStudyProgrammeAssignment\getUserId().

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

Here is the call graph for this function:

userRiskyToFail()

ilStudyProgrammeEvents::userRiskyToFail

(

ilStudyProgrammeProgress

$progress

)

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

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

                                                                        : void
    {
        $this->raise(
            "userRiskyToFail",
            [
                "progress_id" => $progress->getId(),
                "usr_id" => $progress->getUserId()
            ]
        );
    }

Here is the call graph for this function:

userSuccessful()

ilStudyProgrammeEvents::userSuccessful

(

ilStudyProgrammeProgress

$a_progress

)

Exceptions

ilException

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

References ilStudyProgrammeProgress\getAssignmentId(), and ilStudyProgrammeProgress\getNodeId().

                                                                         : void
    {
        $ass = $this->assignment_repo->get($a_progress->getAssignmentId());
        $this->raise(
            "userSuccessful",
            [
                "root_prg_id" => $ass->getRootId(),
                "prg_id" => $a_progress->getNodeId(),
                "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