Collaboration diagram for ilChatroomServerSettings:

Public Member Functions
	getURL (string $action, $scope=null)
	Creates URL by calling $this->getBaseURL and using given $action and $scope and returns it. More...

	generateIliasUrl ()

	getIliasUrlEnabled ()

	setIliasUrlEnabled (bool $iliasUrlEnabled)

	getProtocol ()

	setProtocol (string $protocol)

	getIliasUrl ()

	setIliasUrl (string $iliasUrl)

	getBaseURL ()
	Creates base URL by calling $this->getProtocol(), $this->getDomain() and $this->getPort() and returnes it. More...

	getDomain ()

	setDomain (string $domain)

	getPort ()

	setPort (int $port)

	getInstance ()

	setInstance (string $instance)

	generateClientUrl ()

	getClientUrlEnabled ()

	setClientUrlEnabled (bool $clientUrlEnabled)

	getClientUrl ()

	setClientUrl (string $clientUrl)

	getAuthKey ()

	setAuthKey (string $authKey)

	getAuthSecret ()

	setAuthSecret (string $authSecret)

	getSubDirectory ()

	setSubDirectory (string $subDirectory)

Static Public Member Functions
static	loadDefault ()

Data Fields
final const string	PREFIX = '/backend'

Private Attributes
const int	DEFAULT_PORT = 8585

const string	DEFAULT_PROCOTOL = 'http://'

const string	DEFAULT_HOST = '192.168.1.94'

int	$port = self::DEFAULT_PORT

string	$protocol = self::DEFAULT_PROCOTOL

string	$domain = self::DEFAULT_HOST

string	$instance = '123456'

string	$authKey = ''

string	$authSecret = ''

bool	$clientUrlEnabled = false

string	$clientUrl = ''

bool	$iliasUrlEnabled = false

string	$iliasUrl = ''

string	$subDirectory = ''

Detailed Description

Class ilChatroomServerSettings.

Author: Andreas Kordosz akord.nosp@m.osz@.nosp@m.datab.nosp@m.ay.d.nosp@m.e

Version: $Id$ \

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

Member Function Documentation

◆ generateClientUrl()

ilChatroomServerSettings::generateClientUrl ( )

Definition at line 180 of file class.ilChatroomServerSettings.php.

                                       : string
    {
        if ($this->getClientUrlEnabled()) {
            $url = $this->getClientUrl();
 
            if (!str_contains($url, '://')) {
                $url = $this->getProtocol() . $url;
            }
 
            return $url;
        }
        return $this->getBaseURL();
    }

References $url, getBaseURL(), getClientUrl(), getClientUrlEnabled(), and getProtocol().

Here is the call graph for this function:

◆ generateIliasUrl()

ilChatroomServerSettings::generateIliasUrl ( )

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

                                      : string
    {
        if ($this->getIliasUrlEnabled()) {
            $url = $this->getIliasUrl();
 
            if (!str_contains($url, '://')) {
                $url = $this->getProtocol() . $url;
            }
 
            return $url;
        }
 
        return $this->getBaseURL();
    }

References $url, getBaseURL(), getIliasUrl(), getIliasUrlEnabled(), and getProtocol().

Referenced by getURL().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAuthKey()

ilChatroomServerSettings::getAuthKey ( )

Definition at line 214 of file class.ilChatroomServerSettings.php.

                                : string
    {
        return $this->authKey;
    }

References $authKey.

◆ getAuthSecret()

ilChatroomServerSettings::getAuthSecret ( )

Definition at line 224 of file class.ilChatroomServerSettings.php.

                                   : string
    {
        return $this->authSecret;
    }

References $authSecret.

◆ getBaseURL()

ilChatroomServerSettings::getBaseURL ( )

Creates base URL by calling $this->getProtocol(), $this->getDomain() and $this->getPort() and returnes it.

Definition at line 145 of file class.ilChatroomServerSettings.php.

                                : string
    {
        return $this->getProtocol() . $this->getDomain() . ':' . $this->getPort();
    }

References getDomain(), getPort(), and getProtocol().

Referenced by generateClientUrl(), and generateIliasUrl().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getClientUrl()

ilChatroomServerSettings::getClientUrl ( )

