Collaboration diagram for ilChatroomAdmin:

Public Member Functions
	__construct (private readonly int $config_id, private readonly ?stdClass $settings=null)

	getServerSettings ()
	Instantiates ilChatroomServerSettings object, sets data using $this->settings->server_settings and returns object. More...

	saveGeneralSettings (stdClass $settings)
	Saves given $settings into settingsTable. More...

	saveClientSettings (stdClass $settings)
	Saves given client $settings into settingsTable. More...

	loadGeneralSettings ()

	loadClientSettings ()

Static Public Member Functions
static	getDefaultConfiguration ()
	Instantiates and returns ilChatroomAdmin object using instance_id and settings from settingsTable. More...

Static Private Attributes
static string	$settingsTable = 'chatroom_admconfig'

Detailed Description

Class ilChatroomAdmin.

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

Version: $Id$ \

Definition at line 27 of file class.ilChatroomAdmin.php.

Constructor & Destructor Documentation

◆ __construct()

ilChatroomAdmin::__construct	(	private readonly int	$config_id,
		private readonly ?stdClass	$settings = `null`
	)

Definition at line 31 of file class.ilChatroomAdmin.php.

32 {

33 }

Member Function Documentation

◆ getDefaultConfiguration()

static ilChatroomAdmin::getDefaultConfiguration ( )

static

Instantiates and returns ilChatroomAdmin object using instance_id and settings from settingsTable.

Returns: self

Definition at line 40 of file class.ilChatroomAdmin.php.

                                                    : self
    {
        global $DIC;
 
        $DIC->database()->setLimit(1);
        $query = 'SELECT * FROM ' . self::$settingsTable;
 
        $rset = $DIC->database()->query($query);
        if ($row = $DIC->database()->fetchObject($rset)) {
            return new self((int) $row->instance_id, $row);
        }
 
        throw new LogicException('Could not determine any default configuration');
    }

References $DIC, $settingsTable, and ILIAS\Repository\int().

Referenced by ilChatroomServerConnector\checkServerConnection(), ilObjChatroom\cloneObject(), ilObjChatroomGUI\getConnector(), and ILIAS\Chatroom\UserSettings\AllowOnScreenChatConversations\updateChatServer().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getServerSettings()

ilChatroomAdmin::getServerSettings ( )

Instantiates ilChatroomServerSettings object, sets data using $this->settings->server_settings and returns object.

Returns: ilChatroomServerSettings

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

                                       : ilChatroomServerSettings
    {
        return ilChatroomServerSettings::loadDefault();
    }

References ilChatroomServerSettings\loadDefault().

Here is the call graph for this function:

◆ loadClientSettings()

ilChatroomAdmin::loadClientSettings ( )

Definition at line 177 of file class.ilChatroomAdmin.php.

                                        : array
    {
        global $DIC;
 
        $query = 'SELECT * FROM ' . self::$settingsTable .
            ' WHERE instance_id = ' . $DIC->database()->quote($this->config_id, 'integer');
        if (($row = $DIC->database()->fetchAssoc($DIC->database()->query($query))) && $row['client_settings']) {
            $settings = json_decode($row['client_settings'], true, 512, JSON_THROW_ON_ERROR);
 
            if (!isset($settings['client']) || !is_string($settings['client']) || $settings['client'] === '') {
                $settings['client'] = CLIENT_ID;
            }
 
            if (is_string($settings['name'] ?? null) && $settings['name']) {
                $settings['client_name'] = $settings['name'];
            } else {
                $settings['client_name'] = CLIENT_ID;
            }
 
            if (isset($settings['conversation_idle_state_in_minutes']) && is_numeric($settings['conversation_idle_state_in_minutes'])) {
                $settings['conversation_idle_state_in_minutes'] = max(1, $settings['conversation_idle_state_in_minutes']);
            } else {
                $settings['conversation_idle_state_in_minutes'] = 1;
            }
 
            if (!isset($settings['auth']) || !is_array($settings['auth'])) {
                $settings['auth'] = [];
            }
            if (!isset($settings['auth']['key']) || !is_string($settings['auth']['key'])) {
                $settings['auth']['key'] = '';
            }
            if (!isset($settings['auth']['secret']) || !is_string($settings['auth']['secret'])) {
                $settings['auth']['secret'] = '';
            }
 
            return $settings;
        }
 
        return [];
    }

