ilNotificationDatabaseHandler Class Reference

Collaboration diagram for ilNotificationDatabaseHandler:

Static Public Member Functions
static	setUserConfig ($userid, array $configArray)
	Sets the configuration for all given configurations. More...
static	loadUserConfig ($userid)
static	enqueueByUsers (ilNotificationConfig $notification, array $userids)
static	enqueueByListener (ilNotificationConfig $notification, $ref_id)
static	storeNotification (ilNotificationConfig $notification)
static	removeNotification ($id)
static	getUsersByListener ($module, $sender_id)
static	disableListeners ($module, $sender_id)
static	enableListeners ($module, $sender_id, array $users=array())
static	registerChannel ($name, $title, $description, $class, $classfile, $config_type)
	Registers a new notification channel for distributing notifications. More...
static	registerType ($name, $title, $description, $notification_group, $config_type)
	Registers a new notification type. More...
static	getAvailableChannels ($config_types=array(), $includeDisabled=false)
static	getAvailableTypes ($config_types=array())
static	setConfigTypeForType ($type_name, $config_name)
static	setConfigTypeForChannel ($channel_name, $config_name)
static	getUsersWithCustomConfig (array $userid)

Static Protected Member Functions
static	fillPlaceholders ($results, $vars, $langVarToTypeDict)
static	findPlaceholders ($pattern, $translation)

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

Detailed Description

Definition at line 5 of file class.ilNotificationDatabaseHelper.php.

Member Function Documentation

disableListeners()

static ilNotificationDatabaseHandler::disableListeners (   $module,   $sender_id  )

static

Definition at line 305 of file class.ilNotificationDatabaseHelper.php.

References $DIC, $ilDB, $module, $query, ilNotificationSetupHelper\$tbl_userlistener, and $values.

Referenced by ilNotificationSystem\toListeners().

    {
        global $DIC;

        $ilDB = $DIC->database();

        $query = 'UPDATE ' . ilNotificationSetupHelper::$tbl_userlistener . ' SET disabled = 1 WHERE module = %s AND sender_id = %s';
        $types = array('text', 'integer');
        $values = array($module, $sender_id);

        $ilDB->manipulateF($query, $types, $values);
    }

Here is the caller graph for this function:

enableListeners()

static ilNotificationDatabaseHandler::enableListeners (   $module,   $sender_id, array  $users = array()  )

static

Definition at line 318 of file class.ilNotificationDatabaseHelper.php.

References $DIC, $ilDB, $module, $query, ilNotificationSetupHelper\$tbl_userlistener, $users, and $values.

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

    {
        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 = array('text', 'integer');
        $values = array($module, $sender_id);

        $ilDB->manipulateF($query, $types, $values);
    }

Here is the caller graph for this function:

enqueueByListener()

static ilNotificationDatabaseHandler::enqueueByListener ( ilNotificationConfig  $notification,   $ref_id  )

static

Definition at line 235 of file class.ilNotificationDatabaseHelper.php.

References $DIC, $ilDB, $query, ilNotificationSetupHelper\$tbl_notification_queue, ilNotificationSetupHelper\$tbl_userlistener, $values, ilNotificationConfig\getType(), ilNotificationConfig\getValidForSeconds(), ilNotificationConfig\getVisibleForSeconds(), and storeNotification().

