Collaboration diagram for ilChatroomServerSettings:

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

	generateIliasUrl ()

	getIliasUrlEnabled ()

	setIliasUrlEnabled ($iliasUrlEnabled)

	getProtocol ()
	Returns $this->protocol. More...

	setProtocol ($protocol)
	Sets $this->protocol using given $protocol. More...

	getIliasUrl ()

	setIliasUrl ($iliasUrl)

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

	getDomain ()
	Returns $this->domain. More...

	setDomain ($domain)
	Sets $this->domain using given $domain. More...

	getPort ()
	Returns $this->port. More...

	setPort ($port)
	Sets $this->port using given $port. More...

	getInstance ()
	Returns $this->instance. More...

	setInstance ($instance)
	Sets $this->instance using given $instance. More...

	generateClientUrl ()

	getClientUrlEnabled ()

	setClientUrlEnabled ($clientUrlEnabled)

	getClientUrl ()

	setClientUrl ($clientUrl)

	getSmiliesEnabled ()

	setSmiliesEnabled ($a_bool)

	getAuthKey ()

	setAuthKey ($authKey)

	getAuthSecret ()

	setAuthSecret ($authSecret)

	getSubDirectory ()

	setSubDirectory ($subDirectory)

Static Public Member Functions
static	loadDefault ()

Data Fields
const	PREFIX = '/backend'

Private Attributes
	$port = '8585'

	$protocol = 'http://'

	$domain = '192.168.1.94'

	$instance = '123456'

	$smilies_enabled = false

	$authKey

	$authSecret

	$clientUrlEnabled

	$clientUrl

	$iliasUrlEnabled

	$iliasUrl

	$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 10 of file class.ilChatroomServerSettings.php.

Member Function Documentation

◆ generateClientUrl()

ilChatroomServerSettings::generateClientUrl ( )

Returns: string

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

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

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

Here is the call graph for this function:

◆ generateIliasUrl()

ilChatroomServerSettings::generateIliasUrl ( )

Returns: string

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

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

