Collaboration diagram for ILIAS\Notifications\ilNotificationDatabaseHandler:

Static Public Member Functions
static	getTranslatedLanguageVariablesOfNotificationParameters (array $vars=[])

static	setUserConfig (int $userid, array $configArray)

static	loadUserConfig (int $userid)

static	enqueueByUsers (ilNotificationConfig $notification, array $userids)

static	enqueueByListener (ilNotificationConfig $notification, int $ref_id)

static	storeNotification (ilNotificationConfig $notification)

static	removeNotification (int $id)

static	getUsersByListener (string $module, int $sender_id)

static	disableListeners (string $module, int $sender_id)

static	enableListeners (string $module, $sender_id, array $users=[])

static	registerChannel (ilDBInterface $db, string $name, string $title, string $description, string $class, string $classfile, string $config_type)

static	registerType (ilDBInterface $db, string $name, string $title, string $description, string $notification_group, string $config_type)

static	getAvailableChannels (array $config_types=[], bool $includeDisabled=false)

static	getAvailableTypes (array $config_types=[])

static	setConfigTypeForType (string $type_name, string $config_name)

static	setConfigTypeForChannel (string $channel_name, string $config_name)

static	getUsersWithCustomConfig (array $userid)

Static Protected Member Functions
static	fillPlaceholders (array $results, array $vars, array $langVarToTypeDict)

static	findPlaceholders (string $pattern, string $translation)

Static Private Member Functions
static	replaceFields (string $string, array $foundPlaceholders, array $params, string $startTag, string $endTage)

Detailed Description

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

Definition at line 32 of file ilNotificationDatabaseHandler.php.

Member Function Documentation

◆ disableListeners()

static ILIAS\Notifications\ilNotificationDatabaseHandler::disableListeners	(	string	$module,
		int	$sender_id
	)

static

Definition at line 296 of file ilNotificationDatabaseHandler.php.

References $DIC, $ilDB, $query, and ILIAS\Notifications\ilNotificationSetupHelper\$tbl_userlistener.

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

                                                                            : void
     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $query = 'UPDATE ' . ilNotificationSetupHelper::$tbl_userlistener . ' SET disabled = 1 WHERE module = %s AND sender_id = %s';
         $types = ['text', 'integer'];
         $values = [$module, $sender_id];
 
         $ilDB->manipulateF($query, $types, $values);
     }

Here is the caller graph for this function:

◆ enableListeners()

static ILIAS\Notifications\ilNotificationDatabaseHandler::enableListeners	(	string	$module,
			$sender_id,
		array	$users = `[]`
	)

static

Definition at line 309 of file ilNotificationDatabaseHandler.php.

References $DIC, $ilDB, $query, and ILIAS\Notifications\ilNotificationSetupHelper\$tbl_userlistener.

Referenced by ILIAS\Notifications\ilNotificationSystem\enableListeners(), and ILIAS\Notifications\ilNotificationSystem\enableUserListeners().

                                                                                          : void
     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $query = 'UPDATE ' . ilNotificationSetupHelper::$tbl_userlistener . ' SET disabled = 0 WHERE module = %s AND sender_id = %s';
 
         if ($users) {
             $query .= ' ' . $ilDB->in('usr_id', $users);
         }
 
         $types = ['text', 'integer'];
         $values = [$module, $sender_id];
 
         $ilDB->manipulateF($query, $types, $values);
     }

Here is the caller graph for this function:

◆ enqueueByListener()

static ILIAS\Notifications\ilNotificationDatabaseHandler::enqueueByListener	(	ilNotificationConfig	$notification,
		int	$ref_id
	)

static

Definition at line 223 of file ilNotificationDatabaseHandler.php.

References $DIC, $ilDB, $query, $ref_id, ILIAS\Notifications\ilNotificationSetupHelper\$tbl_notification_queue, ILIAS\Notifications\ilNotificationSetupHelper\$tbl_userlistener, ILIAS\Notifications\Model\ilNotificationConfig\getType(), ILIAS\Notifications\Model\ilNotificationConfig\getValidForSeconds(), and ILIAS\Notifications\Model\ilNotificationConfig\getVisibleForSeconds().

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

                                                                                              : void
     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $notification_id = self::storeNotification($notification);
         $valid_until = $notification->getValidForSeconds() ? (time() + $notification->getValidForSeconds()) : 0;
 
         $query = 'INSERT INTO ' . ilNotificationSetupHelper::$tbl_notification_queue . ' (notification_id, usr_id, valid_until, visible_for) '
                 . ' (SELECT %s, usr_id, %s, %s FROM ' . ilNotificationSetupHelper::$tbl_userlistener . ' WHERE disabled = 0 AND module = %s AND sender_id = %s)';
 
         $types = ['integer', 'integer', 'integer', 'text', 'integer'];
 
         $values = [$notification_id, $valid_until, $notification->getVisibleForSeconds(), $notification->getType(), $ref_id];
 
         $ilDB->manipulateF($query, $types, $values);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ enqueueByUsers()

