Collaboration diagram for ILIAS\Notifications\ilNotificationSetupHelper:

Static Public Member Functions
static	setupTables ()

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

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

Static Public Attributes
static string	$tbl_userconfig = 'notification_usercfg'

static string	$tbl_userlistener = 'notification_listener'

static string	$tbl_notification_data = 'notification_data'

static string	$tbl_notification_queue = 'notification_queue'

static string	$tbl_notification_osd_handler = 'notification_osd'

static string	$tbl_notification_channels = 'notification_channels'

static string	$tbl_notification_types = 'notification_types'

Detailed Description

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

Definition at line 28 of file ilNotificationSetupHelper.php.

Member Function Documentation

◆ registerChannel()

static ILIAS\Notifications\ilNotificationSetupHelper::registerChannel	(	ilDBInterface	$db,
		string	$name,
		string	$title,
		string	$description,
		string	$class,
		string	$classfile,
		string	$config_type = `'set_by_user'`
	)

static

Definition at line 135 of file ilNotificationSetupHelper.php.

                                                                                                                                                                                      : void
    {
        ilNotificationDatabaseHandler::registerChannel($db, $name, $title, $description, $class, $classfile, $config_type);
    }

References ILIAS\$db, $name, and ILIAS\Notifications\ilNotificationDatabaseHandler\registerChannel().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ registerType()

static ILIAS\Notifications\ilNotificationSetupHelper::registerType	(	ilDBInterface	$db,
		string	$name,
		string	$title,
		string	$description,
		string	$notification_group,
		string	$config_type = `'set_by_user'`
	)

static

Definition at line 140 of file ilNotificationSetupHelper.php.

                                                                                                                                                                             : void
    {
        ilNotificationDatabaseHandler::registerType($db, $name, $title, $description, $notification_group, $config_type);
    }

References ILIAS\$db, $name, and ILIAS\Notifications\ilNotificationDatabaseHandler\registerType().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setupTables()

static ILIAS\Notifications\ilNotificationSetupHelper::setupTables ( )

static

Definition at line 38 of file ilNotificationSetupHelper.php.

                                        : void
    {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        if (!$ilDB->tableExists(self::$tbl_userconfig)) {
            $fields = array(
                'usr_id' => array('type' => 'integer', 'notnull' => true, 'length' => 4),
                'module' => array('type' => 'text'   , 'notnull' => true, 'length' => 100),
                'channel' => array('type' => 'text'   , 'notnull' => true, 'length' => 100),
            );
            $ilDB->createTable(self::$tbl_userconfig, $fields);
            $ilDB->addPrimaryKey(self::$tbl_userconfig, array('usr_id', 'module', 'channel'));
        }
 
        if (!$ilDB->tableExists(self::$tbl_userlistener)) {
            $fields = array(
                'usr_id' => array('type' => 'integer', 'notnull' => true, 'length' => 4),
                'module' => array('type' => 'text'   , 'notnull' => true, 'length' => 100),
                'sender_id' => array('type' => 'integer', 'notnull' => true, 'length' => 4),
                'disabled' => array('type' => 'integer', 'notnull' => true, 'length' => 1),
            );
            $ilDB->createTable(self::$tbl_userlistener, $fields);
            $ilDB->addPrimaryKey(self::$tbl_userlistener, array('usr_id', 'module', 'sender_id'));
        }
 
        if (!$ilDB->tableExists(self::$tbl_notification_data)) {
            $fields = array(
                'notification_id' => array('type' => 'integer', 'notnull' => true, 'length' => 4),
                'serialized' => array('type' => 'text'   , 'notnull' => true, 'length' => 4000),
            );
            $ilDB->createTable(self::$tbl_notification_data, $fields);
            $ilDB->addPrimaryKey(self::$tbl_notification_data, array('notification_id'));
 
            $ilDB->createSequence(self::$tbl_notification_data);
        }
 
        if (!$ilDB->tableExists(self::$tbl_notification_queue)) {
            $fields = array(
                'notification_id' => array('type' => 'integer'  , 'notnull' => true, 'length' => 4),
                'usr_id' => array('type' => 'integer'  , 'notnull' => true, 'length' => 4),
                'valid_until' => array('type' => 'integer'  , 'notnull' => true, 'length' => 4),
            );
            $ilDB->createTable(self::$tbl_notification_queue, $fields);
            $ilDB->addPrimaryKey(self::$tbl_notification_queue, array('notification_id', 'usr_id'));
        }
 
        if (!$ilDB->tableExists(self::$tbl_notification_osd_handler)) {
            $fields = array(
                'notification_osd_id' => array('type' => 'integer'  , 'notnull' => true, 'length' => 4),
                'usr_id' => array('type' => 'integer'  , 'notnull' => true, 'length' => 4),
                'serialized' => array('type' => 'text'     , 'notnull' => true, 'length' => 4000),
                'valid_until' => array('type' => 'integer'  , 'notnull' => true, 'length' => 4),
                'time_added' => array('type' => 'integer'  , 'notnull' => true, 'length' => 4),
                'type' => array('type' => 'text'     , 'notnull' => true, 'length' => 100),
            );
            $ilDB->createTable(self::$tbl_notification_osd_handler, $fields);
 
            $ilDB->addPrimaryKey(self::$tbl_notification_osd_handler, array('notification_osd_id'));
 
            $ilDB->createSequence(self::$tbl_notification_osd_handler);
        }
 
        if (!$ilDB->tableExists(self::$tbl_notification_channels)) {
            $fields = array(
                'channel_name' => array('type' => 'text', 'notnull' => true, 'length' => 100),
                'title' => array('type' => 'text', 'notnull' => true, 'length' => 100),
                'description' => array('type' => 'text', 'notnull' => true, 'length' => 4000),
                'class' => array('type' => 'text', 'notnull' => true, 'length' => 100),
                'include' => array('type' => 'text', 'notnull' => true, 'length' => 100),
                'config_type' => array('type' => 'text', 'notnull' => true, 'length' => 30),
            );
            $ilDB->createTable(self::$tbl_notification_channels, $fields);
 
            $ilDB->addPrimaryKey(self::$tbl_notification_channels, array('channel_name'));
 
            self::registerChannel($ilDB, 'mail', 'mail', 'mail_desc', 'ilNotificationMailHandler', 'Services/Notifications/classes/class.ilNotificationMailHandler.php');
            self::registerChannel($ilDB, 'osd', 'osd', 'osd_desc', 'ilNotificationOSDHandler', 'Services/Notifications/classes/class.ilNotificationOSDHandler.php');
        }
 
        if (!$ilDB->tableExists(self::$tbl_notification_types)) {
            $fields = array(
                'type_name' => array('type' => 'text', 'notnull' => true, 'length' => 100),
                'title' => array('type' => 'text', 'notnull' => true, 'length' => 100),
                'description' => array('type' => 'text', 'notnull' => true, 'length' => 100),
                'notification_group' => array('type' => 'text', 'notnull' => true, 'length' => 100),
                'config_type' => array('type' => 'text', 'notnull' => true, 'length' => 30),
            );
            $ilDB->createTable(self::$tbl_notification_types, $fields);
            $ilDB->addPrimaryKey(self::$tbl_notification_types, array('type_name'));
 
            self::registerType($ilDB, 'chat_invitation', 'chat_invitation', 'chat_invitation_description', 'chat');
            self::registerType($ilDB, 'osd_maint', 'osd_maint', 'osd_maint_description', 'osd_notification');
        }
    }