ilChatroomServerConnector Class Reference

Class ilChatroomServerConnector. More...

Inheritance diagram for ilChatroomServerConnector:

Collaboration diagram for ilChatroomServerConnector:

Public Member Functions
	__construct (ilChatroomServerSettings $settings)
	Constructor Sets $this->settings using given $settings. More...
	isServerAlive ()
	connect ($scope, $userId)
	Returns connect URL Creates connect URL using given $scope and $userId and returns it. More...
	sendCreatePrivateRoom ($scope, $subScope, $user, $title)
	sendDeletePrivateRoom ($scope, $subScope, $user)
	enterPrivateRoom ($scope, $subScope, $user)
	sendEnterPrivateRoom ($scope, $subScope, $user)
	sendClearMessages ($scope, $subScope, $user)
	leavePrivateRoom ($scope, $subScope, $user)
	sendLeavePrivateRoom ($scope, $subScope, $user)
	sendKick ($scope, $subScope, $user)
	kick ($scope, $subScope, $user)
	Returns kick URL Creates kick URL using given $scope and $query and returns it. More...
	sendBan ($scope, $subScope, $user)
	getSettings ()
	Returns $this->settings. More...
	sendMessage ($scope, $message, $options=array())
	Returns if given message is sucessfully sent. More...
	post ($scope, $query)
	Returns post URL Creates post URL using given $scope and $query and returns it. More...
	sendInviteToPrivateRoom ($scope, $subScope, $user, $invited_id)
	createUniqueScopeId ($roomId, $pRoomId=null)
	sendUserConfigChange ($message)

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

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

Static Protected Attributes
static	$connection_status = null

Private Attributes
	$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 10 of file class.ilChatroomServerConnector.php.

Constructor & Destructor Documentation

__construct()

ilChatroomServerConnector::__construct

(

ilChatroomServerSettings

$settings

)

Constructor Sets $this->settings using given $settings.

Parameters

ilChatroomServerSettings

$settings

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

References $settings, and settings().

    {
        $this->settings = $settings;
    }

Here is the call graph for this function:

Member Function Documentation

checkServerConnection()

static ilChatroomServerConnector::checkServerConnection (   $use_cache = true )

static

Parameters

bool | true

$use_cache

Returns

bool

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

References ilChatroomAdmin\getDefaultConfiguration().