static ILIAS\Notifications\ilNotificationDatabaseHandler::enqueueByUsers	(	ilNotificationConfig	$notification,
		array	$userids
	)

static

Definition at line 197 of file ilNotificationDatabaseHandler.php.

References $DIC, $ilDB, ILIAS\Notifications\ilNotificationSetupHelper\$tbl_notification_queue, ILIAS\Notifications\Model\ilNotificationConfig\getValidForSeconds(), and ILIAS\Notifications\Model\ilNotificationConfig\getVisibleForSeconds().

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

                                                                                              : void
     {
         if (!$userids) {
             return;
         }
 
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $notification_id = self::storeNotification($notification);
         $valid_until = $notification->getValidForSeconds() ? (time() + $notification->getValidForSeconds()) : 0;
 
         foreach ($userids as $userid) {
             $ilDB->insert(
                 ilNotificationSetupHelper::$tbl_notification_queue,
                 [
                     'notification_id' => ['integer', $notification_id],
                     'usr_id' => ['integer', $userid],
                     'valid_until' => ['integer', $valid_until],
                     'visible_for' => ['integer', $notification->getVisibleForSeconds()]
                 ]
             );
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fillPlaceholders()

static ILIAS\Notifications\ilNotificationDatabaseHandler::fillPlaceholders	(	array	$results,
		array	$vars,
		array	$langVarToTypeDict
	)

staticprotected

Parameters

array<string,ilNotificationParameter> $vars

Definition at line 77 of file ilNotificationDatabaseHandler.php.

References $res, and $results.

                                                                                                      : array
     {
         $pattern_old = '/##(.+?)##/im';
         $pattern = '/\[(.+?)\]/im';
 
         foreach ($results as $langVar => $res) {
             $placeholdersStack = [];
             $res->lang = [];
 
             foreach ($res->lang_untouched as $iso2shorthandle => $translation) {
                 $translation = str_replace("\\n", "\n", $translation);
                 $placeholdersStack[] = self::findPlaceholders($pattern, $translation);
                 $translation = self::replaceFields($translation, $placeholdersStack[count($placeholdersStack) - 1], $vars[$langVarToTypeDict[$langVar]]->getParameters(), '[', ']');
                 $placeholdersStack[] = self::findPlaceholders($pattern_old, $translation);
                 $res->lang[$iso2shorthandle] = self::replaceFields($translation, $placeholdersStack[count($placeholdersStack) - 1], $vars[$langVarToTypeDict[$langVar]]->getParameters(), '##', '##');
             }
 
             $res->params = array_diff(
                 array_unique(
                     array_merge(...$placeholdersStack)
                 ),
                 array_keys($vars[$langVarToTypeDict[$langVar]]->getParameters())
             );
         }
 
         return $results;
     }

◆ findPlaceholders()

static ILIAS\Notifications\ilNotificationDatabaseHandler::findPlaceholders	(	string	$pattern,
		string	$translation
	)

staticprotected

Definition at line 105 of file ilNotificationDatabaseHandler.php.

                                                                                     : array
     {
         $foundPlaceholders = [];
         preg_match_all($pattern, $translation, $foundPlaceholders);
         return (array) $foundPlaceholders[1];
     }

◆ getAvailableChannels()

static ILIAS\Notifications\ilNotificationDatabaseHandler::getAvailableChannels	(	array	$config_types = `[]`,
		bool	$includeDisabled = `false`
	)

static

Returns: string[][]

Definition at line 359 of file ilNotificationDatabaseHandler.php.

References $DIC, $ilDB, $query, ILIAS\LTI\ToolProvider\$settings, and ILIAS\Notifications\ilNotificationSetupHelper\$tbl_notification_channels.

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

                                                                                                         : array
     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $query = 'SELECT channel_name, title, description, class, include, config_type FROM ' . ilNotificationSetupHelper::$tbl_notification_channels;
         if ($config_types) {
             $query .= ' WHERE ' . $ilDB->in('config_type', $config_types, false, 'text');
         }
 
         $rset = $ilDB->query($query);
 
         $result = [];
 
         $settings = new ilSetting('notifications');
 
         while ($row = $ilDB->fetchAssoc($rset)) {
             if (!$includeDisabled && !$settings->get('enable_' . $row['channel_name'])) {
                 continue;
             }
 
             $result[$row['channel_name']] = [
                 'name' => $row['channel_name'],
                 'title' => $row['title'],
                 'description' => $row['description'],
                 'handler' => $row['class'],
                 'include' => $row['include'],
                 'config_type' => $row['config_type'],
             ];
         }
 
         return $result;
     }

Here is the caller graph for this function:

◆ getAvailableTypes()

static ILIAS\Notifications\ilNotificationDatabaseHandler::getAvailableTypes ( array $config_types = [] )

static

Returns: string[][]

Definition at line 397 of file ilNotificationDatabaseHandler.php.

References $DIC, $ilDB, $query, and ILIAS\Notifications\ilNotificationSetupHelper\$tbl_notification_types.

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

                                                                       : array
     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $query = 'SELECT type_name, title, description, notification_group, config_type FROM ' . ilNotificationSetupHelper::$tbl_notification_types;
         if ($config_types) {
             $query .= ' WHERE ' . $ilDB->in('config_type', $config_types, false, 'text');
         }
 
 
         $rset = $ilDB->query($query);
 
         $result = [];
 
         while ($row = $ilDB->fetchAssoc($rset)) {
             $result[$row['type_name']] = [
                 'name' => $row['type_name'],
                 'title' => $row['title'],
                 'description' => $row['description'],
                 'group' => $row['notification_group'],
                 'config_type' => $row['config_type'],
             ];
         }
 
         return $result;
     }

