ilStudyProgrammeAppEventListener Class Reference

Event listener for study programs. More...

Collaboration diagram for ilStudyProgrammeAppEventListener:

Static Public Member Functions
static	handleEvent (string $component, string $event, array $parameter)

Static Private Member Functions
static	onServiceUserDeleteUser (array $parameter)
static	onServiceTrackingUpdateStatus (array $parameter)
static	onServiceTreeInsertNode (array $parameter)
static	onServiceTreeMoveTree (array $parameter)
static	onServiceObjectDeleteOrToTrash (array $parameter)
static	getStudyProgramme (int $ref_id)
static	adjustProgrammeLPMode (int $ref_id)
static	addMissingProgresses (int $ref_id)
static	addCrsToProgrammes (int $crs_ref_id, int $cat_ref_id)
static	removeCrsFromProgrammes (int $crs_ref_id, int $cat_ref_id)
static	addMemberToProgrammes (string $src_type, array $params)
static	removeMemberFromProgrammes (string $src_type, array $params)

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.
• Add/Remove courses to/from study programms, if upper category is under surveillance

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 32 of file class.ilStudyProgrammeAppEventListener.php.

Member Function Documentation

addCrsToProgrammes()

static ilStudyProgrammeAppEventListener::addCrsToProgrammes ( int  $crs_ref_id, int  $cat_ref_id  )

staticprivate

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

                                                                                : void
    {
        ilObjStudyProgramme::addCrsToProgrammes($crs_ref_id, $cat_ref_id);
    }

References ilObjStudyProgramme\addCrsToProgrammes().

Referenced by onServiceTreeInsertNode(), and onServiceTreeMoveTree().

Here is the call graph for this function:

Here is the caller graph for this function:

addMemberToProgrammes()

static ilStudyProgrammeAppEventListener::addMemberToProgrammes ( string  $src_type, array  $params  )

staticprivate

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

                                                                                  : void
    {
        $usr_id = $params['usr_id'];
        $id = $params['obj_id'];
        if (
            $src_type === ilStudyProgrammeAutoMembershipSource::TYPE_GROUP ||
            $src_type === ilStudyProgrammeAutoMembershipSource::TYPE_COURSE
        ) {
            $ref_ids = ilObject::_getAllReferences($id);
            $id = array_shift($ref_ids);
        }
        if ($src_type === ilStudyProgrammeAutoMembershipSource::TYPE_ROLE) {
            $id = $params['role_id'];
        }
 
        ilObjStudyProgramme::addMemberToProgrammes($src_type, $id, $usr_id);
    }

References $id, $params, ilObject\_getAllReferences(), ilObjStudyProgramme\addMemberToProgrammes(), ilStudyProgrammeAutoMembershipSource\TYPE_COURSE, ilStudyProgrammeAutoMembershipSource\TYPE_GROUP, and ilStudyProgrammeAutoMembershipSource\TYPE_ROLE.

Referenced by handleEvent().

Here is the call graph for this function:

Here is the caller graph for this function:

addMissingProgresses()

static ilStudyProgrammeAppEventListener::addMissingProgresses ( int  $ref_id )

staticprivate

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

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

References $ref_id, and getStudyProgramme().

Referenced by onServiceTreeInsertNode().

Here is the call graph for this function:

Here is the caller graph for this function:

adjustProgrammeLPMode()

static ilStudyProgrammeAppEventListener::adjustProgrammeLPMode ( int  $ref_id )

staticprivate

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

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

References $ref_id, and 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 ( int  $ref_id )

staticprivate

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

                                                          : ilObjStudyProgramme
    {
        return ilObjStudyProgramme::getInstanceByRefId($ref_id);
    }

References $ref_id, and 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 ( string  $component, string  $event, array  $parameter  )

static

Exceptions