Definition at line 204 of file class.ilChatroomServerSettings.php.

                                  : string
    {
        return $this->clientUrl;
    }

References $clientUrl.

Referenced by generateClientUrl().

Here is the caller graph for this function:

◆ getClientUrlEnabled()

ilChatroomServerSettings::getClientUrlEnabled ( )

Definition at line 194 of file class.ilChatroomServerSettings.php.

                                         : bool
    {
        return $this->clientUrlEnabled;
    }

References $clientUrlEnabled.

Referenced by generateClientUrl().

Here is the caller graph for this function:

◆ getDomain()

ilChatroomServerSettings::getDomain ( )

Definition at line 150 of file class.ilChatroomServerSettings.php.

                               : string
    {
        return $this->domain;
    }

References $domain.

Referenced by getBaseURL().

Here is the caller graph for this function:

◆ getIliasUrl()

ilChatroomServerSettings::getIliasUrl ( )

Definition at line 131 of file class.ilChatroomServerSettings.php.

                                 : string
    {
        return $this->iliasUrl;
    }

References $iliasUrl.

Referenced by generateIliasUrl().

Here is the caller graph for this function:

◆ getIliasUrlEnabled()

ilChatroomServerSettings::getIliasUrlEnabled ( )

Definition at line 109 of file class.ilChatroomServerSettings.php.

                                        : bool
    {
        return $this->iliasUrlEnabled;
    }

References $iliasUrlEnabled.

Referenced by generateIliasUrl().

Here is the caller graph for this function:

◆ getInstance()

ilChatroomServerSettings::getInstance ( )

Definition at line 170 of file class.ilChatroomServerSettings.php.

                                 : string
    {
        return $this->instance;
    }

References $instance.

Referenced by getURL().

Here is the caller graph for this function:

◆ getPort()

ilChatroomServerSettings::getPort ( )

Definition at line 160 of file class.ilChatroomServerSettings.php.

                             : int
    {
        return $this->port;
    }

References $port.

Referenced by getBaseURL().

Here is the caller graph for this function:

◆ getProtocol()

ilChatroomServerSettings::getProtocol ( )

Definition at line 119 of file class.ilChatroomServerSettings.php.

                                 : string
    {
        return $this->protocol;
    }

References $protocol.

Referenced by generateClientUrl(), generateIliasUrl(), and getBaseURL().

Here is the caller graph for this function:

◆ getSubDirectory()

ilChatroomServerSettings::getSubDirectory ( )

Definition at line 234 of file class.ilChatroomServerSettings.php.

                                     : string
    {
        return $this->subDirectory;
    }

References $subDirectory.

◆ getURL()

ilChatroomServerSettings::getURL	(	string	$action,
			$scope = `null`
	)

Creates URL by calling $this->getBaseURL and using given $action and $scope and returns it.

Parameters

string | int | null $scope

Definition at line 83 of file class.ilChatroomServerSettings.php.

                                                         : string
    {
        $url = $this->generateIliasUrl() . self::PREFIX . '/' . $action . '/' . $this->getInstance();
 
        if ($scope !== null) {
            $url .= '/' . $scope;
        }
 
        return $url;
    }

References $scope, $url, generateIliasUrl(), and getInstance().

Here is the call graph for this function:

◆ loadDefault()

static ilChatroomServerSettings::loadDefault ( )

static

Definition at line 46 of file class.ilChatroomServerSettings.php.

                                        : self
    {
        global $DIC;
 
        $query = 'SELECT * FROM chatroom_admconfig';
        $rset = $DIC->database()->query($query);
        $row = $DIC->database()->fetchAssoc($rset);
 
        $client_settings = json_decode($row['client_settings'], false, 512, JSON_THROW_ON_ERROR);
        $server_settings = json_decode($row['server_settings'], false, 512, JSON_THROW_ON_ERROR);
 
        $settings = new self();
        if ($server_settings instanceof stdClass) {
            $settings->setPort((int) ($server_settings->port ?? self::DEFAULT_PORT));
            $settings->setProtocol((string) ($server_settings->protocol ?? self::DEFAULT_PROCOTOL));
            $settings->setDomain((string) ($server_settings->address ?? self::DEFAULT_HOST));
            $settings->setClientUrlEnabled((bool) ($server_settings->client_proxy ?? false));
            $settings->setIliasUrlEnabled((bool) ($server_settings->ilias_proxy ?? false));
            $settings->setClientUrl((string) ($server_settings->client_url ?? ''));
            $settings->setIliasUrl((string) ($server_settings->ilias_url ?? ''));
            $settings->setSubDirectory((string) ($server_settings->sub_directory ?? ''));
        }
 
        if ($client_settings instanceof stdClass) {
            $settings->setInstance((string) ($client_settings->name ?? ''));
            $settings->setAuthKey((string) ($client_settings->auth->key ?? ''));
            $settings->setAuthSecret((string) ($client_settings->auth->secret ?? ''));
        }
 
        return $settings;
    }

