ilChatroomServerConnector Class Reference

Class ilChatroomServerConnector. More...

Collaboration diagram for ilChatroomServerConnector:

Public Member Functions
	__construct (ilChatroomServerSettings $settings)
	isServerAlive ()
	connect (int $scope, int $userId)
	Creates connect URL using given $scope and $userId and returns it. More...
	sendCreatePrivateRoom (int $scope, int $subScope, int $user, string $title)
	sendDeletePrivateRoom (int $scope, int $subScope, int $user)
	enterPrivateRoom (int $scope, int $subScope, int $user)
	sendEnterPrivateRoom (int $scope, int $subScope, int $user)
	sendClearMessages (int $scope, int $subScope, int $user)
	leavePrivateRoom (int $scope, int $subScope, int $user)
	sendLeavePrivateRoom (int $scope, int $subScope, int $user)
	sendKick (int $scope, int $subScope, int $user)
	kick (int $scope, int $subScope, int $user)
	Returns kick URL Creates kick URL using given $scope and $query and returns it. More...
	sendBan (int $scope, int $subScope, int $user)
	getSettings ()
	sendInviteToPrivateRoom (int $scope, int $subScope, int $user, int $invited_id)
	sendUserConfigChange (string $message)

Static Public Member Functions
static	checkServerConnection (bool $use_cache=true)

Protected Member Functions
	file_get_contents (string $url, ?array $stream_context_params=null)

Static Protected Attributes
static bool	$connection_status = null

Private Attributes
ilChatroomServerSettings	$settings

Detailed Description

Class ilChatroomServerConnector.

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.ilChatroomServerConnector.php.

Constructor & Destructor Documentation

__construct()

ilChatroomServerConnector::__construct

(

ilChatroomServerSettings

$settings

)

Definition at line 33 of file class.ilChatroomServerConnector.php.

    {
        $this->settings = $settings;
    }

References $settings, and ILIAS\Repository\settings().

Here is the call graph for this function:

Member Function Documentation

checkServerConnection()

static ilChatroomServerConnector::checkServerConnection ( bool  $use_cache = true )

static

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

                                                                        : bool
    {
        if ($use_cache && self::$connection_status !== null) {
            return self::$connection_status;
        }
 
        $connector = new self(ilChatroomAdmin::getDefaultConfiguration()->getServerSettings());
        self::$connection_status = $connector->isServerAlive();
 
        return self::$connection_status;
    }

References $connection_status, and ilChatroomAdmin\getDefaultConfiguration().

Referenced by ilChatroomAdminViewGUI\checkServerConnection().

Here is the call graph for this function:

Here is the caller graph for this function:

connect()

ilChatroomServerConnector::connect	(	int	$scope,
		int	$userId
	)

Creates connect URL using given $scope and $userId and returns it.

Parameters

int	$scope
int	$userId

Returns

string|false

Definition at line 79 of file class.ilChatroomServerConnector.php.

    {
        return $this->file_get_contents(
            $this->settings->getURL('Connect', (string) $scope) . '/' . $userId
        );
    }

References file_get_contents(), and ILIAS\Repository\settings().

Here is the call graph for this function:

enterPrivateRoom()

ilChatroomServerConnector::enterPrivateRoom	(	int	$scope,
		int	$subScope,
		int	$user
	)

Parameters

int	$scope
int	$subScope
int	$user

Returns

string|false

Deprecated:

Please use sendEnterPrivateRoom instead

Definition at line 164 of file class.ilChatroomServerConnector.php.

    {
        return $this->sendEnterPrivateRoom($scope, $subScope, $user);
    }

References sendEnterPrivateRoom().

Here is the call graph for this function:

file_get_contents()

ilChatroomServerConnector::file_get_contents ( string  $url, ?array  $stream_context_params = null  )

protected

Parameters

string	$url
array	$stream_context_params

Returns

string|false

