ilStudyProgrammeAppEventListener Class Reference

Event listener for study programs. More...

Collaboration diagram for ilStudyProgrammeAppEventListener:

Static Public Member Functions
static	handleEvent ($a_component, $a_event, $a_parameter)

Static Private Member Functions
static	onServiceUserDeleteUser ($a_parameter)
static	onServiceTrackingUpdateStatus ($a_par)
static	onServiceTreeInsertNode ($a_parameter)
static	onServiceTreeMoveTree ($a_parameter)
static	onServiceObjectDeleteOrToTrash ($a_parameter)
static	getStudyProgramme ($a_ref_id)
static	adjustProgrammeLPMode ($a_ref_id)
static	addMissingProgresses ($a_ref_id)

Detailed Description

Event listener for study programs.

Has the following tasks:

• Remove all assignments of a user on all study programms when the user is removed.

Author

Richard Klees richa.nosp@m.rd.k.nosp@m.lees@.nosp@m.conc.nosp@m.epts-.nosp@m.and-.nosp@m.train.nosp@m.ing..nosp@m.de

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

Member Function Documentation

addMissingProgresses()

static ilStudyProgrammeAppEventListener::addMissingProgresses (   $a_ref_id )

staticprivate

Definition at line 149 of file class.ilStudyProgrammeAppEventListener.php.

    {
        $obj = self::getStudyProgramme($a_ref_id);
        $obj->addMissingProgresses();
    }

References getStudyProgramme().

Referenced by onServiceTreeInsertNode().

Here is the call graph for this function:

Here is the caller graph for this function:

adjustProgrammeLPMode()

static ilStudyProgrammeAppEventListener::adjustProgrammeLPMode (   $a_ref_id )

staticprivate

Definition at line 143 of file class.ilStudyProgrammeAppEventListener.php.

    {
        $obj = self::getStudyProgramme($a_ref_id);
        $obj->adjustLPMode();
    }

References getStudyProgramme().

Referenced by onServiceObjectDeleteOrToTrash(), onServiceTreeInsertNode(), and onServiceTreeMoveTree().

Here is the call graph for this function:

Here is the caller graph for this function:

getStudyProgramme()

static ilStudyProgrammeAppEventListener::getStudyProgramme (   $a_ref_id )

staticprivate

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

    {
        require_once("Modules/StudyProgramme/classes/class.ilObjStudyProgramme.php");
        return ilObjStudyProgramme::getInstanceByRefId($a_ref_id);
    }

References ilObjStudyProgramme\getInstanceByRefId().

Referenced by addMissingProgresses(), and adjustProgrammeLPMode().

Here is the call graph for this function:

Here is the caller graph for this function:

handleEvent()

static ilStudyProgrammeAppEventListener::handleEvent (   $a_component,   $a_event,   $a_parameter  )

static

Definition at line 17 of file class.ilStudyProgrammeAppEventListener.php.

    {
        switch ($a_component) {
            case "Services/User":
                switch ($a_event) {
                    case "deleteUser":
                        self::onServiceUserDeleteUser($a_parameter);
                        break;
                }
                break;
            case "Services/Tracking":
                switch ($a_event) {
                    case "updateStatus":
                        self::onServiceTrackingUpdateStatus($a_parameter);
                        break;
                }
                break;
            case "Services/Tree":
                switch ($a_event) {
                    case "insertNode":
                        self::onServiceTreeInsertNode($a_parameter);
                        break;
                    case "moveTree":
                        self::onServiceTreeMoveTree($a_parameter);
                        break;
                }
                break;
            case "Services/Object":
                switch ($a_event) {
                    case "delete":
                    case "toTrash":
                        self::onServiceObjectDeleteOrToTrash($a_parameter);
                        break;
                }
                break;
            case "Services/ContainerReference":
                switch ($a_event) {
                    case "deleteReference":
                        self::onServiceObjectDeleteOrToTrash($a_parameter);
                        break;
                }
                break;
            default:
                throw new ilException("ilStudyProgrammeAppEventListener::handleEvent: "
                                     . "Won't handle events of '$a_component'.");
        }
    }

References onServiceObjectDeleteOrToTrash(), onServiceTrackingUpdateStatus(), onServiceTreeInsertNode(), onServiceTreeMoveTree(), and onServiceUserDeleteUser().

Here is the call graph for this function:

onServiceObjectDeleteOrToTrash()

