ilSessionAppEventListener Class Reference

Inheritance diagram for ilSessionAppEventListener:

Collaboration diagram for ilSessionAppEventListener:

Public Member Functions
	__construct (\ilDBInterface $db, \ilObjectDataCache $objectDataCache, \ilLogger $logger)
	withComponent ($component)
	withEvent ($event)
	withParameters (array $parameters)
	handle ()

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

Private Member Functions
	handleRegisterEvent ()
	handleEnteredEvent ()
	handleUnregisterEvent ()
	fetchRecipientParticipants ()
	sendMail ($type)

Private Attributes
	$database
	$objectDataCache
	$logger
	$component
	$event
	$parameters

Detailed Description

Author

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

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

Constructor & Destructor Documentation

__construct()

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

Parameters

ilDBInterface	$db
ilObjectDataCache	$objectDataCache
ilLogger	$logger

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

References $logger, and $objectDataCache.

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

Member Function Documentation

fetchRecipientParticipants()

ilSessionAppEventListener::fetchRecipientParticipants ( )

private

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

Referenced by sendMail().

    {
        $object = new ilEventParticipants($this->parameters['obj_id']);

        $recipients = array();
        $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 117 of file class.ilSessionAppEventListener.php.

References Vendor\Package\$e, handleEnteredEvent(), handleRegisterEvent(), and handleUnregisterEvent().

    {
        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 143 of file class.ilSessionAppEventListener.php.

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

Referenced by handle().

    {
        $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 (   $a_component,   $a_event,   $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 100 of file class.ilSessionAppEventListener.php.

References $DIC.

    {
        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 136 of file class.ilSessionAppEventListener.php.

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

Referenced by handle().

    {
        $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 150 of file class.ilSessionAppEventListener.php.

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

Referenced by handle().

    {
        $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 (   $type )

private

Parameters

array	$recipients
	$type

Exceptions

ilException

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

References $type, and fetchRecipientParticipants().

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

    {
        $recipients = $this->fetchRecipientParticipants();
        if (array() !== $recipients) {
            $notification = new ilSessionMembershipMailNotification();
            $notification->setRecipients($recipients);
            $notification->setType($type);
            $notification->setRefId($this->parameters['ref_id']);

            $notification->send($this->parameters['usr_id']);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

withComponent()

ilSessionAppEventListener::withComponent

(

$component

)

Parameters

string

$component

Returns

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

References $component.

    {
        $clone = clone $this;

        $clone->component = $component;

        return $clone;
    }

withEvent()

ilSessionAppEventListener::withEvent

(

$event

)

Parameters

string

$event

Returns

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

References $event.

    {
        $clone = clone $this;

        $clone->event = $event;

        return $clone;
    }

withParameters()

ilSessionAppEventListener::withParameters

(

array

$parameters

)

Parameters

array

$parameters

Returns

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

References $parameters.

    {
        $clone = clone $this;

        $clone->parameters = $parameters;

        return $clone;
    }

Field Documentation

$component

ilSessionAppEventListener::$component

private

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

Referenced by withComponent().

$database

ilSessionAppEventListener::$database

private

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

$event

ilSessionAppEventListener::$event

private

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

Referenced by withEvent().

$logger

ilSessionAppEventListener::$logger

private

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

Referenced by __construct().

$objectDataCache

ilSessionAppEventListener::$objectDataCache

private

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

Referenced by __construct().

$parameters

ilSessionAppEventListener::$parameters

private

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

Referenced by withParameters().

---

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

• Modules/Session/classes/class.ilSessionAppEventListener.php