Definition at line 91 of file class.ilChatroomServerConnector.php.

    {
        $credentials = $this->settings->getAuthKey() . ':' . $this->settings->getAuthSecret();
        $header =
            "Connection: close\r\n" .
            "Content-Type: application/json; charset=utf-8\r\n" .
            "Authorization: Basic " . base64_encode($credentials);
 
        $ctx = [
            'http' => [
                'method' => 'GET',
                'header' => $header
            ],
            'https' => [
                'method' => 'GET',
                'header' => $header
            ]
        ];
 
        if (is_array($stream_context_params)) {
            $ctx = array_merge_recursive($ctx, $stream_context_params);
        }
 
        set_error_handler(static function (int $severity, string $message, string $file, int $line): void {
            throw new ErrorException($message, $severity, $severity, $file, $line);
        });
 
        try {
            return file_get_contents($url, false, stream_context_create($ctx));
        } catch (Exception $e) {
            ilLoggerFactory::getLogger('chatroom')->alert($e->getMessage());
        } finally {
            restore_error_handler();
        }
 
        return false;
    }

References Vendor\Package\$e, $message, $url, file_get_contents(), ilLoggerFactory\getLogger(), and ILIAS\Repository\settings().

Referenced by connect(), file_get_contents(), isServerAlive(), kick(), sendBan(), sendClearMessages(), sendCreatePrivateRoom(), sendDeletePrivateRoom(), sendEnterPrivateRoom(), sendInviteToPrivateRoom(), sendLeavePrivateRoom(), and sendUserConfigChange().

Here is the call graph for this function:

Here is the caller graph for this function:

getSettings()

ilChatroomServerConnector::getSettings

(

)

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

                                 : ilChatroomServerSettings
    {
        return $this->settings;
    }

References $settings.

isServerAlive()

ilChatroomServerConnector::isServerAlive

(

)

Definition at line 50 of file class.ilChatroomServerConnector.php.

                                   : bool
    {
        $response = $this->file_get_contents(
            $this->settings->getURL('Heartbeat'),
            [
                'http' => [
                    'timeout' => 2
                ],
                'https' => [
                    'timeout' => 2
                ]
            ]
        );
 
        if (false === $response) {
            return false;
        }
 
        $responseObject = json_decode($response, false, 512, JSON_THROW_ON_ERROR);
 
        return $responseObject instanceof stdClass && ((int) $responseObject->status) === 200;
    }

References $response, file_get_contents(), ILIAS\Repository\int(), and ILIAS\Repository\settings().

Here is the call graph for this function:

kick()

ilChatroomServerConnector::kick	(	int	$scope,
		int	$subScope,
		int	$user
	)

Returns kick URL Creates kick URL using given $scope and $query and returns it.

Parameters

int	$scope
int	$subScope
int	$user

Returns

string|false

Definition at line 238 of file class.ilChatroomServerConnector.php.

    {
        return $this->file_get_contents(
            $this->settings->getURL('Kick', (string) $scope) . '/' . $subScope . '/' . $user
        );
    }

References file_get_contents(), and ILIAS\Repository\settings().

Referenced by sendKick().

Here is the call graph for this function:

Here is the caller graph for this function:

leavePrivateRoom()

ilChatroomServerConnector::leavePrivateRoom	(	int	$scope,
		int	$subScope,
		int	$user
	)

Parameters

int	$scope
int	$subScope
int	$user

Returns

string|false

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

    {
        return $this->sendLeavePrivateRoom($scope, $subScope, $user);
    }

References sendLeavePrivateRoom().

Here is the call graph for this function:

sendBan()

ilChatroomServerConnector::sendBan	(	int	$scope,
		int	$subScope,
		int	$user
	)

Parameters

int	$scope
int	$subScope
int	$user

Returns

string|false

Definition at line 251 of file class.ilChatroomServerConnector.php.

    {
        return $this->file_get_contents(
            $this->settings->getURL('Ban', (string) $scope) . '/' . $subScope . '/' . $user
        );
    }

References file_get_contents(), and ILIAS\Repository\settings().

Here is the call graph for this function:

sendClearMessages()

ilChatroomServerConnector::sendClearMessages	(	int	$scope,
		int	$subScope,
		int	$user
	)

Parameters

int	$scope
int	$subScope
int	$user

Returns

string|false

Definition at line 188 of file class.ilChatroomServerConnector.php.

    {
        return $this->file_get_contents(
            $this->settings->getURL('ClearMessages', (string) $scope) . '/' . $subScope . '/' . $user
        );
    }

References file_get_contents(), and ILIAS\Repository\settings().