ilException

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

                                                                                          : void
    {
        global $DIC;
 
        switch ($component) {
            case "components/ILIAS/User":
                switch ($event) {
                    case "deleteUser":
                        self::onServiceUserDeleteUser($parameter);
                        break;
                }
                break;
            case "components/ILIAS/Tracking":
                switch ($event) {
                    case "updateStatus":
                        self::onServiceTrackingUpdateStatus($parameter);
                        break;
                }
                break;
            case "components/ILIAS/Tree":
                switch ($event) {
                    case "insertNode":
                        self::onServiceTreeInsertNode($parameter);
                        break;
                    case "moveTree":
                        self::onServiceTreeMoveTree($parameter);
                        break;
                }
                break;
            case "components/ILIAS/ILIASObject":
                switch ($event) {
                    case "delete":
                    case "toTrash":
                        self::onServiceObjectDeleteOrToTrash($parameter);
                        break;
                }
                break;
            case "components/ILIAS/ContainerReference":
                switch ($event) {
                    case "deleteReference":
                        self::onServiceObjectDeleteOrToTrash($parameter);
                        break;
                }
                break;
 
            case "components/ILIAS/Course":
                switch ($event) {
                    case "addParticipant":
                        self::addMemberToProgrammes(
                            ilStudyProgrammeAutoMembershipSource::TYPE_COURSE,
                            $parameter
                        );
                        break;
                    case "deleteParticipant":
                        self::removeMemberFromProgrammes(
                            ilStudyProgrammeAutoMembershipSource::TYPE_COURSE,
                            $parameter
                        );
                        break;
                }
                break;
            case "components/ILIAS/Group":
                switch ($event) {
                    case "addParticipant":
                        self::addMemberToProgrammes(
                            ilStudyProgrammeAutoMembershipSource::TYPE_GROUP,
                            $parameter
                        );
                        break;
                    case "deleteParticipant":
                        self::removeMemberFromProgrammes(
                            ilStudyProgrammeAutoMembershipSource::TYPE_GROUP,
                            $parameter
                        );
                        break;
                }
                break;
            case "components/ILIAS/AccessControl":
                switch ($event) {
                    case "assignUser":
                        self::addMemberToProgrammes(
                            ilStudyProgrammeAutoMembershipSource::TYPE_ROLE,
                            $parameter
                        );
                        break;
                    case "deassignUser":
                        self::removeMemberFromProgrammes(
                            ilStudyProgrammeAutoMembershipSource::TYPE_ROLE,
                            $parameter
                        );
                        break;
                }
                break;
            case "components/ILIAS/OrgUnit":
                switch ($event) {
                    case "assignUserToPosition":
                        self::addMemberToProgrammes(
                            ilStudyProgrammeAutoMembershipSource::TYPE_ORGU,
                            $parameter
                        );
                        break;
                    case "deassignUserFromPosition":
                        self::removeMemberFromProgrammes(
                            ilStudyProgrammeAutoMembershipSource::TYPE_ORGU,
                            $parameter
                        );
                        break;
                }
                break;
 
            case 'components/ILIAS/StudyProgramme':
                switch ($event) {
                    case 'userSuccessful':
                        try {
                            $DIC->certificate()->userCertificates()->certificateCriteriaMet(
                                (int) $parameter['usr_id'],
                                (int) $parameter['prg_id']
                            );
                        } catch (\ilCouldNotFindCertificateTemplate $e) {
                        }
                        break;
                }
                break;
 
            default:
                throw new ilException(
                    "ilStudyProgrammeAppEventListener::handleEvent: Won't handle events of '$component'."
                );
        }
    }

References $DIC, Vendor\Package\$e, addMemberToProgrammes(), onServiceObjectDeleteOrToTrash(), onServiceTrackingUpdateStatus(), onServiceTreeInsertNode(), onServiceTreeMoveTree(), onServiceUserDeleteUser(), removeMemberFromProgrammes(), ilStudyProgrammeAutoMembershipSource\TYPE_COURSE, ilStudyProgrammeAutoMembershipSource\TYPE_GROUP, ilStudyProgrammeAutoMembershipSource\TYPE_ORGU, and ilStudyProgrammeAutoMembershipSource\TYPE_ROLE.

Here is the call graph for this function:

onServiceObjectDeleteOrToTrash()

static ilStudyProgrammeAppEventListener::onServiceObjectDeleteOrToTrash ( array  $parameter )

