Collaboration diagram for ILIAS\Notifications\ilNotificationSystem:

Public Member Functions
	__construct (ilRbacReview $rbacReview=null)

	toUsers (ilNotificationConfig $notification, array $users, bool $processAsync=false)

	clear (string $channel='')

Static Public Member Functions
static	sendNotificationToUsers (ilNotificationConfig $notification, array $users, bool $processAsync=false)

static	sendNotificationToListeners (ilNotificationConfig $notification, int $ref_id, bool $processAsync=false)

static	sendNotificationToRoles (ilNotificationConfig $notification, array $roles, bool $processAsync=false)

static	enableListeners (string $module, int $ref_id)

static	enableUserListeners (string $module, int $ref_id, array $users)

Private Member Functions
	addHandler (string $channel, ilNotificationHandler $handler)

	toListeners (ilNotificationConfig $notification, int $ref_id, bool $processAsync=false)

	toRoles (ilNotificationConfig $notification, array $roles, bool $processAsync=false)

Private Attributes
array	$handler = []

string	$defaultLanguage = 'en'

ilRbacReview	$rbacReview

Detailed Description

Author: Jan Posselt jposs.nosp@m.elt@.nosp@m.datab.nosp@m.ay.d.nosp@m.e

Definition at line 31 of file ilNotificationSystem.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Notifications\ilNotificationSystem::__construct ( ilRbacReview $rbacReview = null )

Definition at line 40 of file ilNotificationSystem.php.

References $DIC, ILIAS\Notifications\ilNotificationSystem\$rbacReview, and ILIAS\Notifications\ilNotificationSystem\addHandler().

     {
         $this->addHandler('osd', new ilNotificationOSDHandler());
         $this->addHandler('mail', new ilNotificationMailHandler());
         if ($rbacReview === null) {
             global $DIC;
             $rbacReview = $DIC->rbac()->review();
         }
         $this->rbacReview = $rbacReview;
     }

Here is the call graph for this function:

Member Function Documentation

◆ addHandler()

ILIAS\Notifications\ilNotificationSystem::addHandler	(	string	$channel,
		ilNotificationHandler	$handler
	)

private

Definition at line 52 of file ilNotificationSystem.php.

References ILIAS\Notifications\ilNotificationSystem\$handler.

Referenced by ILIAS\Notifications\ilNotificationSystem\__construct().

                                                                                 : void
     {
         if (!array_key_exists($channel, $this->handler) || !is_array($this->handler[$channel])) {
             $this->handler[$channel] = [];
         }
 
         $this->handler[$channel][] = $handler;
     }

Here is the caller graph for this function:

◆ clear()

ILIAS\Notifications\ilNotificationSystem::clear ( string $channel = '' )

Definition at line 188 of file ilNotificationSystem.php.

References $c, and ILIAS\Notifications\ilNotificationSystem\$handler.

                                                : void
     {
         $channels = $this->handler;
         if ($channel !== '') {
             $channels = [$this->handler[$channel]] ?? [];
         }
         foreach ($channels as $c) {
             foreach ($c as $handler) {
                 $handler->clear();
             }
         }
     }

◆ enableListeners()

static ILIAS\Notifications\ilNotificationSystem::enableListeners	(	string	$module,
		int	$ref_id
	)

static

Definition at line 176 of file ilNotificationSystem.php.

References ILIAS\Notifications\ilNotificationDatabaseHandler\enableListeners().

                                                                        : void
     {
         ilNotificationDatabaseHandler::enableListeners($module, $ref_id);
     }

Here is the call graph for this function:

◆ enableUserListeners()

static ILIAS\Notifications\ilNotificationSystem::enableUserListeners	(	string	$module,
		int	$ref_id,
		array	$users
	)

static

Definition at line 181 of file ilNotificationSystem.php.

References ILIAS\Notifications\ilNotificationDatabaseHandler\enableListeners().

                                                                                          : void
     {
         if ($users) {
             ilNotificationDatabaseHandler::enableListeners($module, $ref_id, $users);
         }
     }

Here is the call graph for this function:

◆ sendNotificationToListeners()

static ILIAS\Notifications\ilNotificationSystem::sendNotificationToListeners	(	ilNotificationConfig	$notification,
		int	$ref_id,
		bool	$processAsync = `false`
	)