Here is the caller graph for this function:

◆ getTranslatedLanguageVariablesOfNotificationParameters()

static ILIAS\Notifications\ilNotificationDatabaseHandler::getTranslatedLanguageVariablesOfNotificationParameters ( array $vars = [] )

static

Parameters

array<string,ilNotificationParameter> $vars

Definition at line 37 of file ilNotificationDatabaseHandler.php.

References $DIC, $ilDB, $query, $res, $results, and $type.

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

                                                                                                    : array
     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $where = [];
         $langVarToTypeDict = [];
 
         foreach ($vars as $type => $var) {
             if (!$var) {
                 continue;
             }
             $where[] = sprintf('module = %s AND identifier = %s', $ilDB->quote($var->getLanguageModule()), $ilDB->quote($var->getName()));
             $langVarToTypeDict[$var->getName()] = $type;
         }
 
         if (!$where) {
             return [];
         }
 
         $query = 'SELECT identifier, lang_key, value FROM lng_data WHERE (' . implode(') OR (', $where) . ')';
         $res = $ilDB->query($query);
         $results = [];
 
         while ($row = $ilDB->fetchAssoc($res)) {
             if (!isset($results[$row['identifier']]) || !$results[$row['identifier']]) {
                 $results[$row['identifier']] = new stdClass();
                 $results[$row['identifier']]->lang_untouched = [];
                 $results[$row['identifier']]->params = [];
             }
             $results[$row['identifier']]->lang_untouched[$row['lang_key']] = $row['value'];
         }
 
         return self::fillPlaceholders($results, $vars, $langVarToTypeDict);
     }

Here is the caller graph for this function:

◆ getUsersByListener()

static ILIAS\Notifications\ilNotificationDatabaseHandler::getUsersByListener	(	string	$module,
		int	$sender_id
	)

static

Returns: int[]

Definition at line 277 of file ilNotificationDatabaseHandler.php.

References $DIC, $ilDB, $query, ILIAS\Notifications\ilNotificationSetupHelper\$tbl_userlistener, and ILIAS\Repository\int().

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

                                                                              : array
     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $query = 'SELECT usr_id FROM ' . ilNotificationSetupHelper::$tbl_userlistener . ' WHERE disabled = 0 AND module = %s AND sender_id = %s';
         $types = ['text', 'integer'];
         $values = [$module, $sender_id];
 
         $users = [];
 
         $rset = $ilDB->queryF($query, $types, $values);
         while ($row = $ilDB->fetchAssoc($rset)) {
             $users[] = (int) $row['usr_id'];
         }
         return $users;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getUsersWithCustomConfig()

static ILIAS\Notifications\ilNotificationDatabaseHandler::getUsersWithCustomConfig ( array $userid )

static

Parameters

int[] $userid

Returns: bool[]

Definition at line 455 of file ilNotificationDatabaseHandler.php.

