EventListener for LSO. More...

Collaboration diagram for ilLearningSequenceAppEventListener:

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

Static Protected Member Functions
static	getLSEventHandler ()

static	getIlTree ()

static	getIlLanguage ()

static	getIlLPStatusWrapper ()

Static Private Member Functions
static	onServiceTrackingUpdateStatus (array $parameter)

static	onObjectDeletion (array $parameter)

static	onObjectToTrash (array $parameter)

static	onObjectCloned (ilObject $new_obj, ilObject $origin_obj)

static	onParticipantDeletion (array $parameter)

Static Private Attributes
static ilLSLPEventHandler	$lp_event_handler = null

Detailed Description

EventListener for LSO.

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

Member Function Documentation

◆ getIlLanguage()

static ilLearningSequenceAppEventListener::getIlLanguage ( )

staticprotected

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

                                             : illanguage
    {
        global $DIC;
        return $DIC['lng'];
    }

References $DIC.

Referenced by onServiceTrackingUpdateStatus().

Here is the caller graph for this function:

◆ getIlLPStatusWrapper()

static ilLearningSequenceAppEventListener::getIlLPStatusWrapper ( )

staticprotected

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

                                                    : ilLPStatusWrapper
    {
        return new ilLPStatusWrapper();
    }

◆ getIlTree()

static ilLearningSequenceAppEventListener::getIlTree ( )

staticprotected

Definition at line 131 of file class.ilLearningSequenceAppEventListener.php.

                                         : ilTree
    {
        global $DIC;
        return $DIC['tree'];
    }

References $DIC.

◆ getLSEventHandler()

static ilLearningSequenceAppEventListener::getLSEventHandler ( )

staticprotected

Definition at line 126 of file class.ilLearningSequenceAppEventListener.php.

                                                 : ilLSEventHandler
    {
        return new ilLSEventHandler(self::getIlTree());
    }

Referenced by onObjectCloned(), onObjectDeletion(), onObjectToTrash(), and onParticipantDeletion().

Here is the caller graph for this function:

◆ handleEvent()

static ilLearningSequenceAppEventListener::handleEvent	(	string	$component,
		string	$event,
		array	$parameter
	)

static

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

                                                                                          : void
    {
        switch ($component) {
            case "components/ILIAS/Tracking":
                switch ($event) {
                    case "updateStatus":
                        self::onServiceTrackingUpdateStatus($parameter);
                        break;
                }
                break;
            case "components/ILIAS/ILIASObject":
                switch ($event) {
                    case "beforeDeletion":
                        self::onObjectDeletion($parameter);
                        break;
                    case "toTrash":
                        self::onObjectToTrash($parameter);
                        break;
                    case 'cloneObject':
                        $new_obj = $parameter['object'];
                        $origin_obj = $parameter['cloned_from_object'];
                        self::onObjectCloned($new_obj, $origin_obj);
                        break;
                }
                break;
 
            case "components/ILIAS/LearningSequence":
                switch ($event) {
                    case "deleteParticipant":
                        self::onParticipantDeletion($parameter);
                        break;
                    case "addParticipant":
                    default:
                        break;
                }
                break;
 
            default:
                throw new ilException(
                    "ilLearningSequenceAppEventListener::handleEvent: " .
                    "Won't handle events of '$component'."
                );
        }
    }

References onObjectCloned(), onObjectDeletion(), onObjectToTrash(), onParticipantDeletion(), and onServiceTrackingUpdateStatus().

Here is the call graph for this function:

◆ onObjectCloned()

static ilLearningSequenceAppEventListener::onObjectCloned	(	ilObject	$new_obj,
		ilObject	$origin_obj
	)

staticprivate

Definition at line 111 of file class.ilLearningSequenceAppEventListener.php.

                                                                                   : void
    {
        $handler = self::getLSEventHandler();
        $handler->handleClonedObject($new_obj, $origin_obj);
    }

References $handler, and getLSEventHandler().

Referenced by handleEvent().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ onObjectDeletion()

static ilLearningSequenceAppEventListener::onObjectDeletion ( array $parameter )

staticprivate

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

                                                              : void
    {
        $handler = self::getLSEventHandler();
        $handler->handleObjectDeletion($parameter);
    }

References $handler, and getLSEventHandler().

Referenced by handleEvent().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ onObjectToTrash()

static ilLearningSequenceAppEventListener::onObjectToTrash ( array $parameter )

staticprivate

Definition at line 105 of file class.ilLearningSequenceAppEventListener.php.

                                                             : void
    {
        $handler = self::getLSEventHandler();
        $handler->handleObjectToTrash($parameter);
    }

References $handler, and getLSEventHandler().

Referenced by handleEvent().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ onParticipantDeletion()

static ilLearningSequenceAppEventListener::onParticipantDeletion ( array $parameter )

staticprivate

Definition at line 117 of file class.ilLearningSequenceAppEventListener.php.

                                                                   : void
    {
        $handler = self::getLSEventHandler();
        $obj_id = (int) $parameter['obj_id'];
        $usr_id = (int) $parameter['usr_id'];
 
        $handler->handleParticipantDeletion($obj_id, $usr_id);
    }

References $handler, getLSEventHandler(), 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 ilLearningSequenceAppEventListener::onServiceTrackingUpdateStatus ( array $parameter )

staticprivate

Definition at line 75 of file class.ilLearningSequenceAppEventListener.php.

                                                                           : void
    {
        if (self::$lp_event_handler === null) {
            self::$lp_event_handler = new ilLSLPEventHandler(self::getIlTree(), self::getIlLPStatusWrapper());
        }
        self::$lp_event_handler->updateLPForChildEvent($parameter);
 
        if ($parameter['status'] === ilLPStatus::LP_STATUS_COMPLETED_NUM
            && $parameter['old_status'] !== $parameter['status']
            && ilObject::_lookupType($parameter['obj_id']) === 'lso'
        ) {
            $lng = self::getIlLanguage();
            $lso_title = ilObject::_lookupTitle($parameter['obj_id']);
            $notification = new ilNotificationConfig(ilLSCompletionNotificationProvider::NOTIFICATION_TYPE);
            $notification->setValidForSeconds(ilNotificationConfig::TTL_LONG);
            $notification->setVisibleForSeconds(ilNotificationConfig::DEFAULT_TTS);
            $notification->setTitleVar($lng->txt('lso_toast_completed_title'));
            $notification->setShortDescriptionVar($lng->txt('lso_toast_completed_desc'));
            $notification->setLongDescriptionVar($lng->txt('lso_toast_completed_desc'));
            $notification->setIconPath('assets/images/standard/icon_lso.svg');
            $notification->notifyByUsers([$parameter['usr_id']]);
        }
    }