ilChatroomServerConnector Class Reference

Class ilChatroomServerConnector. More...

Collaboration diagram for ilChatroomServerConnector:

Public Member Functions
	__construct (ilChatroomServerSettings $settings)
	Constructor Sets $this->settings using given $settings. More...
	connect ($scope, $userId)
	Returns connect URL Creates connect URL using given $scope and $userId and returns it. More...
	post ($scope, $query)
	Returns post URL Creates post URL using given $scope and $query and returns it. More...
	enterPrivateRoom ($scope, $query)
	leavePrivateRoom ($scope, $query)
	kick ($scope, $query)
	Returns kick URL Creates kick URL using given $scope and $query and returns it. More...
	getSettings ()
	Returns $this->settings. More...
	sendMessage ($scope, $message, $options=array())
	Returns if given message is sucessfully sent. More...
	inviteToPrivateRoom (ilChatRoom $room, $scope, ilObjUser $inviter, $invited_id)
	createPrivateRoom (ilChatroom $room, $title, ilChatroomUser $owner)
	isServerAlive ()

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

Static Protected Attributes
static	$connection_status = null

Private Member Functions
	file_get_contents ($url, array $stream_context_params=null)
	sendCreatePrivateRoom ($scope, $query)

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.

        {
                $this->settings = $settings;
        }

References $settings.

Member Function Documentation

checkServerConnection()

static ilChatroomServerConnector::checkServerConnection (   $use_cache = true )

static

Parameters

bool | true

$use_cache

Returns

bool

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

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

References $connection_status.

Referenced by ilChatroomBlockGUI\getHTML().

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 73 of file class.ilChatroomServerConnector.php.

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

References file_get_contents().

Here is the call graph for this function:

createPrivateRoom()

ilChatroomServerConnector::createPrivateRoom	(	ilChatroom	$room,
			$title,
		ilChatroomUser	$owner
	)

Parameters

ilChatroom	$room
string	$title
ilChatroomUser	$owner

Returns

mixed

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

        {
                $settings = array(
                        'public' => false,
                );
 
                $params['user'] = $owner->getUserId();
                $params['id']   = $room->addPrivateRoom($title, $owner, $settings);
 
                $query          = http_build_query($params);
                $response       = $this->sendCreatePrivateRoom($room->getRoomId(), $query);
                $responseObject = json_decode($response);
                $return         = $responseObject;
                if($responseObject->success == true)
                {
                        $message = json_encode(array(
                                'type'      => 'private_room_created',
                                'timestamp' => date('c'),
                                'public'    => 0,
                                'title'     => $title,
                                'id'        => $responseObject->id,
                                'proom_id'  => $responseObject->id,
                                'owner'     => $owner->getUserId(),
                        ));
 
                        $result = $this->sendMessage($room->getRoomId(), $message, array('public' => 0, 'recipients' => $owner->getUserId()));
 
                        $params         = array();
                        $params['user'] = $owner->getUserId();
                        $params['sub']  = $responseObject->id;
 
                        $query    = http_build_query($params);
                        $response = $this->enterPrivateRoom($room->getRoomId(), $query);
 
                        $room->subscribeUserToPrivateRoom($params['sub'], $params['user']);
 
                        $message = json_encode(array(
                                'type'      => 'private_room_entered',
                                'user'      => $owner->getUserId(),
                                'timestamp' => date('c'),
                                'sub'       => $responseObject->id
                        ));
                        $this->sendMessage($room->getRoomId(), $message);
                }
                return $responseObject;
        }

References $params, $query, $result, $settings, ilChatroom\addPrivateRoom(), enterPrivateRoom(), ilChatroom\getRoomId(), ilChatroomUser\getUserId(), sendCreatePrivateRoom(), sendMessage(), and ilChatroom\subscribeUserToPrivateRoom().

Here is the call graph for this function:

enterPrivateRoom()

ilChatroomServerConnector::enterPrivateRoom	(		$scope,
			$query
	)

Parameters

string	$scope
string	$query

Returns

mixed

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

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

References $query, and file_get_contents().

Referenced by createPrivateRoom().

Here is the call graph for this function:

Here is the caller graph for this function:

file_get_contents()

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

private

Parameters

string	$url
array	$stream_context_params

Returns

