ilForumAppEventListener Class Reference

Forum listener. More...

Inheritance diagram for ilForumAppEventListener:

Collaboration diagram for ilForumAppEventListener:

Static Public Member Functions
static	sendNotification (ilObjForumNotificationDataProvider $provider, \ilLogger $logger, int $notificationTypes, array $recipients)
Static Public Member Functions inherited from ilAppEventListener
static	handleEvent ($a_component, $a_event, $a_parameter)
	Handle an event in a listener. More...

Static Protected Attributes
static	$ref_ids = array()

Static Private Member Functions
static	getCachedReferences ($obj_id)
static	delegateNotification (ilObjForumNotificationDataProvider $provider, $notification_type, \ilLogger $logger)

Detailed Description

Forum listener.

Listens to events of other components.

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

Definition at line 11 of file class.ilForumAppEventListener.php.

Member Function Documentation

delegateNotification()

static ilForumAppEventListener::delegateNotification ( ilObjForumNotificationDataProvider  $provider,   $notification_type, \ilLogger  $logger  )

staticprivate

Parameters

ilObjForumNotificationDataProvider	$provider
int	$notification_type
ilLogger	$logger

Definition at line 445 of file class.ilForumAppEventListener.php.

References ilLogger\debug(), ilObjForumNotificationDataProvider\getForumNotificationRecipients(), ilObjForumNotificationDataProvider\getPostActivationRecipients(), ilObjForumNotificationDataProvider\getPostAnsweredRecipients(), ilObjForumNotificationDataProvider\getThreadNotificationRecipients(), ilForumMailNotification\TYPE_POST_ACTIVATION, and ilForumMailNotification\TYPE_POST_ANSWERED.

      {
        switch ($notification_type) {
            case ilForumMailNotification::TYPE_POST_ACTIVATION:
                self::sendNotification($provider, $logger, $notification_type, $provider->getPostActivationRecipients());
                break;

            case ilForumMailNotification::TYPE_POST_ANSWERED:
                self::sendNotification($provider, $logger, $notification_type, $provider->getPostAnsweredRecipients());
                break;

            default:
                // get recipients who wants to get forum notifications
                $logger->debug('Determining subscribers for global forum notifications ...');
                $frm_recipients = $provider->getForumNotificationRecipients();

                // get recipients who wants to get thread notifications
                $logger->debug('Determining subscribers for thread notifications ...');
                $thread_recipients = $provider->getThreadNotificationRecipients();

                $recipients = array_unique(array_merge($frm_recipients, $thread_recipients));
                self::sendNotification($provider, $logger, $notification_type, $recipients);

                break;
        }
    }

Here is the call graph for this function:

getCachedReferences()

static ilForumAppEventListener::getCachedReferences (   $obj_id )

staticprivate

Parameters

int

$obj_id

Definition at line 432 of file class.ilForumAppEventListener.php.

References ilObject\_getAllReferences().

    {
        if (!array_key_exists($obj_id, self::$ref_ids)) {
            self::$ref_ids[$obj_id] = ilObject::_getAllReferences($obj_id);
        }
        return self::$ref_ids[$obj_id];
    }

Here is the call graph for this function:

sendNotification()

static ilForumAppEventListener::sendNotification ( ilObjForumNotificationDataProvider  $provider, \ilLogger  $logger, int  $notificationTypes, array  $recipients  )

static

Parameters

ilObjForumNotificationDataProvider	$provider
ilLogger	$logger
int	$notificationTypes
array	$recipients

Definition at line 481 of file class.ilForumAppEventListener.php.

References ilLogger\debug().

      {
        if (count($recipients)) {
            $logger->debug(sprintf(
                'Will send %s notification(s) to: %s',
                count($recipients),
                implode(', ', $recipients)
            ));

            $mailNotification = new ilForumMailNotification($provider, $logger);
            $mailNotification->setType($notificationTypes);
            $mailNotification->setRecipients($recipients);
            $mailNotification->send();
        } else {
            $logger->debug('No recipients found, skipped notification delivery.');
        }
    }

Here is the call graph for this function:

Field Documentation

$ref_ids

ilForumAppEventListener::$ref_ids = array()

staticprotected

Definition at line 13 of file class.ilForumAppEventListener.php.

---

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

• Modules/Forum/classes/class.ilForumAppEventListener.php