References $DIC, and CLIENT_ID.

◆ loadGeneralSettings()

ilChatroomAdmin::loadGeneralSettings ( )

Definition at line 153 of file class.ilChatroomAdmin.php.

                                         : array
    {
        global $DIC;
 
        $query = 'SELECT * FROM ' . self::$settingsTable .
            ' WHERE instance_id = ' . $DIC->database()->quote($this->config_id, 'integer');
 
        if (($row = $DIC->database()->fetchAssoc($DIC->database()->query($query))) && $row['server_settings']) {
            $settings = json_decode($row['server_settings'], true, 512, JSON_THROW_ON_ERROR);
 
            if (!isset($settings['protocol'])) {
                $settings['protocol'] = 'http';
            }
 
            if (!isset($settings['log_level'])) {
                $settings['log_level'] = 'info';
            }
 
            return $settings;
        }
 
        return [];
    }

References $DIC.

◆ saveClientSettings()

ilChatroomAdmin::saveClientSettings ( stdClass $settings )

Saves given client $settings into settingsTable.

Definition at line 112 of file class.ilChatroomAdmin.php.

                                                          : void
    {
        global $DIC;
 
        $res = $DIC->database()->queryF(
            "SELECT * FROM chatroom_admconfig WHERE instance_id = %s",
            ['integer'],
            [$this->config_id]
        );
 
        $row = $DIC->database()->fetchAssoc($res);
 
        $DIC->database()->manipulateF(
            "DELETE FROM chatroom_admconfig WHERE instance_id = %s",
            ['integer'],
            [$this->config_id]
        );
 
        ($row['default_config'] ?? null) !== null ? $def_conf = $row['default_config'] : $def_conf = "{}";
        ($row['server_settings'] ?? null) !== null ? $srv_set = $row['server_settings'] : $srv_set = "{}";
 
        $DIC->database()->manipulateF(
            "
                        INSERT INTO             chatroom_admconfig
                                                        (instance_id, server_settings, default_config, client_settings)
                        VALUES                  (%s, %s, %s, %s)",
            [
                'integer',
                'text',
                'integer',
                'text'
            ],
            [
                $this->config_id,
                $srv_set,
                $def_conf,
                json_encode($settings, JSON_THROW_ON_ERROR)
            ]
        );
    }

References $DIC, and $res.

◆ saveGeneralSettings()

ilChatroomAdmin::saveGeneralSettings ( stdClass $settings )

Saves given $settings into settingsTable.

Parameters

stdClass $settings

Definition at line 69 of file class.ilChatroomAdmin.php.

                                                           : void
    {
        global $DIC;
 
        $res = $DIC->database()->queryF(
            "SELECT* FROM chatroom_admconfig WHERE instance_id = %s",
            ['integer'],
            [$this->config_id]
        );
 
        $row = $DIC->database()->fetchAssoc($res);
 
        $DIC->database()->manipulateF(
            "DELETE FROM chatroom_admconfig WHERE instance_id = %s",
            ['integer'],
            [$this->config_id]
        );
 
        $def_conf = '{}';
        $clnt_set = '{}';
        if (is_array($row)) {
            if ($row['default_config'] !== null) {
                $def_conf = $row['default_config'];
            }
 
            if ($row['client_settings'] !== null) {
                $clnt_set = $row['client_settings'];
            }
        }
 
        $DIC->database()->manipulateF(
            "
                        INSERT INTO             chatroom_admconfig
                                                        (instance_id, server_settings, default_config, client_settings)
                        VALUES                  (%s, %s, %s, %s)",
            ['integer', 'text', 'integer', 'text'],
            [$this->config_id, json_encode($settings, JSON_THROW_ON_ERROR), $def_conf, $clnt_set]
        );
    }

References $DIC, and $res.

Field Documentation

◆ $settingsTable

string ilChatroomAdmin::$settingsTable = 'chatroom_admconfig'

staticprivate

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

Referenced by getDefaultConfiguration().

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

components/ILIAS/Chatroom/classes/class.ilChatroomAdmin.php

Public Member Functions

Static Public Member Functions

Static Private Attributes