string|false

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

        {
                $ctx = array(
                        'http'  => array(
                                'header' => 'Connection: close'
                        ),
                        'https' => array(
                                'header' => 'Connection: close'
                        )
                );
 
                if(is_array($stream_context_params))
                {
                        $ctx = array_merge_recursive($ctx, $stream_context_params);
                }
 
                try
                {
                        $response = file_get_contents($url, null, stream_context_create($ctx));
                        return $response;
                }
                catch(Exception $e)
                {
                        ilLoggerFactory::getLogger('chatroom')->alert($e->getMessage());
                }
 
                return false;
        }

References $url, file_get_contents(), and ilLoggerFactory\getLogger().

Referenced by connect(), enterPrivateRoom(), file_get_contents(), isServerAlive(), kick(), leavePrivateRoom(), post(), and sendCreatePrivateRoom().

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 148 of file class.ilChatroomServerConnector.php.

        {
                return $this->settings;
        }

References $settings.

inviteToPrivateRoom()

ilChatroomServerConnector::inviteToPrivateRoom	(	ilChatRoom	$room,
			$scope,
		ilObjUser	$inviter,
			$invited_id
	)

Parameters

ilChatRoom	$room
int	$scope
ilObjUser	$inviter
int	$invited_id

Returns

array

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

        {
                $chat_user = new ilChatroomUser($inviter, $room);
                $user_id   = $chat_user->getUserId();
 
                if($scope)
                {
                        $room->inviteUserToPrivateRoom($invited_id, $scope);
                        $message = json_encode(array(
                                'type'      => 'private_room_created',
                                'users'     => $invited_id, //$users,
                                'timestamp' => date('c'),
                                'public'    => 0,
                                'title'     => ilChatroom::lookupPrivateRoomTitle($scope),
                                'proom_id'  => $scope,
                                'message'   => array(
                                        'public' => '0',
                                        'user'   => 'system',
                                        'owner'  => $user_id
                                )
                        ));
 
                        $this->sendMessage($room->getRoomId(), $message, array('public' => 0, 'recipients' => $invited_id));
                }
 
                if($room->isSubscribed($user_id))
                {
                        $message = json_encode(array(
                                'type'     => 'user_invited',
                                'title'    => ilChatroom::lookupPrivateRoomTitle($scope),
                                'proom_id' => $scope,
                                'inviter'  => $inviter->getId(),
                                'invited'  => $invited_id
                        ));
 
                        $this->sendMessage($room->getRoomId(), $message, array('public' => 0, 'recipients' => $invited_id));
                }
 
                return array('success' => true, 'message' => 'users invited');
        }

References ilObject\getId(), ilChatroom\lookupPrivateRoomTitle(), and sendMessage().

Here is the call graph for this function:

isServerAlive()

ilChatroomServerConnector::isServerAlive

(

)

Returns

bool

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

        {
                $response = $this->file_get_contents(
                        $this->settings->getURL('Status', 0),
                        array(
                                'http'  => array(
                                        'timeout' => 2
                                ),
                                'https' => array(
                                        'timeout' => 2
                                )
                        )
                );
 
                $responseObject = json_decode($response);
 
                return $responseObject->success == true;
        }

References file_get_contents().

Here is the call graph for this function:

kick()

ilChatroomServerConnector::kick	(		$scope,
			$query
	)

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

Parameters

string	$scope
string	$query

Returns

mixed

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

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

References $query, and file_get_contents().

Here is the call graph for this function:

leavePrivateRoom()

ilChatroomServerConnector::leavePrivateRoom	(		$scope,
			$query
	)

Parameters

string	$scope
string	$query

Returns

mixed

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

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

References $query, and file_get_contents().

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 87 of file class.ilChatroomServerConnector.php.

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

References $query, and file_get_contents().

Referenced by sendMessage().

Here is the call graph for this function:

Here is the caller graph for this function:

sendCreatePrivateRoom()

ilChatroomServerConnector::sendCreatePrivateRoom (   $scope,   $query  )

private

Parameters

string	$scope
string	$query

Returns

mixed

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

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

References $query, and file_get_contents().

Referenced by createPrivateRoom().

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 162 of file class.ilChatroomServerConnector.php.

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

References $options, $query, and post().

Referenced by createPrivateRoom(), and inviteToPrivateRoom().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$connection_status

ilChatroomServerConnector::$connection_status = null

staticprotected

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

Referenced by checkServerConnection().

$settings

ilChatroomServerConnector::$settings

private

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

Referenced by __construct(), createPrivateRoom(), and getSettings().

---

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

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