This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilSessionAppEventListener:

Collaboration diagram for ilSessionAppEventListener:

Public Member Functions
	__construct (\ilDBInterface $db, \ilObjectDataCache $objectDataCache, \ilLogger $logger)

	withComponent (string $component)

	withEvent (string $event)

	withParameters (array $parameters)

	handle ()

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

Protected Attributes
ilDBInterface	$database

ilObjectDataCache	$objectDataCache

ilLogger	$logger

string	$component = ""

string	$event = ""

array	$parameters = []

Private Member Functions
	handleRegisterEvent ()

	handleEnteredEvent ()

	handleUnregisterEvent ()

	fetchRecipientParticipants ()

	sendMail (int $type)

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

Author: Niels Theen nthee.nosp@m.n@da.nosp@m.tabay.nosp@m..de

Definition at line 25 of file class.ilSessionAppEventListener.php.

Constructor & Destructor Documentation

◆ __construct()

ilSessionAppEventListener::__construct	(	\ilDBInterface	$db,
		\ilObjectDataCache	$objectDataCache,
		\ilLogger	$logger
	)

Definition at line 34 of file class.ilSessionAppEventListener.php.

References $logger, $objectDataCache, and ILIAS\Repository\logger().

       {
         $this->database = $db;
         $this->objectDataCache = $objectDataCache;
         $this->logger = $logger;
     }

Here is the call graph for this function:

Member Function Documentation

◆ fetchRecipientParticipants()

ilSessionAppEventListener::fetchRecipientParticipants ( )

private

Definition at line 135 of file class.ilSessionAppEventListener.php.

References $id.

Referenced by sendMail().

                                                  : array
     {
         $object = new ilEventParticipants((int) $this->parameters['obj_id']);
 
         $recipients = [];
         $participants = $object->getParticipants();
         foreach ($participants as $id => $participant) {
             if ($participant['notification_enabled'] === true) {
                 $recipients[] = $id;
             }
         }
 
         return $recipients;
     }

Here is the caller graph for this function:

◆ handle()

ilSessionAppEventListener::handle ( )

Definition at line 88 of file class.ilSessionAppEventListener.php.

References Vendor\Package\$e, $session, ILIAS\Repository\event(), ilObjectFactory\getInstanceByObjId(), handleEnteredEvent(), handleRegisterEvent(), handleUnregisterEvent(), and ILIAS\Repository\logger().

                             : void
     {
         if ($this->component === 'Services/AccessControl') {
             if ($this->event === 'deassignUser') {
                 $session = ilObjectFactory::getInstanceByObjId($this->parameters['obj_id'], false);
                 if ($session instanceof ilObjSession) {
                     $session->handleAutoFill();
                 }
             }
         }
 
 
         if ('Modules/Session' !== $this->component) {
             return;
         }
 
         try {
             if ('register' === $this->event) {
                 $this->handleRegisterEvent();
             } elseif ('enter' === $this->event) {
                 $this->handleEnteredEvent();
             } elseif ('unregister' === $this->event) {
                 $this->handleUnregisterEvent();
             }
         } catch (\ilException $e) {
             $this->logger->error($e->getMessage());
         }
     }

Here is the call graph for this function:

◆ handleEnteredEvent()

ilSessionAppEventListener::handleEnteredEvent ( )

private

Definition at line 123 of file class.ilSessionAppEventListener.php.

References $type, sendMail(), and ilSessionMembershipMailNotification\TYPE_ENTER_NOTIFICATION.

Referenced by handle().

                                          : void
     {
         $type = ilSessionMembershipMailNotification::TYPE_ENTER_NOTIFICATION;
         $this->sendMail($type);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ handleEvent()

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

static

Handle an event in a listener.

Parameters

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

Implements ilAppEventListener.

Definition at line 71 of file class.ilSessionAppEventListener.php.

References $DIC.

                                                                                                 : void
     {
         global $DIC;
 
         $listener = new static(
             $DIC->database(),
             $DIC['ilObjDataCache'],
             $DIC->logger()->sess()
         );
 
         $listener
             ->withComponent($a_component)
             ->withEvent($a_event)
             ->withParameters($a_parameter)
             ->handle();
     }

◆ handleRegisterEvent()

ilSessionAppEventListener::handleRegisterEvent ( )

private

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

References $type, sendMail(), and ilSessionMembershipMailNotification\TYPE_REGISTER_NOTIFICATION.

Referenced by handle().

                                           : void
     {
         $type = ilSessionMembershipMailNotification::TYPE_REGISTER_NOTIFICATION;
         $this->sendMail($type);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ handleUnregisterEvent()

ilSessionAppEventListener::handleUnregisterEvent ( )

private

Definition at line 129 of file class.ilSessionAppEventListener.php.

References $type, sendMail(), and ilSessionMembershipMailNotification\TYPE_UNREGISTER_NOTIFICATION.

Referenced by handle().

                                             : void
     {
         $type = ilSessionMembershipMailNotification::TYPE_UNREGISTER_NOTIFICATION;
         $this->sendMail($type);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sendMail()

ilSessionAppEventListener::sendMail ( int $type )

private

Definition at line 150 of file class.ilSessionAppEventListener.php.

References fetchRecipientParticipants().

Referenced by handleEnteredEvent(), handleRegisterEvent(), and handleUnregisterEvent().

                                         : void
     {
         $recipients = $this->fetchRecipientParticipants();
         if (!empty($recipients)) {
             $notification = new ilSessionMembershipMailNotification();
             $notification->setRecipients($recipients);
             $notification->setType($type);
             $notification->setRefId($this->parameters['ref_id']);
             $notification->send((int) $this->parameters['usr_id']);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ withComponent()

ilSessionAppEventListener::withComponent ( string $component )

Definition at line 44 of file class.ilSessionAppEventListener.php.

References $component.

                                                     : ilSessionAppEventListener
     {
         $clone = clone $this;
 
         $clone->component = $component;
 
         return $clone;
     }

◆ withEvent()

ilSessionAppEventListener::withEvent ( string $event )

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

References $event.

                                             : ilSessionAppEventListener
     {
         $clone = clone $this;
 
         $clone->event = $event;
 
         return $clone;
     }

◆ withParameters()

ilSessionAppEventListener::withParameters ( array $parameters )

Definition at line 62 of file class.ilSessionAppEventListener.php.

References $parameters.

                                                      : ilSessionAppEventListener
     {
         $clone = clone $this;
 
         $clone->parameters = $parameters;
 
         return $clone;
     }