References $DIC, $ilDB, and $query.

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

                                                                   : array
     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $query = 'SELECT usr_id, value FROM usr_pref WHERE ' . $ilDB->in('usr_id', $userid, false, 'integer') . ' AND keyword="use_custom_notification_setting" AND value="1"';
         $rset = $ilDB->query($query);
         $result = [];
         while ($row = $ilDB->fetchAssoc($rset)) {
             $result[$row['usr_id']] = (bool) $row['value'];
         }
         return $result;
     }

Here is the caller graph for this function:

◆ loadUserConfig()

static ILIAS\Notifications\ilNotificationDatabaseHandler::loadUserConfig ( int $userid )

static

Parameters

int $userid

Returns: string[][]

Definition at line 172 of file ilNotificationDatabaseHandler.php.

References $DIC, $ilDB, $query, $res, and ILIAS\Notifications\ilNotificationSetupHelper\$tbl_userconfig.

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

                                                       : array
     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $query = 'SELECT module, channel FROM ' . ilNotificationSetupHelper::$tbl_userconfig . ' WHERE usr_id = %s';
         $types = ['integer'];
         $values = [$userid];
 
         $res = $ilDB->queryF($query, $types, $values);
 
         $result = [];
 
         while ($row = $ilDB->fetchAssoc($res)) {
             if (!isset($result[$row['module']])) {
                 $result[$row['module']] = [];
             }
 
             $result[$row['module']][] = $row['channel'];
         }
 
         return $result;
     }

Here is the caller graph for this function:

◆ registerChannel()

static ILIAS\Notifications\ilNotificationDatabaseHandler::registerChannel	(	ilDBInterface	$db,
		string	$name,
		string	$title,
		string	$description,
		string	$class,
		string	$classfile,
		string	$config_type
	)

static

Definition at line 327 of file ilNotificationDatabaseHandler.php.

References ILIAS\Notifications\ilNotificationSetupHelper\$tbl_notification_channels, and ilDBInterface\insert().

