ilChatroomServerHandler Class Reference

Class ilChatroomServerHandler. More...

Collaboration diagram for ilChatroomServerHandler:

Public Member Functions
	__construct ()
	Constructor Calls $this->handleCommand method. More...
	getConnector ()
	Returns connector Instantiates ilChatroomServerConnector with server settings and returns it. More...
	cleanupPrivateRooms ()

Private Member Functions
	handleCommand ($task)
	Calls command depending on given $task. More...
	disconnectedUsers ($usersByScope)
	Calls $chatroom->disconnectUsers for every given user in every given scope ($usersByScope), sends corresponding status messages to chatroom and adds event in history. More...
	getUserInformation ($user_ids)
	serverStarted ()
	Requires ilChatroom and calls its disconnectAllUsersFromAllRooms() method. More...

Detailed Description

Class ilChatroomServerHandler.

Author

Jan Posselt jposs.nosp@m.elt@.nosp@m.datab.nosp@m.ay.d.nosp@m.e

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilChatroomServerHandler::__construct

(

)

Constructor Calls $this->handleCommand method.

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

References exit, and handleCommand().

        {
                $this->handleCommand($_REQUEST['task']);
                exit;
        }

Here is the call graph for this function:

Member Function Documentation

cleanupPrivateRooms()

ilChatroomServerHandler::cleanupPrivateRooms

(

)

Definition at line 121 of file class.ilChatroomServerHandler.php.

References $params, $query, $result, array, ilChatroom\byObjectId(), date, ilChatroom\findDeletablePrivateRooms(), and getConnector().

Referenced by handleCommand().

        {
                $deletableRooms = ilChatroom::findDeletablePrivateRooms();

                $connector = $this->getConnector();

                foreach($deletableRooms as $deletableRoom)
                {

                        $room = ilChatroom::byObjectId($deletableRoom['object_id']);

                        $params['user'] = -1; //$chat_user->getUserId();
                        $room->closePrivateRoom($deletableRoom['proom_id']);
                        $query = http_build_query($params);

                        $message = json_encode(array(
                                'type'      => 'private_room_deleted',
                                'timestamp' => date('c'),
                                'public'    => 1,
                                'id'        => $deletableRoom['proom_id'],
                                'proom_id'  => $deletableRoom['proom_id'],
                                'message'   => array(
                                        'message' => 'room deleted',
                                        'public'  => '1',
                                        'user'    => 'system'
                                )
                        ));

                        $result = $connector->sendMessage($room->getRoomId(), $message, array('public' => 1));

                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

disconnectedUsers()

ilChatroomServerHandler::disconnectedUsers (   $usersByScope )

private

Calls $chatroom->disconnectUsers for every given user in every given scope ($usersByScope), sends corresponding status messages to chatroom and adds event in history.

Parameters

array

$usersByScope

Definition at line 51 of file class.ilChatroomServerHandler.php.

References array, ilChatroom\byRoomId(), date, getConnector(), and getUserInformation().

Referenced by handleCommand().

        {
                require_once 'Modules/Chatroom/classes/class.ilChatroom.php';

                foreach($usersByScope as $scope => $users)
                {
                        $users    = explode(',', $users);
                        $chatroom = ilChatroom::byRoomId($scope);

                        if($chatroom instanceof ilChatroom && is_array($users))
                        {
                                $users       = array_filter($users);
                                $userDetails = $this->getUserInformation($users);
                                $message     = json_encode(array(
                                        'type'      => 'disconnected',
                                        'users'     => $userDetails,
                                        'timestamp' => date('c')
                                ));

                                $chatroom->disconnectUsers($users);

                                if(!isset($_REQUEST['handledAction']) || $_REQUEST['handledAction'] != 'kick')
                                {
                                        $this->getConnector()->sendMessage($chatroom->getRoomId(), $message);
                                }

                                if(true || $chatroom->getSetting('enable_history'))
                                {
                                        $messageObject = array(
                                                'type'      => 'disconnected',
                                                'users'     => $userDetails,
                                                'timestamp' => date('c')
                                        );

                                        $chatroom->addHistoryEntry($messageObject);
                                }
                        }
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

getConnector()

ilChatroomServerHandler::getConnector

(

)

Returns connector Instantiates ilChatroomServerConnector with server settings and returns it.

Returns

ilChatroomServerConnector

Definition at line 110 of file class.ilChatroomServerHandler.php.

Referenced by cleanupPrivateRooms(), and disconnectedUsers().

        {
                require_once 'Modules/Chatroom/classes/class.ilChatroomServerConnector.php';
                require_once 'Modules/Chatroom/classes/class.ilChatroomAdmin.php';

                $settings  = ilChatroomAdmin::getDefaultConfiguration()->getServerSettings();
                $connector = new ilChatroomServerConnector($settings);

                return $connector;
        }

Here is the caller graph for this function:

getUserInformation()

ilChatroomServerHandler::getUserInformation (   $user_ids )

private

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

References $ilDB, $row, and array.

Referenced by disconnectedUsers().

        {
                global $ilDB;

                $rset  = $ilDB->query('SELECT userdata FROM chatroom_users WHERE ' . $ilDB->in('user_id', $user_ids, false, 'integer'));
                $users = array();
                while($row = $ilDB->fetchAssoc($rset))
                {
                        $users[] = json_decode($row['userdata']);
                }
                return $users;
        }

Here is the caller graph for this function:

handleCommand()

ilChatroomServerHandler::handleCommand (   $task )

private

Calls command depending on given $task.

Parameters

string

$task

Definition at line 28 of file class.ilChatroomServerHandler.php.

References cleanupPrivateRooms(), disconnectedUsers(), and serverStarted().

Referenced by __construct().

        {
                switch($task)
                {
                        case 'disconnectedUsers':
                                if(isset($_REQUEST['scope']))
                                {
                                        $this->disconnectedUsers($_REQUEST['scope']);
                                }
                                $this->cleanupPrivateRooms();
                                break;
                        case 'serverStarted':
                                $this->serverStarted();
                                break;
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

serverStarted()

ilChatroomServerHandler::serverStarted ( )

private

Requires ilChatroom and calls its disconnectAllUsersFromAllRooms() method.

Definition at line 158 of file class.ilChatroomServerHandler.php.

References ilChatroom\disconnectAllUsersFromAllRooms().

Referenced by handleCommand().

        {
                require_once 'Modules/Chatroom/classes/class.ilChatroom.php';

                ilChatroom::disconnectAllUsersFromAllRooms();
        }

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

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