static ilStudyProgrammeAppEventListener::onServiceObjectDeleteOrToTrash (   $a_parameter )

staticprivate

Definition at line 122 of file class.ilStudyProgrammeAppEventListener.php.

    {
        $node_ref_id = $a_parameter["ref_id"];
        $old_parent_ref_id = $a_parameter["old_parent_ref_id"];
        
        $node_type = $a_parameter["type"];
        $old_parent_type = ilObject::_lookupType($old_parent_ref_id, true);
 
        if ($old_parent_type != "prg") {
            return;
        }
 
        self::adjustProgrammeLPMode($old_parent_ref_id);
    }

References ilObject\_lookupType(), and adjustProgrammeLPMode().

Referenced by handleEvent().

Here is the call graph for this function:

Here is the caller graph for this function:

onServiceTrackingUpdateStatus()

static ilStudyProgrammeAppEventListener::onServiceTrackingUpdateStatus (   $a_par )

staticprivate

Definition at line 74 of file class.ilStudyProgrammeAppEventListener.php.

    {
        require_once("./Services/Tracking/classes/class.ilLPStatus.php");
        if ($a_par["status"] != ilLPStatus::LP_STATUS_COMPLETED_NUM) {
            return;
        }
 
        require_once("./Modules/StudyProgramme/classes/class.ilObjStudyProgramme.php");
        ilObjStudyProgramme::setProgressesCompletedFor($a_par["obj_id"], $a_par["usr_id"]);
    }

References ilLPStatus\LP_STATUS_COMPLETED_NUM, and ilObjStudyProgramme\setProgressesCompletedFor().

Referenced by handleEvent().

Here is the call graph for this function:

Here is the caller graph for this function:

onServiceTreeInsertNode()

static ilStudyProgrammeAppEventListener::onServiceTreeInsertNode (   $a_parameter )

staticprivate

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

    {
        $node_ref_id = $a_parameter["node_id"];
        $parent_ref_id = $a_parameter["parent_id"];
 
        $node_type = ilObject::_lookupType($node_ref_id, true);
        $parent_type = ilObject::_lookupType($parent_ref_id, true);
 
        if ($node_type == "crsr" && $parent_type == "prg") {
            self::adjustProgrammeLPMode($parent_ref_id);
        }
        if ($node_type == "prg" && $parent_type == "prg") {
            self::addMissingProgresses($parent_ref_id);
        }
    }

References ilObject\_lookupType(), addMissingProgresses(), and adjustProgrammeLPMode().

Referenced by handleEvent().

Here is the call graph for this function:

Here is the caller graph for this function:

onServiceTreeMoveTree()

static ilStudyProgrammeAppEventListener::onServiceTreeMoveTree (   $a_parameter )

staticprivate

Definition at line 101 of file class.ilStudyProgrammeAppEventListener.php.

    {
        $node_ref_id = $a_parameter["source_id"];
        $new_parent_ref_id = $a_parameter["target_id"];
        $old_parent_ref_id = $a_parameter["old_parent_id"];
 
        $node_type = ilObject::_lookupType($node_ref_id, true);
        $new_parent_type = ilObject::_lookupType($new_parent_ref_id, true);
        $old_parent_type = ilObject::_lookupType($old_parent_ref_id, true);
        
        if ($node_type != "crsr" || ($new_parent_type != "prg" && $old_parent_type != "prg")) {
            return;
        }
 
        if ($new_parent_type == "prg") {
            self::adjustProgrammeLPMode($new_parent_ref_id);
        } elseif ($old_parent_type == "prg") {
            self::adjustProgrammeLPMode($old_parent_ref_id);
        }
    }

References ilObject\_lookupType(), and adjustProgrammeLPMode().

Referenced by handleEvent().

Here is the call graph for this function:

Here is the caller graph for this function:

onServiceUserDeleteUser()

static ilStudyProgrammeAppEventListener::onServiceUserDeleteUser (   $a_parameter )

staticprivate

Definition at line 65 of file class.ilStudyProgrammeAppEventListener.php.

    {
        require_once("./Modules/StudyProgramme/classes/class.ilStudyProgrammeUserAssignment.php");
        $assignments = ilStudyProgrammeUserAssignment::getInstancesOfUser($a_parameter["usr_id"]);
        foreach ($assignments as $ass) {
            $ass->deassign();
        }
    }

References ilStudyProgrammeUserAssignment\getInstancesOfUser().

Referenced by handleEvent().

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

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