ilChatroomServerSettings Class Reference

Class ilChatroomServerSettings. More...

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	PREFIX = '/backend'

Private Attributes
const	DEFAULT_PORT = 8585
const	DEFAULT_PROCOTOL = 'http://'
const	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.

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

                                       : string
    {
        if ($this->getClientUrlEnabled()) {
            $url = $this->getClientUrl();

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

            return $url;
        }
        return $this->getBaseURL();
    }

Here is the call graph for this function:

generateIliasUrl()

ilChatroomServerSettings::generateIliasUrl

(

)

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

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

Referenced by getURL().

                                      : string
    {
        if ($this->getIliasUrlEnabled()) {
            $url = $this->getIliasUrl();

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

            return $url;
        }

        return $this->getBaseURL();
    }

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.

References $authKey.

                                : string
    {
        return $this->authKey;
    }

getAuthSecret()

ilChatroomServerSettings::getAuthSecret

(

)

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

References $authSecret.

                                   : string
    {
        return $this->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.

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

Referenced by generateClientUrl(), and generateIliasUrl().

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

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.

References $clientUrl.

Referenced by generateClientUrl().

                                  : string
    {
        return $this->clientUrl;
    }

Here is the caller graph for this function:

getClientUrlEnabled()

ilChatroomServerSettings::getClientUrlEnabled

(

)

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

References $clientUrlEnabled.

Referenced by generateClientUrl().

                                         : bool
    {
        return $this->clientUrlEnabled;
    }

Here is the caller graph for this function:

getDomain()

ilChatroomServerSettings::getDomain

(

)

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

References $domain.

Referenced by getBaseURL().

                               : string
    {
        return $this->domain;
    }

Here is the caller graph for this function:

getIliasUrl()

ilChatroomServerSettings::getIliasUrl

(

)

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

References $iliasUrl.

Referenced by generateIliasUrl().

                                 : string
    {
        return $this->iliasUrl;
    }

Here is the caller graph for this function:

getIliasUrlEnabled()

ilChatroomServerSettings::getIliasUrlEnabled

(

)

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

References $iliasUrlEnabled.

Referenced by generateIliasUrl().

                                        : bool
    {
        return $this->iliasUrlEnabled;
    }

Here is the caller graph for this function:

getInstance()

ilChatroomServerSettings::getInstance

(

)

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

References $instance.

Referenced by getURL().

                                 : string
    {
        return $this->instance;
    }

Here is the caller graph for this function:

getPort()

ilChatroomServerSettings::getPort

(

)

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

References $port.

Referenced by getBaseURL().

                             : int
    {
        return $this->port;
    }

Here is the caller graph for this function:

getProtocol()

ilChatroomServerSettings::getProtocol

(

)

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

References $protocol.

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

                                 : string
    {
        return $this->protocol;
    }

Here is the caller graph for this function:

getSubDirectory()

ilChatroomServerSettings::getSubDirectory

(

)

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

References $subDirectory.

                                     : string
    {
        return $this->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.

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

                                                         : string
    {
        $url = $this->generateIliasUrl() . self::PREFIX . '/' . $action . '/' . $this->getInstance();

        if ($scope !== null) {
            $url .= '/' . $scope;
        }

        return $url;
    }

Here is the call graph for this function:

loadDefault()

static ilChatroomServerSettings::loadDefault ( )

static

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

References $DIC.

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

                                        : 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;
    }

Here is the caller graph for this function:

setAuthKey()

ilChatroomServerSettings::setAuthKey

(

string

$authKey

)

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

References $authKey.

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

setAuthSecret()

ilChatroomServerSettings::setAuthSecret

(

string

$authSecret

)

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

References $authSecret.

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

setClientUrl()

ilChatroomServerSettings::setClientUrl

(

string

$clientUrl

)

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

References $clientUrl.

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

setClientUrlEnabled()

ilChatroomServerSettings::setClientUrlEnabled

(

bool

$clientUrlEnabled

)

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

References $clientUrlEnabled.

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

setDomain()

ilChatroomServerSettings::setDomain

(

string

$domain

)

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

References $domain.

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

setIliasUrl()

ilChatroomServerSettings::setIliasUrl

(

string

$iliasUrl

)

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

References $iliasUrl.

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

setIliasUrlEnabled()

ilChatroomServerSettings::setIliasUrlEnabled

(

bool

$iliasUrlEnabled

)

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

References $iliasUrlEnabled.

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

setInstance()

ilChatroomServerSettings::setInstance

(

string

$instance

)

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

References $instance.

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

setPort()

ilChatroomServerSettings::setPort

(

int

$port

)

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

References $port.

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

setProtocol()

ilChatroomServerSettings::setProtocol

(

string

$protocol

)

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

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

setSubDirectory()

ilChatroomServerSettings::setSubDirectory

(

string

$subDirectory

)

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

References $subDirectory.

                                                         : void
    {
        $this->subDirectory = $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().

$subDirectory

string ilChatroomServerSettings::$subDirectory = ''

private

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

Referenced by getSubDirectory(), and setSubDirectory().

DEFAULT_HOST

const ilChatroomServerSettings::DEFAULT_HOST = '192.168.1.94'

private

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

DEFAULT_PORT

const ilChatroomServerSettings::DEFAULT_PORT = 8585

private

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

DEFAULT_PROCOTOL

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

private

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

PREFIX

final const 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