static

Definition at line 161 of file ilNotificationSystem.php.

References $DIC.

Referenced by ILIAS\Notifications\Model\ilNotificationConfig\notifyByListeners().

                                                                                                                                    : void
     {
         global $DIC;
         $DIC->notifications()->system()->toListeners($notification, $ref_id, $processAsync);
     }

Here is the caller graph for this function:

◆ sendNotificationToRoles()

static ILIAS\Notifications\ilNotificationSystem::sendNotificationToRoles	(	ilNotificationConfig	$notification,
		array	$roles,
		bool	$processAsync = `false`
	)

static

Parameters

int[] $roles

Definition at line 170 of file ilNotificationSystem.php.

References $DIC.

Referenced by ILIAS\Notifications\Model\ilNotificationConfig\notifyByRoles().

                                                                                                                                 : void
     {
         global $DIC;
         $DIC->notifications()->system()->toRoles($notification, $roles, $processAsync);
     }

Here is the caller graph for this function:

◆ sendNotificationToUsers()

static ILIAS\Notifications\ilNotificationSystem::sendNotificationToUsers	(	ilNotificationConfig	$notification,
		array	$users,
		bool	$processAsync = `false`
	)

static

Deprecated:

Parameters

int[] $users

Definition at line 155 of file ilNotificationSystem.php.

References $DIC.

Referenced by ILIAS\Notifications\Model\ilNotificationConfig\notifyByUsers().

                                                                                                                                 : void
     {
         global $DIC;
         $DIC->notifications()->system()->toUsers($notification, $users, $processAsync);
     }

Here is the caller graph for this function:

◆ toListeners()

ILIAS\Notifications\ilNotificationSystem::toListeners	(	ilNotificationConfig	$notification,
		int	$ref_id,
		bool	$processAsync = `false`
	)

private

Definition at line 125 of file ilNotificationSystem.php.

References $ref_id, ILIAS\Notifications\ilNotificationDatabaseHandler\disableListeners(), ILIAS\Notifications\ilNotificationDatabaseHandler\enqueueByListener(), ILIAS\Notifications\Model\ilNotificationConfig\getType(), ILIAS\Notifications\ilNotificationDatabaseHandler\getUsersByListener(), and ILIAS\Notifications\Model\ilNotificationConfig\hasDisableAfterDeliverySet().

                                                                                                              : void
     {
         if ($processAsync === false) {
             $users = ilNotificationDatabaseHandler::getUsersByListener($notification->getType(), $ref_id);
             if ($notification->hasDisableAfterDeliverySet()) {
                 ilNotificationDatabaseHandler::disableListeners($notification->getType(), $ref_id);
             }
         } else {
             ilNotificationDatabaseHandler::enqueueByListener($notification, $ref_id);
         }
     }

Here is the call graph for this function:

◆ toRoles()

ILIAS\Notifications\ilNotificationSystem::toRoles	(	ilNotificationConfig	$notification,
		array	$roles,
		bool	$processAsync = `false`
	)

private

Parameters

int[] $roles

Definition at line 140 of file ilNotificationSystem.php.

References ILIAS\Notifications\ilNotificationSystem\toUsers().

                                                                                                           : void
     {
         $users = [];
         foreach ($roles as $role) {
             $users[] = $this->rbacReview->assignedUsers($role);
         }
         $users = array_unique(array_merge(...$users));
 
         $this->toUsers($notification, $users, $processAsync);
     }

Here is the call graph for this function:

◆ toUsers()

ILIAS\Notifications\ilNotificationSystem::toUsers	(	ilNotificationConfig	$notification,
		array	$users,
		bool	$processAsync = `false`
	)

Parameters

int[] $users

Definition at line 64 of file ilNotificationSystem.php.

References $data, ILIAS\Notifications\ilNotificationSystem\$handler, $lang, ILIAS\Notifications\ilNotificationDatabaseHandler\enqueueByUsers(), ILIAS\Notifications\ilNotificationDatabaseHandler\getAvailableChannels(), ILIAS\Notifications\ilNotificationDatabaseHandler\getAvailableTypes(), ilObjectFactory\getInstanceByObjId(), ILIAS\Notifications\Model\ilNotificationConfig\getLanguageParameters(), ILIAS\Notifications\ilNotificationDatabaseHandler\getTranslatedLanguageVariablesOfNotificationParameters(), ILIAS\Notifications\Model\ilNotificationConfig\getType(), ILIAS\Notifications\Model\ilNotificationConfig\getUserInstance(), ILIAS\Notifications\ilNotificationDatabaseHandler\getUsersWithCustomConfig(), and ILIAS\Notifications\ilNotificationDatabaseHandler\loadUserConfig().