References $DIC, DEFAULT_HOST, DEFAULT_PORT, and DEFAULT_PROCOTOL.

Referenced by ilObjChatroomAdminGUI\getConnector(), ilChatroomAdmin\getServerSettings(), and ilOnScreenChatGUI\initializeFrontend().

Here is the caller graph for this function:

◆ setAuthKey()

ilChatroomServerSettings::setAuthKey ( string $authKey )

Definition at line 219 of file class.ilChatroomServerSettings.php.

                                               : void
    {
        $this->authKey = $authKey;
    }

References $authKey.

◆ setAuthSecret()

ilChatroomServerSettings::setAuthSecret ( string $authSecret )

Definition at line 229 of file class.ilChatroomServerSettings.php.

                                                     : void
    {
        $this->authSecret = $authSecret;
    }

References $authSecret.

◆ setClientUrl()

ilChatroomServerSettings::setClientUrl ( string $clientUrl )

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

                                                   : void
    {
        $this->clientUrl = $clientUrl;
    }

References $clientUrl.

◆ setClientUrlEnabled()

ilChatroomServerSettings::setClientUrlEnabled ( bool $clientUrlEnabled )

Definition at line 199 of file class.ilChatroomServerSettings.php.

                                                               : void
    {
        $this->clientUrlEnabled = $clientUrlEnabled;
    }

References $clientUrlEnabled.

◆ setDomain()

ilChatroomServerSettings::setDomain ( string $domain )

Definition at line 155 of file class.ilChatroomServerSettings.php.

                                             : void
    {
        $this->domain = $domain;
    }

References $domain.

◆ setIliasUrl()

ilChatroomServerSettings::setIliasUrl ( string $iliasUrl )

Definition at line 136 of file class.ilChatroomServerSettings.php.

                                                 : void
    {
        $this->iliasUrl = $iliasUrl;
    }

References $iliasUrl.

◆ setIliasUrlEnabled()

ilChatroomServerSettings::setIliasUrlEnabled ( bool $iliasUrlEnabled )

Definition at line 114 of file class.ilChatroomServerSettings.php.

                                                             : void
    {
        $this->iliasUrlEnabled = $iliasUrlEnabled;
    }

References $iliasUrlEnabled.

◆ setInstance()

ilChatroomServerSettings::setInstance ( string $instance )

Definition at line 175 of file class.ilChatroomServerSettings.php.

                                                 : void
    {
        $this->instance = $instance;
    }

References $instance.

◆ setPort()

ilChatroomServerSettings::setPort ( int $port )

Definition at line 165 of file class.ilChatroomServerSettings.php.

                                      : void
    {
        $this->port = $port;
    }

References $port.

◆ setProtocol()

ilChatroomServerSettings::setProtocol ( string $protocol )

Definition at line 124 of file class.ilChatroomServerSettings.php.

                                                 : void
    {
        if (!str_contains($protocol, '://')) {
            $this->protocol = $protocol . '://';
        }
    }

References $protocol.

◆ setSubDirectory()

ilChatroomServerSettings::setSubDirectory ( string $subDirectory )

Definition at line 239 of file class.ilChatroomServerSettings.php.

                                                         : void
    {
        $this->subDirectory = $subDirectory;
    }

References $subDirectory.

Field Documentation

◆ $authKey

string ilChatroomServerSettings::$authKey = ''

private

Definition at line 38 of file class.ilChatroomServerSettings.php.

Referenced by getAuthKey(), and setAuthKey().

◆ $authSecret