Referenced by getURL().

     {
         if ($this->getIliasUrlEnabled()) {
             $url = $this->getIliasUrl();
 
             if (strpos($url, '://') === false) {
                 $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 ( )

Returns: string

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

References $authKey.

     {
         return $this->authKey;
     }

◆ getAuthSecret()

ilChatroomServerSettings::getAuthSecret ( )

Returns: string

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

References $authSecret.

     {
         return $this->authSecret;
     }

◆ getBaseURL()

ilChatroomServerSettings::getBaseURL ( )

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

Returns: string

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

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

Referenced by generateClientUrl(), and generateIliasUrl().

     {
         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 ( )

Returns: string

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

References $clientUrl.

Referenced by generateClientUrl().

     {
         return $this->clientUrl;
     }

Here is the caller graph for this function:

◆ getClientUrlEnabled()

ilChatroomServerSettings::getClientUrlEnabled ( )

Returns: bool

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

References $clientUrlEnabled.

Referenced by generateClientUrl().

     {
         return $this->clientUrlEnabled;
     }

Here is the caller graph for this function:

◆ getDomain()

ilChatroomServerSettings::getDomain ( )

Returns $this->domain.

Returns: string

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

References $domain.

Referenced by getBaseURL().

     {
         return $this->domain;
     }

Here is the caller graph for this function:

◆ getIliasUrl()

ilChatroomServerSettings::getIliasUrl ( )

Returns: string

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

References $iliasUrl.

Referenced by generateIliasUrl().

     {
         return $this->iliasUrl;
     }

Here is the caller graph for this function:

◆ getIliasUrlEnabled()

ilChatroomServerSettings::getIliasUrlEnabled ( )

Returns: bool

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

References $iliasUrlEnabled.

Referenced by generateIliasUrl().

     {
         return $this->iliasUrlEnabled;
     }

Here is the caller graph for this function:

◆ getInstance()

ilChatroomServerSettings::getInstance ( )

Returns $this->instance.

Returns: string

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

References $instance.

Referenced by getURL().

     {
         return $this->instance;
     }

Here is the caller graph for this function:

◆ getPort()

ilChatroomServerSettings::getPort ( )

Returns $this->port.

Returns: string

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

References $port.

Referenced by getBaseURL().

     {
         return $this->port;
     }

Here is the caller graph for this function:

◆ getProtocol()

ilChatroomServerSettings::getProtocol ( )

Returns $this->protocol.

Returns: string

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

References $protocol.

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

     {
         return $this->protocol;
     }

Here is the caller graph for this function:

◆ getSmiliesEnabled()

ilChatroomServerSettings::getSmiliesEnabled ( )

Returns: bool

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

References $smilies_enabled.

Referenced by ilOnScreenChatGUI\getEmoticons().

     {
         return (bool) $this->smilies_enabled;
     }

Here is the caller graph for this function:

◆ getSubDirectory()

ilChatroomServerSettings::getSubDirectory ( )

Returns: mixed

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

References $subDirectory.

     {
         return $this->subDirectory;
     }

◆ getURL()

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

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

Parameters

string	$action
string \| null	$scope

Returns: string

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

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

     {
         $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 26 of file class.ilChatroomServerSettings.php.

References $DIC, $query, and $row.

Referenced by ilChatroomBlockGUI\fillDataSection(), ilObjChatroomAdminGUI\getConnector(), ilChatroomAdmin\getServerSettings(), and ilOnScreenChatGUI\loadServerSettings().

     {
         global $DIC;
 
         $query = 'SELECT * FROM chatroom_admconfig';
         $rset  = $DIC->database()->query($query);
         $row   = $DIC->database()->fetchAssoc($rset);
 
         $client_settings = json_decode($row['client_settings']);
         $server_settings = json_decode($row['server_settings']);
 
         $settings = new ilChatroomServerSettings();
         $settings->setPort($server_settings->port);
         $settings->setProtocol($server_settings->protocol);
         $settings->setInstance($client_settings->name);
         $settings->setDomain($server_settings->address);
         $settings->setSmiliesEnabled($client_settings->enable_smilies);
         $settings->setAuthKey($client_settings->auth->key);
         $settings->setAuthSecret($client_settings->auth->secret);
         $settings->setClientUrlEnabled($server_settings->client_proxy);
         $settings->setIliasUrlEnabled($server_settings->ilias_proxy);
         $settings->setClientUrl($server_settings->client_url);
         $settings->setIliasUrl($server_settings->ilias_url);
         $settings->setSubDirectory($server_settings->sub_directory);
 
         return $settings;
     }

Here is the caller graph for this function:

◆ setAuthKey()

ilChatroomServerSettings::setAuthKey ( $authKey )

Parameters

string $authKey

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

References $authKey.

     {
         $this->authKey = $authKey;
     }

◆ setAuthSecret()

ilChatroomServerSettings::setAuthSecret ( $authSecret )

Parameters

string $authSecret

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

References $authSecret.

     {
         $this->authSecret = $authSecret;
     }

◆ setClientUrl()

ilChatroomServerSettings::setClientUrl ( $clientUrl )

Parameters

string $clientUrl

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

References $clientUrl.

     {
         $this->clientUrl = $clientUrl;
     }

◆ setClientUrlEnabled()

ilChatroomServerSettings::setClientUrlEnabled ( $clientUrlEnabled )

Parameters

bool $clientUrlEnabled

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

References $clientUrlEnabled.

     {
         $this->clientUrlEnabled = $clientUrlEnabled;
     }

◆ setDomain()

ilChatroomServerSettings::setDomain ( $domain )

Sets $this->domain using given $domain.

Parameters

string $domain

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

References $domain.

     {
         $this->domain = $domain;
     }

◆ setIliasUrl()

ilChatroomServerSettings::setIliasUrl ( $iliasUrl )

Parameters

string $iliasUrl

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

References $iliasUrl.

     {
         $this->iliasUrl = $iliasUrl;
     }

◆ setIliasUrlEnabled()

ilChatroomServerSettings::setIliasUrlEnabled ( $iliasUrlEnabled )

Parameters

bool $iliasUrlEnabled

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

References $iliasUrlEnabled.

     {
         $this->iliasUrlEnabled = $iliasUrlEnabled;
     }

◆ setInstance()

ilChatroomServerSettings::setInstance ( $instance )

Sets $this->instance using given $instance.

Parameters

string $instance

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

References $instance.

     {
         $this->instance = $instance;
     }

◆ setPort()

ilChatroomServerSettings::setPort ( $port )

Sets $this->port using given $port.

Parameters

string $port

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

References $port.

     {
         $this->port = $port;
     }

◆ setProtocol()

ilChatroomServerSettings::setProtocol ( $protocol )

Sets $this->protocol using given $protocol.

Parameters

string $protocol

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

References $protocol.

     {
         if (strpos($protocol, '://') === false) {
             $this->protocol = $protocol . '://';
         }
     }

◆ setSmiliesEnabled()

ilChatroomServerSettings::setSmiliesEnabled ( $a_bool )

Parameters

bool $a_bool

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

     {
         $this->smilies_enabled = $a_bool;
     }

◆ setSubDirectory()

ilChatroomServerSettings::setSubDirectory ( $subDirectory )

Parameters

mixed $subDirectory

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

References $subDirectory.

     {
         $this->subDirectory = $subDirectory;
     }

Field Documentation

◆ $authKey

ilChatroomServerSettings::$authKey

private

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

Referenced by getAuthKey(), and setAuthKey().

◆ $authSecret

ilChatroomServerSettings::$authSecret

private

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

Referenced by getAuthSecret(), and setAuthSecret().

◆ $clientUrl

ilChatroomServerSettings::$clientUrl

private

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

Referenced by getClientUrl(), and setClientUrl().

◆ $clientUrlEnabled

ilChatroomServerSettings::$clientUrlEnabled

private

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

Referenced by getClientUrlEnabled(), and setClientUrlEnabled().

◆ $domain

ilChatroomServerSettings::$domain = '192.168.1.94'

private

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

Referenced by getDomain(), and setDomain().

◆ $iliasUrl

ilChatroomServerSettings::$iliasUrl

private

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

Referenced by getIliasUrl(), and setIliasUrl().

◆ $iliasUrlEnabled

ilChatroomServerSettings::$iliasUrlEnabled

private

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

Referenced by getIliasUrlEnabled(), and setIliasUrlEnabled().

◆ $instance

ilChatroomServerSettings::$instance = '123456'

private

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

Referenced by getInstance(), and setInstance().

◆ $port

ilChatroomServerSettings::$port = '8585'

private

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

Referenced by getPort(), and setPort().

◆ $protocol

ilChatroomServerSettings::$protocol = 'http://'

private

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

Referenced by getProtocol(), and setProtocol().

◆ $smilies_enabled

ilChatroomServerSettings::$smilies_enabled = false

private

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

Referenced by getSmiliesEnabled().

◆ $subDirectory

ilChatroomServerSettings::$subDirectory

private

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

Referenced by getSubDirectory(), and setSubDirectory().

◆ PREFIX

const ilChatroomServerSettings::PREFIX = '/backend'

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

Referenced by ilChatroomServerSettingsTest\testGetUrl().

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

Modules/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()

◆ getSmiliesEnabled()

◆ getSubDirectory()

◆ getURL()

◆ loadDefault()

◆ setAuthKey()

◆ setAuthSecret()

◆ setClientUrl()

◆ setClientUrlEnabled()

◆ setDomain()

◆ setIliasUrl()

◆ setIliasUrlEnabled()

◆ setInstance()

◆ setPort()

◆ setProtocol()

◆ setSmiliesEnabled()

◆ setSubDirectory()

Field Documentation

◆ $authKey

◆ $authSecret

◆ $clientUrl

◆ $clientUrlEnabled

◆ $domain

◆ $iliasUrl

◆ $iliasUrlEnabled

◆ $instance

◆ $port

◆ $protocol

◆ $smilies_enabled

◆ $subDirectory

◆ PREFIX