Here is the call graph for this function:

sendCreatePrivateRoom()

ilChatroomServerConnector::sendCreatePrivateRoom	(	int	$scope,
		int	$subScope,
		int	$user,
		string	$title
	)

Parameters

int	$scope
int	$subScope
int	$user
string	$title

Returns

string|false

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

    {
        return $this->file_get_contents(
            $this->settings->getURL('CreatePrivateRoom', (string) $scope) .
            '/' . $subScope . '/' . $user . '/' . rawurlencode($title)
        );
    }

References file_get_contents(), and ILIAS\Repository\settings().

Here is the call graph for this function:

sendDeletePrivateRoom()

ilChatroomServerConnector::sendDeletePrivateRoom	(	int	$scope,
		int	$subScope,
		int	$user
	)

Parameters

int	$scope
int	$subScope
int	$user

Returns

string|false

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

    {
        return $this->file_get_contents(
            $this->settings->getURL('DeletePrivateRoom', (string) $scope) . '/' . $subScope . '/' . $user
        );
    }

References file_get_contents(), and ILIAS\Repository\settings().

Here is the call graph for this function:

sendEnterPrivateRoom()

ilChatroomServerConnector::sendEnterPrivateRoom	(	int	$scope,
		int	$subScope,
		int	$user
	)

Parameters

int	$scope
int	$subScope
int	$user

Returns

string|false

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

    {
        return $this->file_get_contents(
            $this->settings->getURL('EnterPrivateRoom', (string) $scope) . '/' . $subScope . '/' . $user
        );
    }

References file_get_contents(), and ILIAS\Repository\settings().

Referenced by enterPrivateRoom().

Here is the call graph for this function:

Here is the caller graph for this function:

sendInviteToPrivateRoom()

ilChatroomServerConnector::sendInviteToPrivateRoom	(	int	$scope,
		int	$subScope,
		int	$user,
		int	$invited_id
	)

Parameters

int	$scope
int	$subScope
int	$user
int	$invited_id

Returns

string|false

Definition at line 270 of file class.ilChatroomServerConnector.php.

    {
        return $this->file_get_contents(
            $this->settings->getURL('InvitePrivateRoom', (string) $scope) .
            '/' . $subScope . '/' . $user . '/' . $invited_id
        );
    }

References file_get_contents(), and ILIAS\Repository\settings().

Here is the call graph for this function:

sendKick()

ilChatroomServerConnector::sendKick	(	int	$scope,
		int	$subScope,
		int	$user
	)

Parameters

int	$scope
int	$subScope
int	$user

Returns

string|false

Definition at line 225 of file class.ilChatroomServerConnector.php.

    {
        return $this->kick($scope, $subScope, $user);
    }

References kick().

Here is the call graph for this function:

sendLeavePrivateRoom()

ilChatroomServerConnector::sendLeavePrivateRoom	(	int	$scope,
		int	$subScope,
		int	$user
	)

Parameters

int	$scope
int	$subScope
int	$user

Returns

string|false

Definition at line 212 of file class.ilChatroomServerConnector.php.

    {
        return $this->file_get_contents(
            $this->settings->getURL('LeavePrivateRoom', (string) $scope) . '/' . $subScope . '/' . $user
        );
    }

References file_get_contents(), and ILIAS\Repository\settings().

Referenced by leavePrivateRoom().

Here is the call graph for this function:

Here is the caller graph for this function:

sendUserConfigChange()

ilChatroomServerConnector::sendUserConfigChange

(

string

$message

)

Parameters

string

$message

Returns

string|false

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

    {
        $query = http_build_query(['message' => $message]);
 
        return $this->file_get_contents(
            $this->settings->getURL('UserConfigChange', null) . '?' . $query
        );
    }

References $message, $query, file_get_contents(), and ILIAS\Repository\settings().

Here is the call graph for this function:

Field Documentation

$connection_status

bool ilChatroomServerConnector::$connection_status = null

staticprotected

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

Referenced by checkServerConnection().

$settings

ilChatroomServerSettings ilChatroomServerConnector::$settings

private

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

Referenced by __construct(), and getSettings().

---

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

• Modules/Chatroom/classes/class.ilChatroomServerConnector.php