string ilChatroomServerSettings::$authSecret = ''

private

Definition at line 39 of file class.ilChatroomServerSettings.php.

Referenced by getAuthSecret(), and setAuthSecret().

◆ $clientUrl

string ilChatroomServerSettings::$clientUrl = ''

private

Definition at line 41 of file class.ilChatroomServerSettings.php.

Referenced by getClientUrl(), and setClientUrl().

◆ $clientUrlEnabled

bool ilChatroomServerSettings::$clientUrlEnabled = false

private

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

Referenced by getClientUrlEnabled(), and setClientUrlEnabled().

◆ $domain

string ilChatroomServerSettings::$domain = self::DEFAULT_HOST

private

Definition at line 36 of file class.ilChatroomServerSettings.php.

Referenced by getDomain(), and setDomain().

◆ $iliasUrl

string ilChatroomServerSettings::$iliasUrl = ''

private

Definition at line 43 of file class.ilChatroomServerSettings.php.

Referenced by getIliasUrl(), and setIliasUrl().

◆ $iliasUrlEnabled

bool ilChatroomServerSettings::$iliasUrlEnabled = false

private

Definition at line 42 of file class.ilChatroomServerSettings.php.

Referenced by getIliasUrlEnabled(), and setIliasUrlEnabled().

◆ $instance

string ilChatroomServerSettings::$instance = '123456'

private

Definition at line 37 of file class.ilChatroomServerSettings.php.

Referenced by getInstance(), and setInstance().

◆ $port

int ilChatroomServerSettings::$port = self::DEFAULT_PORT

private

Definition at line 34 of file class.ilChatroomServerSettings.php.

Referenced by getPort(), and setPort().

◆ $protocol

string ilChatroomServerSettings::$protocol = self::DEFAULT_PROCOTOL

private

Definition at line 35 of file class.ilChatroomServerSettings.php.

Referenced by getProtocol(), and setProtocol().

◆ $subDirectory

string ilChatroomServerSettings::$subDirectory = ''

private

Definition at line 44 of file class.ilChatroomServerSettings.php.

Referenced by getSubDirectory(), and setSubDirectory().

◆ DEFAULT_HOST

const string ilChatroomServerSettings::DEFAULT_HOST = '192.168.1.94'

private

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

Referenced by loadDefault().

◆ DEFAULT_PORT

const int ilChatroomServerSettings::DEFAULT_PORT = 8585

private

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

Referenced by loadDefault().

◆ DEFAULT_PROCOTOL

const string ilChatroomServerSettings::DEFAULT_PROCOTOL = 'http://'

private

Definition at line 30 of file class.ilChatroomServerSettings.php.

Referenced by loadDefault().

◆ PREFIX

final const string ilChatroomServerSettings::PREFIX = '/backend'

Definition at line 32 of file class.ilChatroomServerSettings.php.

Referenced by ilChatroomServerSettingsTest\testGetUrl().

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

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

Public Member Functions

Static Public Member Functions

Data Fields

Private Attributes

Detailed Description

Member Function Documentation

◆ generateClientUrl()

◆ generateIliasUrl()

◆ getAuthKey()

◆ getAuthSecret()

◆ getBaseURL()

◆ getClientUrl()

◆ getClientUrlEnabled()

◆ getDomain()

◆ getIliasUrl()

◆ getIliasUrlEnabled()

◆ getInstance()

◆ getPort()

◆ getProtocol()

◆ getSubDirectory()

◆ getURL()

◆ loadDefault()

◆ setAuthKey()

◆ setAuthSecret()

◆ setClientUrl()

◆ setClientUrlEnabled()

◆ setDomain()

◆ setIliasUrl()

◆ setIliasUrlEnabled()

◆ setInstance()

◆ setPort()

◆ setProtocol()

◆ setSubDirectory()

Field Documentation

◆ $authKey

◆ $authSecret

◆ $clientUrl

◆ $clientUrlEnabled

◆ $domain

◆ $iliasUrl

◆ $iliasUrlEnabled

◆ $instance

◆ $port

◆ $protocol

◆ $subDirectory

◆ DEFAULT_HOST

◆ DEFAULT_PORT

◆ DEFAULT_PROCOTOL

◆ PREFIX