ilContainerReferenceAppEventListener Class Reference

Handles delete events from courses and categories. More...

Inheritance diagram for ilContainerReferenceAppEventListener:

Collaboration diagram for ilContainerReferenceAppEventListener:

Static Public Member Functions
static	handleEvent (string $a_component, string $a_event, array $a_parameter)
	Handle an event in a listener. More...
static	deleteReferences (int $a_target_id)

Detailed Description

Handles delete events from courses and categories.

Author

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Definition at line 26 of file class.ilContainerReferenceAppEventListener.php.

Member Function Documentation

deleteReferences()

static ilContainerReferenceAppEventListener::deleteReferences ( int  $a_target_id )

static

Definition at line 48 of file class.ilContainerReferenceAppEventListener.php.

References $DIC, $ref_id, ilObject\_getAllReferences(), ilContainerReference\_lookupSourceId(), and ilObjectFactory\getInstanceByRefId().

                                                             : void
    {
        global $DIC;

        $ilLog = $DIC["ilLog"];
        $ilAppEventHandler = $DIC["ilAppEventHandler"];
        $tree = $DIC["tree"];

        if (!$source_id = ilContainerReference::_lookupSourceId($a_target_id)) {
            return;
        }
        foreach (ilObject::_getAllReferences($source_id) as $ref_id) {
            if (!$instance = ilObjectFactory::getInstanceByRefId($ref_id, false)) {
                continue;
            }
            $type = $instance->getType();
            switch ($type) {
                case 'grpr':
                case 'crsr':
                case 'catr':
                case 'prgr':
                    $parent_id = $tree->getParentId($ref_id);
                    $instance->delete();
                    $ilLog->write(__METHOD__ . ': Deleted reference object of type ' . $instance->getType() . ' with Id ' . $instance->getId());
                    $ilAppEventHandler->raise(
                        'components/ILIAS/ContainerReference',
                        'deleteReference',
                        [
                            'ref_id' => $ref_id,
                            'old_parent_ref_id' => $parent_id,
                            'type' => $type
                        ]
                    );
                    break;

                default:
                    $ilLog->write(__METHOD__ . ': Unexpected object type ' . $instance->getType() . ' with Id ' . $instance->getId());
                    break;
            }
        }
    }

Here is the call graph for this function:

handleEvent()

static ilContainerReferenceAppEventListener::handleEvent ( string  $a_component, string  $a_event, array  $a_parameter  )

static

Handle an event in a listener.

Parameters

string	$a_component	component, e.g. "components/ILIAS/Forum" or "components/ILIAS/User"
string	$a_event	event e.g. "createUser", "updateUser", "deleteUser", ...
	array<string,mixed>	$a_parameter parameter array (assoc), array("name" => ..., "phone_office" => ...)

Implements ilAppEventListener.

Definition at line 28 of file class.ilContainerReferenceAppEventListener.php.

References $DIC.

                                                                                                : void
    {
        global $DIC;

        $ilLog = $DIC["ilLog"];

        switch ($a_component) {
            case 'components/ILIAS/Course':
            case 'components/ILIAS/Category':
            case 'components/ILIAS/StudyProgramme':
                switch ($a_event) {
                    case 'delete':
                        $ilLog->write(__METHOD__ . ': Handling delete event.');
                        self::deleteReferences((int) $a_parameter['obj_id']);
                        break;
                }
                break;
        }
    }

---

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

• components/ILIAS/ContainerReference/classes/class.ilContainerReferenceAppEventListener.php