staticprivate

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

                                                                            : void
    {
        $old_parent_ref_id = (int) $parameter["old_parent_ref_id"];
 
        $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(), adjustProgrammeLPMode(), and ILIAS\Repository\int().

Referenced by handleEvent().

Here is the call graph for this function:

Here is the caller graph for this function:

onServiceTrackingUpdateStatus()

static ilStudyProgrammeAppEventListener::onServiceTrackingUpdateStatus ( array  $parameter )

staticprivate

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

                                                                           : void
    {
        if ((int) $parameter["status"] !== ilLPStatus::LP_STATUS_COMPLETED_NUM) {
            return;
        }
 
        $crs_reference_obj_ids = ilContainerReference::_lookupSourceIds((int) $parameter["obj_id"]);
        foreach ($crs_reference_obj_ids as $crsr_obj_id) {
            foreach (ilObject::_getAllReferences($crsr_obj_id) as $crsr_ref_id) {
                ilObjStudyProgramme::setProgressesCompletedIfParentIsProgrammeInLPCompletedMode(
                    $crsr_ref_id,
                    (int) $parameter["obj_id"],
                    (int) $parameter["usr_id"]
                );
            }
        }
    }

References ilObject\_getAllReferences(), ilContainerReference\_lookupSourceIds(), ilLPStatus\LP_STATUS_COMPLETED_NUM, and ilObjStudyProgramme\setProgressesCompletedIfParentIsProgrammeInLPCompletedMode().

Referenced by handleEvent().

Here is the call graph for this function:

Here is the caller graph for this function:

onServiceTreeInsertNode()

static ilStudyProgrammeAppEventListener::onServiceTreeInsertNode ( array  $parameter )

staticprivate

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

                                                                     : void
    {
        $node_ref_id = (int) $parameter["node_id"];
        $parent_ref_id = (int) $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 ($parent_type === "prg" && in_array($node_type, ["prg", "prgr"])) {
            self::addMissingProgresses($parent_ref_id);
        }
        if ($node_type === "crs" && $parent_type === "cat") {
            self::addCrsToProgrammes($node_ref_id, $parent_ref_id);
        }
    }

References ilObject\_lookupType(), addCrsToProgrammes(), addMissingProgresses(), adjustProgrammeLPMode(), and ILIAS\Repository\int().

Referenced by handleEvent().

Here is the call graph for this function:

Here is the caller graph for this function:

onServiceTreeMoveTree()

static ilStudyProgrammeAppEventListener::onServiceTreeMoveTree ( array  $parameter )

staticprivate

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

                                                                   : void
    {
        $node_ref_id = (int) $parameter["source_id"];
        $new_parent_ref_id = (int) $parameter["target_id"];
        $old_parent_ref_id = (int) $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 (!in_array($node_type, ["crsr","crs"])
            || (
                ($new_parent_type !== "prg" && $old_parent_type !== "prg")
                &&
                $old_parent_type !== "cat"
            )
        ) {
            return;
        }
 
        if ($node_type === 'crs') {
            self::removeCrsFromProgrammes($node_ref_id, $old_parent_ref_id);
            if ($new_parent_type === 'cat') {
                self::addCrsToProgrammes($node_ref_id, $new_parent_ref_id);
            }
        }
 
        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(), addCrsToProgrammes(), adjustProgrammeLPMode(), ILIAS\Repository\int(), and removeCrsFromProgrammes().

Referenced by handleEvent().

Here is the call graph for this function:

Here is the caller graph for this function:

onServiceUserDeleteUser()

static ilStudyProgrammeAppEventListener::onServiceUserDeleteUser ( array  $parameter )

staticprivate

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

                                                                     : void
    {
        $repo = ilStudyProgrammeDIC::dic()['repo.assignment'];
        $assignments = $repo->getForUser((int) $parameter["usr_id"]);
 
        foreach ($assignments as $ass) {
            $repo->delete($ass);
        }
    }

References ilStudyProgrammeDIC\dic().

Referenced by handleEvent().

Here is the call graph for this function:

Here is the caller graph for this function:

removeCrsFromProgrammes()

static ilStudyProgrammeAppEventListener::removeCrsFromProgrammes ( int  $crs_ref_id, int  $cat_ref_id  )

staticprivate

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

                                                                                     : void
    {
        ilObjStudyProgramme::removeCrsFromProgrammes($crs_ref_id, $cat_ref_id);
    }

References ilObjStudyProgramme\removeCrsFromProgrammes().

Referenced by onServiceTreeMoveTree().

Here is the call graph for this function:

Here is the caller graph for this function:

removeMemberFromProgrammes()

static ilStudyProgrammeAppEventListener::removeMemberFromProgrammes ( string  $src_type, array  $params  )

staticprivate

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

                                                                                       : void
    {
        $usr_id = $params['usr_id'];
        $id = $params['obj_id'];
        if (
            $src_type === ilStudyProgrammeAutoMembershipSource::TYPE_GROUP ||
            $src_type === ilStudyProgrammeAutoMembershipSource::TYPE_COURSE
        ) {
            $ref_ids = ilObject::_getAllReferences($id);
            $id = array_shift($ref_ids);
        }
        if ($src_type === ilStudyProgrammeAutoMembershipSource::TYPE_ROLE) {
            $id = $params['role_id'];
        }
 
        ilObjStudyProgramme::removeMemberFromProgrammes($src_type, $id, (int) $usr_id);
    }

References $id, $params, ilObject\_getAllReferences(), ilObjStudyProgramme\removeMemberFromProgrammes(), ilStudyProgrammeAutoMembershipSource\TYPE_COURSE, ilStudyProgrammeAutoMembershipSource\TYPE_GROUP, and ilStudyProgrammeAutoMembershipSource\TYPE_ROLE.

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:

• components/ILIAS/StudyProgramme/classes/class.ilStudyProgrammeAppEventListener.php