Referenced by ILIAS\Notifications\ilNotificationSetupHelper\registerChannel().

                                                                                                                                                                       : void
     {
         $db->insert(
             ilNotificationSetupHelper::$tbl_notification_channels,
             [
                 'channel_name' => ['text', $name],
                 'title' => ['text', $title],
                 'description' => ['text', $description],
                 'class' => ['text', $class],
                 'include' => ['text', $classfile],
                 'config_type' => ['text', $config_type],
             ]
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ registerType()

static ILIAS\Notifications\ilNotificationDatabaseHandler::registerType	(	ilDBInterface	$db,
		string	$name,
		string	$title,
		string	$description,
		string	$notification_group,
		string	$config_type
	)

static

Definition at line 342 of file ilNotificationDatabaseHandler.php.

References ILIAS\Notifications\ilNotificationSetupHelper\$tbl_notification_types, and ilDBInterface\insert().

Referenced by ILIAS\Notifications\ilNotificationSetupHelper\registerType().

                                                                                                                                                              : void
     {
         $db->insert(
             ilNotificationSetupHelper::$tbl_notification_types,
             [
                 'type_name' => ['text', $name],
                 'title' => ['text', $title],
                 'description' => ['text', $description],
                 'notification_group' => ['text', $notification_group],
                 'config_type' => ['text', $config_type],
             ]
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ removeNotification()

static ILIAS\Notifications\ilNotificationDatabaseHandler::removeNotification ( int $id )

static

Definition at line 261 of file ilNotificationDatabaseHandler.php.

References $DIC, $id, $ilDB, $query, and ILIAS\Notifications\ilNotificationSetupHelper\$tbl_notification_data.

                                                       : void
     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $query = 'DELETE FROM ' . ilNotificationSetupHelper::$tbl_notification_data . ' WHERE notification_id = ?';
         $types = ['integer'];
         $values = [$id];
 
         $ilDB->manipulateF($query, $types, $values);
     }

◆ replaceFields()

static ILIAS\Notifications\ilNotificationDatabaseHandler::replaceFields	(	string	$string,
		array	$foundPlaceholders,
		array	$params,
		string	$startTag,
		string	$endTage
	)

staticprivate

Parameters

string[]	$foundPlaceholders
string[]	$params

Definition at line 116 of file ilNotificationDatabaseHandler.php.

                                                                                                                                      : string
     {
         $result = $string;
         foreach ($foundPlaceholders as $placeholder) {
             if (array_key_exists(strtoupper($placeholder), $params)) {
                 $result = str_ireplace($startTag . $placeholder . $endTage, $params[strtoupper($placeholder)], $result);
             }
             if (array_key_exists(strtolower($placeholder), $params)) {
                 $result = str_ireplace($startTag . $placeholder . $endTage, $params[strtolower($placeholder)], $result);
             }
         }
         return $result;
     }

◆ setConfigTypeForChannel()

static ILIAS\Notifications\ilNotificationDatabaseHandler::setConfigTypeForChannel	(	string	$channel_name,
		string	$config_name
	)

static

Definition at line 438 of file ilNotificationDatabaseHandler.php.

References $DIC, $ilDB, $query, and ILIAS\Notifications\ilNotificationSetupHelper\$tbl_notification_channels.

                                                                                              : void
     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $query = 'UPDATE ' . ilNotificationSetupHelper::$tbl_notification_channels . ' SET config_type = %s WHERE channel_name = %s';
         $types = ['text', 'text'];
         $values = [$config_name, $channel_name];
         $ilDB->manipulateF($query, $types, $values);
     }

◆ setConfigTypeForType()

static ILIAS\Notifications\ilNotificationDatabaseHandler::setConfigTypeForType	(	string	$type_name,
		string	$config_name
	)

static

Definition at line 426 of file ilNotificationDatabaseHandler.php.

References $DIC, $ilDB, $query, and ILIAS\Notifications\ilNotificationSetupHelper\$tbl_notification_types.

                                                                                        : void
     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $query = 'UPDATE ' . ilNotificationSetupHelper::$tbl_notification_types . ' SET config_type = %s WHERE type_name = %s';
         $types = ['text', 'text'];
         $values = [$config_name, $type_name];
         $ilDB->manipulateF($query, $types, $values);
     }

◆ setUserConfig()

static ILIAS\Notifications\ilNotificationDatabaseHandler::setUserConfig	(	int	$userid,
		array	$configArray
	)

static

Definition at line 130 of file ilNotificationDatabaseHandler.php.

References $DIC, $ilDB, $query, ILIAS\Notifications\ilNotificationSetupHelper\$tbl_userconfig, and $type.

                                                                          : void
     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         if ($userid !== -1) {
             $channels = self::getAvailableChannels(['set_by_user']);
             $types = self::getAvailableTypes(['set_by_user']);
             $query = 'DELETE FROM ' . ilNotificationSetupHelper::$tbl_userconfig . ' WHERE usr_id=%s AND ' . $ilDB->in('module', array_keys($types), false, 'text') . ' AND ' . $ilDB->in('channel', array_keys($channels), false, 'text');
         } else {
             $query = 'DELETE FROM ' . ilNotificationSetupHelper::$tbl_userconfig . ' WHERE usr_id=%s';
         }
 
         $types = ['integer'];
         $values = [$userid];
 
         // delete old settings
         $ilDB->manipulateF($query, $types, $values);
 
         foreach ($configArray as $type => $channels) {
             foreach ($channels as $channel => $value) {
                 if (!$value) {
                     continue;
                 }
                 $ilDB->insert(
                     ilNotificationSetupHelper::$tbl_userconfig,
                     [
                         'usr_id' => ['integer', $userid],
                         'module' => ['text', $type],
                         'channel' => ['text', $channel],
                     ]
                 );
             }
         }
     }

◆ storeNotification()

static ILIAS\Notifications\ilNotificationDatabaseHandler::storeNotification ( ilNotificationConfig $notification )

static

Definition at line 242 of file ilNotificationDatabaseHandler.php.

References $DIC, $id, $ilDB, and ILIAS\Notifications\ilNotificationSetupHelper\$tbl_notification_data.

                                                                                 : int
     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $id = $ilDB->nextId(ilNotificationSetupHelper::$tbl_notification_data);
 
         $ilDB->insert(
             ilNotificationSetupHelper::$tbl_notification_data,
             [
                 'notification_id' => ['integer', $id],
                 'serialized' => ['text', serialize($notification)],
             ]
         );
 
         return $id;
     }

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

Services/Notifications/classes/ilNotificationDatabaseHandler.php

Static Public Member Functions

Static Protected Member Functions

Static Private Member Functions

Detailed Description

Member Function Documentation

◆ disableListeners()

◆ enableListeners()

◆ enqueueByListener()

◆ enqueueByUsers()

◆ fillPlaceholders()

◆ findPlaceholders()

◆ getAvailableChannels()

◆ getAvailableTypes()

◆ getTranslatedLanguageVariablesOfNotificationParameters()

◆ getUsersByListener()

◆ getUsersWithCustomConfig()

◆ loadUserConfig()

◆ registerChannel()

◆ registerType()

◆ removeNotification()

◆ replaceFields()

◆ setConfigTypeForChannel()

◆ setConfigTypeForType()

◆ setUserConfig()

◆ storeNotification()