ilChatroomKickGUI Class Reference

Class ilChatroomKickGUI. More...

Inheritance diagram for ilChatroomKickGUI:

Collaboration diagram for ilChatroomKickGUI:

Public Member Functions
	executeDefault (string $requestedMethod)
	main ()
	sub ()
	Kicks user from subroom into mainroom. More...
Public Member Functions inherited from ilChatroomGUIHandler
	execute (string $method)
	executeDefault (string $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...
	sendResponse ($response, bool $isJson=false)
	Sends a json encoded response and exits the php process. More...
	hasPermission (string $permission)

Private Member Functions
	buildMessage (string $messageString, ilChatroomUser $chat_user)

Additional Inherited Members
Protected Member Functions inherited from ilChatroomGUIHandler
	getRequestValue (string $key, Transformation $trafo, $default=null)
	hasRequestValue (string $key)
	getRoomByObjectId (int $objectId)
	exitIfNoRoomExists (?ilChatroom $room)
	Checks if a ilChatroom exists. More...
	exitIfNoRoomModeratePermission (ilChatroom $room, int $subRoom, ilChatroomUser $chatUser)
	Check if user can moderate a chatroom. More...
	canModerate (ilChatroom $room, int $subRoom, int $usrId)
	isMainRoom (int $subRoomId)
Protected Attributes inherited from ilChatroomGUIHandler
ilChatroomObjectGUI	$gui
ilObjUser	$ilUser
ilCtrlInterface	$ilCtrl
ilLanguage	$ilLng
Filesystem	$webDirectory
ilObjectService	$obj_service
FileUpload	$upload
ilRbacSystem	$rbacsystem
ilGlobalTemplateInterface	$mainTpl
ILIAS	$ilias
ilNavigationHistory	$navigationHistory
ilTree	$tree
ilTabsGUI	$tabs
UIFactory	$uiFactory
UIRenderer	$uiRenderer
GlobalHttpState	$http
Refinery	$refinery

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 27 of file class.ilChatroomKickGUI.php.

Member Function Documentation

buildMessage()

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

private

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

                                                                                   : stdClass
    {
        $data = new stdClass();
 
        $data->user = $this->gui->getObject()->getPersonalInformation($chat_user);
        $data->userToKick = $messageString;
        $data->timestamp = date('c');
        $data->type = 'kick';
 
        return $data;
    }

References $data.

executeDefault()

ilChatroomKickGUI::executeDefault

(

string

$requestedMethod

)

Reimplemented from ilChatroomGUIHandler.

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

                                                           : void
    {
        $this->redirectIfNoPermission(['read', 'moderate']);
 
        $room = ilChatroom::byObjectId($this->gui->getObject()->getId());
        $this->exitIfNoRoomExists($room);
 
        $userToKick = $this->getRequestValue('user', $this->refinery->kindlyTo()->int());
        $subRoomId = $this->getRequestValue('sub', $this->refinery->kindlyTo()->int(), 0);
 
        $connector = $this->gui->getConnector();
        $response = $connector->sendKick($room->getRoomId(), $subRoomId, $userToKick);
 
        if (!$subRoomId && $this->isSuccessful($response)) {
            // 2013-09-11: Should already been done by the chat server
            $room->disconnectUser($userToKick);
        }
 
        $this->sendResponse($response);
    }

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

Here is the call graph for this function:

main()

ilChatroomKickGUI::main

(

)

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

                          : void
    {
        $room = ilChatroom::byObjectId($this->gui->getObject()->getId());
        $this->exitIfNoRoomExists($room);
 
        $userToKick = $this->getRequestValue('user', $this->refinery->kindlyTo()->int());
        $subRoomId = $this->getRequestValue('sub', $this->refinery->kindlyTo()->int());
 
        $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);
    }

References $response, ilChatroom\byObjectId(), ilChatroomGUIHandler\exitIfNoRoomExists(), ilChatroomGUIHandler\getRequestValue(), ilChatroomGUIHandler\isSuccessful(), ILIAS\Repository\refinery(), and ilChatroomGUIHandler\sendResponse().

Here is the call graph for this function:

sub()

ilChatroomKickGUI::sub

(

)

Kicks user from subroom into mainroom.

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

                         : void
    {
        $room = ilChatroom::byObjectId($this->gui->getObject()->getId());
        if ($room) {
            $subRoomId = $this->getRequestValue('sub', $this->refinery->kindlyTo()->int());
            if (
                !ilChatroom::checkUserPermissions(['read', 'moderate'], $this->gui->getRefId()) &&
                !$room->isOwnerOfPrivateRoom(
                    $this->ilUser->getId(),
                    $subRoomId
                )
            ) {
                $this->ilCtrl->setParameterByClass(ilRepositoryGUI::class, 'ref_id', ROOT_FOLDER_ID);
                $this->ilCtrl->redirectByClass(ilRepositoryGUI::class);
            }
 
            $roomId = $room->getRoomId();
 
            $userToKick = $this->getRequestValue('user', $this->refinery->kindlyTo()->int());
            if ($room->userIsInPrivateRoom($subRoomId, $userToKick)) {
                $connector = $this->gui->getConnector();
                $response = $connector->sendKick($roomId, $subRoomId, $userToKick);
                $this->sendResponse($response);
            }
        }
    }

References $response, ilChatroom\byObjectId(), ilChatroom\checkUserPermissions(), ilChatroomGUIHandler\getRequestValue(), ilCtrl\redirectByClass(), ILIAS\Repository\refinery(), ROOT_FOLDER_ID, ilChatroomGUIHandler\sendResponse(), and ilCtrl\setParameterByClass().

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