Referenced by ilNotificationSystem\toListeners().

    {
        global $DIC;

        $ilDB = $DIC->database();

        $notification_id = ilNotificationDatabaseHandler::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 = array('integer', 'integer', 'integer', 'text', 'integer');

        $values = array($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 ilNotificationDatabaseHandler::enqueueByUsers ( ilNotificationConfig  $notification, array  $userids  )

static

Definition at line 209 of file class.ilNotificationDatabaseHelper.php.

References $DIC, $ilDB, ilNotificationSetupHelper\$tbl_notification_queue, $userid, ilNotificationConfig\getValidForSeconds(), ilNotificationConfig\getVisibleForSeconds(), and storeNotification().

Referenced by ilNotificationSystem\toUsers().

    {
        if (!$userids) {
            return;
        }

        global $DIC;

        $ilDB = $DIC->database();

        $notification_id = ilNotificationDatabaseHandler::storeNotification($notification);
        $valid_until = $notification->getValidForSeconds() ? (time() + $notification->getValidForSeconds()) : 0;

        foreach ($userids as $userid) {
            $ilDB->insert(
                ilNotificationSetupHelper::$tbl_notification_queue,
                array(
                    'notification_id' => array('integer', $notification_id),
                    'usr_id' => array('integer', $userid),
                    'valid_until' => array('integer', $valid_until),
                    'visible_for' => array('integer', $notification->getVisibleForSeconds())
                )
            );
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

fillPlaceholders()

static ilNotificationDatabaseHandler::fillPlaceholders (   $results,   $vars,   $langVarToTypeDict  )

staticprotected

Parameters

array	$results
array	$vars
array	$langVarToTypeDict

Returns

array mixed

Definition at line 60 of file class.ilNotificationDatabaseHelper.php.

References $res, and $results.

    {
        $pattern_old = '/##(.+?)##/im';
        $pattern = '/\[(.+?)\]/im';

        foreach ($results as $langVar => $res) {
            $placeholdersStack = array();
            $res->lang = array();

            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(
                    call_user_func_array('array_merge', $placeholdersStack)
                ),
                array_keys($vars[$langVarToTypeDict[$langVar]]->getParameters())
            );
        }

        return $results;
    }

findPlaceholders()

static ilNotificationDatabaseHandler::findPlaceholders (   $pattern,   $translation  )

staticprotected

Parameters

string	$pattern
string	$translation

Returns

array

Definition at line 94 of file class.ilNotificationDatabaseHelper.php.

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

getAvailableChannels()

static ilNotificationDatabaseHandler::getAvailableChannels (   $config_types = array(),   $includeDisabled = false  )

static

Definition at line 396 of file class.ilNotificationDatabaseHelper.php.

References $DIC, $ilDB, $query, $result, $row, and ilNotificationSetupHelper\$tbl_notification_channels.

Referenced by ilNotificationGUI\getAvailableChannels(), ilNotificationAdminSettingsForm\getGeneralSettingsForm(), ilObjNotificationAdminGUI\showChannelsObject(), ilObjNotificationAdminGUI\showConfigMatrixObject(), and ilNotificationSystem\toUsers().

    {
        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 = array();

        $settings = new ilSetting('notifications');

        while ($row = $ilDB->fetchAssoc($rset)) {
            if (!$includeDisabled && !$settings->get('enable_' . $row['channel_name'])) {
                continue;
            }
            
            $result[$row['channel_name']] = array(
                '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 ilNotificationDatabaseHandler::getAvailableTypes (   $config_types = array() )

static

Definition at line 431 of file class.ilNotificationDatabaseHelper.php.

References $DIC, $ilDB, $query, $result, $row, and ilNotificationSetupHelper\$tbl_notification_types.

Referenced by ilNotificationGUI\getAvailableTypes(), ilObjNotificationAdminGUI\showConfigMatrixObject(), ilObjNotificationAdminGUI\showTypesObject(), and ilNotificationSystem\toUsers().

    {
        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 = array();

        while ($row = $ilDB->fetchAssoc($rset)) {
            $result[$row['type_name']] = array(
                '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:

getUsersByListener()

static ilNotificationDatabaseHandler::getUsersByListener (   $module,   $sender_id  )

static

Definition at line 286 of file class.ilNotificationDatabaseHelper.php.

References $DIC, $ilDB, $module, $query, $row, ilNotificationSetupHelper\$tbl_userlistener, $users, and $values.

Referenced by ilNotificationSystem\toListeners().

    {
        global $DIC;

        $ilDB = $DIC->database();

        $query = 'SELECT usr_id FROM ' . ilNotificationSetupHelper::$tbl_userlistener . ' WHERE disabled = 0 AND module = %s AND sender_id = %s';
        $types = array('text', 'integer');
        $values = array($module, $sender_id);

        $users = array();

        $rset = $ilDB->queryF($query, $types, $values);
        while ($row = $ilDB->fetchAssoc($rset)) {
            $users[] = $row['usr_id'];
        }
        return $users;
    }

Here is the caller graph for this function:

getUsersWithCustomConfig()

static ilNotificationDatabaseHandler::getUsersWithCustomConfig ( array  $userid )

static

Definition at line 485 of file class.ilNotificationDatabaseHelper.php.

References $DIC, $ilDB, $query, $result, and $row.

Referenced by ilNotificationSystem\toUsers().

    {
        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 = array();
        while ($row = $ilDB->fetchAssoc($rset)) {
            $result[$row['usr_id']] = (bool) $row['value'];
        }
        return $result;
    }

Here is the caller graph for this function:

loadUserConfig()

static ilNotificationDatabaseHandler::loadUserConfig (   $userid )

static

Definition at line 184 of file class.ilNotificationDatabaseHelper.php.

References $DIC, $ilDB, $query, $res, $result, $row, ilNotificationSetupHelper\$tbl_userconfig, $userid, and $values.

Referenced by ilObjContactAdministrationGUI\saveConfigurationForm(), ilObjNotificationAdminGUI\showConfigMatrixObject(), ilObjContactAdministrationGUI\showConfigurationForm(), ilNotificationGUI\showSettingsObject(), and ilNotificationSystem\toUsers().

    {
        global $DIC;

        $ilDB = $DIC->database();

        $query = 'SELECT module, channel FROM ' . ilNotificationSetupHelper::$tbl_userconfig . ' WHERE usr_id = %s';
        $types = array('integer');
        $values = array($userid);

        $res = $ilDB->queryF($query, $types, $values);

        $result = array();

        while ($row = $ilDB->fetchAssoc($res)) {
            if (!$result[$row['module']]) {
                $result[$row['module']] = array();
            }

            $result[$row['module']][] = $row['channel'];
        }

        return $result;
    }

Here is the caller graph for this function:

registerChannel()

static ilNotificationDatabaseHandler::registerChannel (   $name,   $title,   $description,   $class,   $classfile,   $config_type  )

static

Registers a new notification channel for distributing notifications.

ilDB $ilDB

Parameters

type	$name	technical name of the type
type	$title	human readable title for configuration guis
type	$description	not yet used human readable description
type	$class	class name of the handler class
type	$classfile	class file location of the handler class
type	$config_type	'set_by_user' or 'set_by_admin'; restricts if users can override the configuartion for this channel

Definition at line 348 of file class.ilNotificationDatabaseHelper.php.

References $description, $DIC, $ilDB, $name, ilNotificationSetupHelper\$tbl_notification_channels, and $title.

Referenced by ilNotificationSetupHelper\registerChannel().

    {
        global $DIC;

        $ilDB = $DIC->database();

        $ilDB->insert(
            ilNotificationSetupHelper::$tbl_notification_channels,
            array(
                    'channel_name' => array('text', $name),
                    'title' => array('text', $title),
                    'description' => array('text', $description),
                    'class' => array('text', $class),
                    'include' => array('text', $classfile),
                    'config_type' => array('text', $config_type),
                )
        );
    }

Here is the caller graph for this function:

registerType()

static ilNotificationDatabaseHandler::registerType (   $name,   $title,   $description,   $notification_group,   $config_type  )

static

Registers a new notification type.

ilDB $ilDB

Parameters

string	$name	technical name of the type
string	$title	human readable title for configuration guis
string	$description	not yet used human readable description
string	$notification_group	not yet used group
string	$config_type	'set_by_user' or 'set_by_admin'; restricts if users can override the configuartion for this type

Definition at line 378 of file class.ilNotificationDatabaseHelper.php.

References $description, $DIC, $ilDB, $name, ilNotificationSetupHelper\$tbl_notification_types, and $title.

Referenced by ilNotificationSetupHelper\registerType().

    {
        global $DIC;

        $ilDB = $DIC->database();

        $ilDB->insert(
            ilNotificationSetupHelper::$tbl_notification_types,
            array(
                    'type_name' => array('text', $name),
                    'title' => array('text', $title),
                    'description' => array('text', $description),
                    'notification_group' => array('text', $notification_group),
                    'config_type' => array('text', $config_type),
                )
        );
    }

Here is the caller graph for this function:

removeNotification()

static ilNotificationDatabaseHandler::removeNotification (   $id )

static

Definition at line 273 of file class.ilNotificationDatabaseHelper.php.

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

    {
        global $DIC;

        $ilDB = $DIC->database();

        $query = 'DELETE FROM ' . ilNotificationSetupHelper::$tbl_notification_data . ' WHERE notification_id = ?';
        $types = array('integer');
        $values = array($id);

        $ilDB->manipulateF($query, $types, $values);
    }

replaceFields()

static ilNotificationDatabaseHandler::replaceFields (   $string,   $foundPlaceholders,   $params,   $startTag,   $endTage  )

staticprivate

Parameters

string	$string
array	$foundPlaceholders
array	$params
string	$startTag
string	$endTag

Returns

string

Definition at line 110 of file class.ilNotificationDatabaseHelper.php.

References PHPMailer\PHPMailer\$params.

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

setConfigTypeForChannel()

static ilNotificationDatabaseHandler::setConfigTypeForChannel (   $channel_name,   $config_name  )

static

Definition at line 472 of file class.ilNotificationDatabaseHelper.php.

References $DIC, $ilDB, $query, ilNotificationSetupHelper\$tbl_notification_channels, and $values.

Referenced by ilObjNotificationAdminGUI\saveChannelsObject(), and ilObjNotificationAdminGUI\saveGeneralSettingsObject().

    {
        global $DIC;

        $ilDB = $DIC->database();

        $query = 'UPDATE ' . ilNotificationSetupHelper::$tbl_notification_channels . ' SET config_type = %s WHERE channel_name = %s';
        $types = array('text', 'text');
        $values = array($config_name, $channel_name);
        $ilDB->manipulateF($query, $types, $values);
    }

Here is the caller graph for this function:

setConfigTypeForType()

static ilNotificationDatabaseHandler::setConfigTypeForType (   $type_name,   $config_name  )

static

Definition at line 460 of file class.ilNotificationDatabaseHelper.php.

References $DIC, $ilDB, $query, ilNotificationSetupHelper\$tbl_notification_types, and $values.

Referenced by ilObjNotificationAdminGUI\saveTypesObject().

    {
        global $DIC;

        $ilDB = $DIC->database();

        $query = 'UPDATE ' . ilNotificationSetupHelper::$tbl_notification_types . ' SET config_type = %s WHERE type_name = %s';
        $types = array('text', 'text');
        $values = array($config_name, $type_name);
        $ilDB->manipulateF($query, $types, $values);
    }

Here is the caller graph for this function:

setUserConfig()

static ilNotificationDatabaseHandler::setUserConfig (   $userid, array  $configArray  )

static

Sets the configuration for all given configurations.

Old configurations are completly removed before the new are inserted.

structure of $configArray

array( 'chat_invitation' => array( 'mail' => true, 'osd' => false ), 'adobeconnect_invitation' => array( 'mail' => true, 'osd' => true ), );

If the userid is -1, the settings are stored as general settings (default values or used if configuration type is set_by_admin).

ilDB $ilDB

Parameters

int	$userid
array	$configArray

Definition at line 147 of file class.ilNotificationDatabaseHelper.php.

References $DIC, $ilDB, $query, ilNotificationSetupHelper\$tbl_userconfig, $type, $userid, and $values.

Referenced by ilObjNotificationAdminGUI\saveConfigMatrixObject(), ilObjContactAdministrationGUI\saveConfigurationForm(), and ilNotificationGUI\saveSettingsObject().

    {
        global $DIC;

        $ilDB = $DIC->database();

        if ($userid != -1) {
            $channels = self::getAvailableChannels(array('set_by_user'));
            $types = self::getAvailableTypes(array('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 = array('integer');
        $values = array($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,
                    array(
                            'usr_id' => array('integer', $userid),
                            'module' => array('text', $type),
                            'channel' => array('text', $channel),
                        )
                );
            }
        }
    }

Here is the caller graph for this function:

storeNotification()

static ilNotificationDatabaseHandler::storeNotification ( ilNotificationConfig  $notification )

static

Definition at line 254 of file class.ilNotificationDatabaseHelper.php.

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

Referenced by enqueueByListener(), and enqueueByUsers().

    {
        global $DIC;

        $ilDB = $DIC->database();

        $id = $ilDB->nextId(ilNotificationSetupHelper::$tbl_notification_data);

        $ilDB->insert(
            ilNotificationSetupHelper::$tbl_notification_data,
            array(
                    'notification_id' => array('integer', $id),
                    'serialized' => array('text', serialize($notification)),
                )
        );

        return $id;
    }

Here is the caller graph for this function:

---

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

• Services/Notifications/classes/class.ilNotificationDatabaseHelper.php