ilChatroomKickGUI Class Reference

Class ilChatroomKickGUI. More...

Inheritance diagram for ilChatroomKickGUI:

Collaboration diagram for ilChatroomKickGUI:

Public Member Functions
	executeDefault ($method)
	Displays window box to kick a user fetched from $_REQUEST['user']. More...
	main ()
	sub ()
	Kicks user from subroom into mainroom. More...
Public Member Functions inherited from ilChatroomGUIHandler
	__construct (ilChatroomObjectGUI $gui)
	sendResponse ($response)
	Sends a json encoded response and exits the php process. More...
	hasPermission ($permission)
	Checks for access with ilRbacSystem. More...
	execute ($method)
	Executes given $method if existing, otherwise executes executeDefault() method. More...
	executeDefault ($requestedMethod)
	redirectIfNoPermission ($permission)
	Checks for requested permissions and redirects if the permission check failed. More...
	isSuccessful ($response)
	Checks for success param in an json decoded response. More...

Private Member Functions
	buildMessage ($messageString, ilChatroomUser $chat_user)
	Instantiates stdClass, sets $data->user and $data->userToKick using given $messageString and $chat_user and returns $data. More...

Additional Inherited Members
Protected Member Functions inherited from ilChatroomGUIHandler
	getRoomByObjectId ($objectId)
	exitIfNoRoomExists ($room)
	Checks if a ilChatroom exists. More...
	exitIfNoRoomPermission ($room, $subRoom, $chat_user)
	Check if user can moderate a chatroom. More...
	canModerate ($room, $subRoom, $user_id)
	Checks if the user has permission to moderate a ilChatroom. More...
	isMainRoom ($subRoomId)
Protected Attributes inherited from ilChatroomGUIHandler
	$gui
	$ilUser
	$ilCtrl
	$ilLng
	$webDirectory
	$upload
	$rbacsystem
	$mainTpl
	$ilias
	$navigationHistory
	$tree
	$tabs

Detailed Description

Class ilChatroomKickGUI.

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

Member Function Documentation

buildMessage()

ilChatroomKickGUI::buildMessage (   $messageString, ilChatroomUser  $chat_user  )

private

Instantiates stdClass, sets $data->user and $data->userToKick using given $messageString and $chat_user and returns $data.

Parameters

string	$messageString
ilChatroomUser	$chat_user

Returns

stdClass

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

References $data.

    {
        $data = new stdClass();

        $data->user = $this->gui->object->getPersonalInformation($chat_user);
        $data->userToKick = $messageString;
        $data->timestamp = date('c');
        $data->type = 'kick';

        return $data;
    }

executeDefault()

ilChatroomKickGUI::executeDefault

(

$method

)

Displays window box to kick a user fetched from $_REQUEST['user'].

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

References $response, ilChatroom\byObjectId(), ilChatroomGUIHandler\exitIfNoRoomExists(), ilChatroomGUIHandler\isSuccessful(), ilChatroomGUIHandler\redirectIfNoPermission(), and ilChatroomGUIHandler\sendResponse().

    {
        $this->redirectIfNoPermission(array('read', 'moderate'));

        $room = ilChatroom::byObjectId($this->gui->object->getId());
        $userToKick = $_REQUEST['user'];
        $subRoomId = $_REQUEST['sub'];

        $this->exitIfNoRoomExists($room);

        $connector = $this->gui->getConnector();
        $response = $connector->sendKick($room->getRoomId(), $subRoomId, $userToKick);

        if ($this->isSuccessful($response) && !$subRoomId) {
            // 2013-09-11: Should already been done by the chat server
            $room->disconnectUser($userToKick);
        }

        $this->sendResponse($response);
    }

Here is the call graph for this function:

main()

ilChatroomKickGUI::main

(

)

Definition at line 59 of file class.ilChatroomKickGUI.php.

References $response, ilChatroom\byObjectId(), ilChatroomGUIHandler\exitIfNoRoomExists(), ilChatroomGUIHandler\isSuccessful(), and ilChatroomGUIHandler\sendResponse().

    {
        $room = ilChatroom::byObjectId($this->gui->object->getId());
        $userToKick = $_REQUEST['user'];
        $subRoomId = $_REQUEST['sub'];

        $this->exitIfNoRoomExists($room);

        $connector = $this->gui->getConnector();
        $response = $connector->sendKick($room->getRoomId(), $subRoomId, $userToKick);

        if ($this->isSuccessful($response)) {
            // 2013-09-11: Should already been done by the chat server
            $room->disconnectUser($userToKick);
        }

        $this->sendResponse($response);
    }

Here is the call graph for this function:

sub()

ilChatroomKickGUI::sub

(

)

Kicks user from subroom into mainroom.

Definition at line 81 of file class.ilChatroomKickGUI.php.

References $response, ilChatroom\byObjectId(), ilChatroom\checkUserPermissions(), ilCtrl\redirectByClass(), ilChatroomGUIHandler\sendResponse(), and ilCtrl\setParameterByClass().

    {
        $room = ilChatroom::byObjectId($this->gui->object->getId());

        if ($room) {
            if (!$room->isOwnerOfPrivateRoom($this->ilUser->getId(), $_REQUEST['sub'])) {
                if (!ilChatroom::checkUserPermissions(array('read', 'moderate'), $this->gui->ref_id)) {
                    $this->ilCtrl->setParameterByClass("ilrepositorygui", "ref_id", ROOT_FOLDER_ID);
                    $this->ilCtrl->redirectByClass("ilrepositorygui", "");
                }
            }

            $roomId = $room->getRoomId();
            $subRoomId = $_REQUEST['sub'];
            $userToKick = $_REQUEST['user'];

            if ($room->userIsInPrivateRoom($subRoomId, $userToKick)) {
                $connector = $this->gui->getConnector();
                $response = $connector->sendKick($roomId, $subRoomId, $userToKick);
                $this->sendResponse($response);
            }
        }
    }

Here is the call graph for this function:

---

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

• Modules/Chatroom/classes/gui/class.ilChatroomKickGUI.php