Referenced by ILIAS\Notifications\ilNotificationSystem\toRoles().

                                                                                                          : void
     {
         if ($processAsync === false) {
             $adminConfig = ilNotificationDatabaseHandler::loadUserConfig(-1);
             $usersWithCustomConfig = ilNotificationDatabaseHandler::getUsersWithCustomConfig($users);
             $channels = ilNotificationDatabaseHandler::getAvailableChannels();
             $types = ilNotificationDatabaseHandler::getAvailableTypes();
             $lang = ilNotificationDatabaseHandler::getTranslatedLanguageVariablesOfNotificationParameters($notification->getLanguageParameters());
 
             $user_by_handler = [];
             if (isset($types[$notification->getType()]['config_type'])) {
                 if ($types[$notification->getType()]['config_type'] === 'set_by_user') {
                     $it = new ilNotificationUserIterator($notification->getType(), $users);
                     $channelsByAdmin = false;
                     foreach ($it as $usr_id => $data) {
                         if (!isset($channels['channel']) || !$channels[$data['channel']]) {
                             continue;
                         }
                         if (!isset($user_by_handler[$data['channel']]) || !$user_by_handler[$data['channel']]) {
                             $user_by_handler[$data['channel']] = [];
                         }
                         $user_by_handler[$data['channel']][] = $usr_id;
                     }
                 } elseif ($types[$notification->getType()]['config_type'] !== 'disabled') {
                     $channelsByAdmin = true;
                     if (isset($adminConfig[$notification->getType()])) {
                         foreach ($adminConfig[$notification->getType()] as $channel) {
                             if (!isset($channels[$channel]) || !$channels[$channel]) {
                                 continue;
                             }
                             $user_by_handler[$channel] = $users;
                         }
                     }
                 }
             }
 
             $userCache = [];
 
             foreach ($user_by_handler as $handler => $h_users) {
                 $handler = $this->handler[$handler];
                 foreach ($h_users as $userId) {
                     if (!isset($userCache[$userId]) || !$userCache[$userId]) {
                         $user = ilObjectFactory::getInstanceByObjId($userId, false);
                         if (!($user instanceof ilObjUser)) {
                             continue;
                         }
                         $userCache[$userId] = $user;
                     }
                     $user = $userCache[$userId];
 
                     $instance = $notification->getUserInstance($user, $lang, $this->defaultLanguage);
                     foreach ($handler as $h) {
                         $h->notify($instance);
                     }
                 }
             }
         } else {
             ilNotificationDatabaseHandler::enqueueByUsers($notification, $users);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $defaultLanguage

string ILIAS\Notifications\ilNotificationSystem::$defaultLanguage = 'en'

private

Definition at line 37 of file ilNotificationSystem.php.

◆ $handler

array ILIAS\Notifications\ilNotificationSystem::$handler = []

private

Definition at line 36 of file ilNotificationSystem.php.

Referenced by ILIAS\Notifications\ilNotificationSystem\addHandler(), ILIAS\Notifications\ilNotificationSystem\clear(), and ILIAS\Notifications\ilNotificationSystem\toUsers().

◆ $rbacReview

ilRbacReview ILIAS\Notifications\ilNotificationSystem::$rbacReview

private

Definition at line 38 of file ilNotificationSystem.php.

Referenced by ILIAS\Notifications\ilNotificationSystem\__construct().

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

Services/Notifications/classes/ilNotificationSystem.php

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addHandler()

◆ clear()

◆ enableListeners()

◆ enableUserListeners()

◆ sendNotificationToListeners()

◆ sendNotificationToRoles()

◆ sendNotificationToUsers()

◆ toListeners()

◆ toRoles()

◆ toUsers()

Field Documentation

◆ $defaultLanguage

◆ $handler

◆ $rbacReview