Referenced by ilChatroomAdminViewGUI\checkServerConnection(), and ilChatroomBlockGUI\getHTML().

    {
        if ($use_cache && self::$connection_status !== null) {
            return self::$connection_status;
        }

        require_once 'Modules/Chatroom/classes/class.ilChatroomAdmin.php';
        $connector               = new self(ilChatroomAdmin::getDefaultConfiguration()->getServerSettings());
        self::$connection_status = (bool) $connector->isServerAlive();

        return self::$connection_status;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

connect()

ilChatroomServerConnector::connect	(		$scope,
			$userId
	)

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

Parameters

string	$scope
integer	$userId

Returns

mixed

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

References file_get_contents(), and settings().

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

Here is the call graph for this function:

createUniqueScopeId()

ilChatroomServerConnector::createUniqueScopeId	(		$roomId,
			$pRoomId = null
	)

Parameters

string	$roomId
string | null	$pRoomId

Returns

string

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

    {
        if ($pRoomId != null) {
            $roomId .= '-' . $pRoomId;
        }

        return $roomId;
    }

enterPrivateRoom()

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

Parameters

int	$scope
int	$subScope
int	$user

Returns

mixed

Deprecated:

Please use sendEnterPrivateRoom instead

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

References sendEnterPrivateRoom().

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

Here is the call graph for this function:

file_get_contents()

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

protected

Parameters

string	$url
array	$stream_context_params

Returns

string|false

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

References $file, $header, $message, $response, $url, array, ilLoggerFactory\getLogger(), and settings().

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

    {
        $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 = array(
            'http'  => array(
                'method' => 'GET',
                'header' => $header
            ),
            'https' => array(
                'method' => 'GET',
                'header' => $header
            )
        );

        if (is_array($stream_context_params)) {
            $ctx = array_merge_recursive($ctx, $stream_context_params);
        }

        set_error_handler(function ($severity, $message, $file, $line) {
            throw new ErrorException($message, $severity, $severity, $file, $line);
        });

        try {
            $response = file_get_contents($url, null, stream_context_create($ctx));
            restore_error_handler();
            return $response;
        } catch (Exception $e) {
            restore_error_handler();
            ilLoggerFactory::getLogger('chatroom')->alert($e->getMessage());
        }

        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getSettings()

ilChatroomServerConnector::getSettings

(

)

Returns $this->settings.

Returns

ilChatroomServerSettings

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

References $settings.

    {
        return $this->settings;
    }

isServerAlive()

ilChatroomServerConnector::isServerAlive

(

)

Returns

bool

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

References $response, array, file_get_contents(), and settings().

    {
        $response = $this->file_get_contents(
            $this->settings->getURL('Heartbeat'),
            array(
                'http'  => array(
                    'timeout' => 2
                ),
                'https' => array(
                    'timeout' => 2
                )
            )
        );

        $responseObject = json_decode($response);

        return $responseObject->status == 200;
    }

Here is the call graph for this function:

kick()

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

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

Parameters

string	$scope
string	$subScope
int	$user

Returns

mixed

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

References file_get_contents(), and settings().

Referenced by sendKick().

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

Here is the call graph for this function:

Here is the caller graph for this function:

leavePrivateRoom()

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

Parameters

string	$scope
int	$subScope
int	$user

Returns

mixed

Deprecated:

; Use sendLeavePrivateRoom instead

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

References sendLeavePrivateRoom().

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

Here is the call graph for this function:

post()

ilChatroomServerConnector::post	(		$scope,
			$query
	)

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

Parameters

string	$scope
string	$query

Returns

mixed

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

References $query, file_get_contents(), and settings().

Referenced by sendMessage().

    {
        return $this->file_get_contents(
            $this->settings->getURL('Post', $scope) . '?' . $query
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

sendBan()

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

Parameters

string	$scope
string	$subScope
int	$user

Returns

false|string

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

References file_get_contents(), and settings().

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

Here is the call graph for this function:

sendClearMessages()

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

Parameters

int	$scope
int	$subScope
int	$user

Returns

string

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

References file_get_contents(), and settings().

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

Here is the call graph for this function:

sendCreatePrivateRoom()

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

Parameters

int	$scope
int	$subScope
int	$user

Returns

mixed

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

References $title, file_get_contents(), and settings().

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

Here is the call graph for this function:

sendDeletePrivateRoom()

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

Parameters

int	$scope
int	$subScope
int	$user

Returns

mixed

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

References file_get_contents(), and settings().

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

Here is the call graph for this function:

sendEnterPrivateRoom()

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

Parameters

int	$scope
int	$subScope
int	$user

Returns

mixed

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

References file_get_contents(), and settings().

Referenced by enterPrivateRoom().

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

Here is the call graph for this function:

Here is the caller graph for this function:

sendInviteToPrivateRoom()

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

Parameters

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

Returns

mixed

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

References file_get_contents(), and settings().

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

Here is the call graph for this function:

sendKick()

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

Parameters

int	$scope
int	$subScope
int	$user

Returns

string

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

References kick().

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

Here is the call graph for this function:

sendLeavePrivateRoom()

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

Parameters

int	$scope
int	$subScope
int	$user

Returns

mixed

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

References file_get_contents(), and settings().

Referenced by leavePrivateRoom().

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

Here is the call graph for this function:

Here is the caller graph for this function:

sendMessage()

ilChatroomServerConnector::sendMessage	(		$scope,
			$message,
			$options = array()
	)

Returns if given message is sucessfully sent.

Calls $this->post using given $scope and $query built by http_build_query with given $message and returns if message was sent sucessfully.

Parameters

string	$scope
string	$message

Returns

stdClass

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

References $message, $options, $query, $response, array, and post().

    {
        $query    = http_build_query(array('message' => $message) + $options);
        $response = $this->post($scope, $query);
        return @json_decode($response);
    }

Here is the call graph for this function:

sendUserConfigChange()

ilChatroomServerConnector::sendUserConfigChange

(

$message

)

Parameters

string

$message

Returns

bool

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

References $message, $query, array, file_get_contents(), and settings().

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

Here is the call graph for this function:

Field Documentation

$connection_status

ilChatroomServerConnector::$connection_status = null

staticprotected

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

$settings

ilChatroomServerConnector::$settings

private

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

Referenced by ilChatroomServerConnectorMock\__construct(), __construct(), and getSettings().

---

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

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