ilForumAppEventListener Class Reference

Forum listener. More...

Inheritance diagram for ilForumAppEventListener:

Collaboration diagram for ilForumAppEventListener:

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

Static Protected Attributes
static array	$ref_ids = []

Static Private Member Functions
static	getCachedReferences (int $obj_id)
static	delegateNotification (ilForumNotificationDataProvider $provider, int $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 \

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

Member Function Documentation

delegateNotification()

static ilForumAppEventListener::delegateNotification ( ilForumNotificationDataProvider  $provider, int  $notification_type, ilLogger  $logger  )

staticprivate

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

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

     : void {
        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 want to get forum notifications
                $logger->debug('Determining subscribers for global forum notifications ...');
                $frm_recipients = $provider->getForumNotificationRecipients($notification_type);

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

                $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 ( int  $obj_id )

staticprivate

Returns

int[]

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

References ilObject\_getAllReferences().

                                                            : array
    {
        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 ( ilForumNotificationDataProvider  $provider, ilLogger  $logger, int  $notificationTypes, array  $recipients  )

static

Parameters

int[]

$recipients

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

References ANONYMOUS_USER_ID, and ilLogger\debug().

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

            if (defined('ANONYMOUS_USER_ID')) {
                $recipients = array_filter(
                    $recipients,
                    static fn(int $recipient): bool => $recipient !== ANONYMOUS_USER_ID
                );
            }

            $mailNotification = new ilForumMailEventNotificationSender($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

array ilForumAppEventListener::$ref_ids = []

staticprotected

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

---

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

• components/ILIAS/Forum/classes/class.ilForumAppEventListener.php