ilChatroomPrivateRoomGUI Class Reference

Class ilChatroomPrivateRoomGUI. More...

Inheritance diagram for ilChatroomPrivateRoomGUI:

Collaboration diagram for ilChatroomPrivateRoomGUI:

Public Member Functions
	executeDefault (string $requestedMethod)
	create ()
	delete ()
	leave ()
	enter ()
	listUsers ()
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)

Protected Member Functions
	exitIfEnterRoomIsNotAllowed (ilChatroom $room, int $subRoom, ilChatroomUser $chat_user)
	exitIfNoRoomSubscription (ilChatroom $room, ilChatroomUser $chat_user)
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)

Additional Inherited Members
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 ilChatroomPrivateRoomGUI.

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

Member Function Documentation

create()

ilChatroomPrivateRoomGUI::create

(

)

Definition at line 53 of file class.ilChatroomPrivateRoomGUI.php.

                            : void
    {
        $this->redirectIfNoPermission('read');
 
        $room = ilChatroom::byObjectId($this->gui->getObject()->getId());
        $this->exitIfNoRoomExists($room);
 
        $chat_user = new ilChatroomUser($this->ilUser, $room);
        $this->exitIfNoRoomSubscription($room, $chat_user);
 
        $title = $room->getUniquePrivateRoomTitle(ilUtil::stripSlashes(
            $this->getRequestValue('title', $this->refinery->kindlyTo()->string())
        ));
        $subRoomId = $room->addPrivateRoom($title, $chat_user, ['public' => false]);
 
        $connector = $this->gui->getConnector();
        $response = $connector->sendCreatePrivateRoom($room->getRoomId(), $subRoomId, $chat_user->getUserId(), $title);
 
        if ($this->isSuccessful($response)) {
            $response = [
                'success' => true,
                'title' => $title,
                'owner' => $chat_user->getUserId(),
                'subRoomId' => $subRoomId
            ];
        }
 
        $this->sendResponse($response);
    }

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

Here is the call graph for this function:

delete()

ilChatroomPrivateRoomGUI::delete

(

)

Definition at line 83 of file class.ilChatroomPrivateRoomGUI.php.

                            : void
    {
        $room = ilChatroom::byObjectId($this->gui->getObject()->getId());
 
        $this->exitIfNoRoomExists($room);
 
        $subRoom = $this->getRequestValue('sub', $this->refinery->kindlyTo()->int());
        $chat_user = new ilChatroomUser($this->ilUser, $room);
        $this->exitIfNoRoomSubscription($room, $chat_user);
 
        $room->closePrivateRoom($subRoom);
 
        $connector = $this->gui->getConnector();
        $response = $connector->sendDeletePrivateRoom($room->getRoomId(), $subRoom, $chat_user->getUserId());
 
        $this->sendResponse($response);
    }

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

Here is the call graph for this function:

enter()

ilChatroomPrivateRoomGUI::enter

(

)

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

                           : void
    {
        $this->redirectIfNoPermission('read');
 
        $room = ilChatroom::byObjectId($this->gui->getObject()->getId());
        $this->exitIfNoRoomExists($room);
 
        $subRoom = $this->getRequestValue('sub', $this->refinery->kindlyTo()->int());
        $chat_user = new ilChatroomUser($this->ilUser, $room);
        $this->exitIfEnterRoomIsNotAllowed($room, $subRoom, $chat_user);
 
        $connector = $this->gui->getConnector();
        $response = $connector->sendEnterPrivateRoom($room->getRoomId(), $subRoom, $chat_user->getUserId());
 
        if ($this->isSuccessful($response)) {
            $room->subscribeUserToPrivateRoom($subRoom, $chat_user->getUserId());
        }
 
        $this->sendResponse($response);
    }

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

Here is the call graph for this function:

executeDefault()

ilChatroomPrivateRoomGUI::executeDefault

(

string

$requestedMethod

)

Reimplemented from ilChatroomGUIHandler.

Definition at line 49 of file class.ilChatroomPrivateRoomGUI.php.

                                                           : void
    {
    }

exitIfEnterRoomIsNotAllowed()

ilChatroomPrivateRoomGUI::exitIfEnterRoomIsNotAllowed ( ilChatroom  $room, int  $subRoom, ilChatroomUser  $chat_user  )

protected

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

                                                                                                             : void
    {
        if (!$room->isAllowedToEnterPrivateRoom($chat_user->getUserId(), $subRoom)) {
            $this->sendResponse([
                'success' => false,
                'reason' => 'not allowed enter to private room'
            ]);
        }
    }

References ilChatroomUser\getUserId(), ilChatroom\isAllowedToEnterPrivateRoom(), and ilChatroomGUIHandler\sendResponse().

Referenced by enter().

Here is the call graph for this function:

Here is the caller graph for this function:

exitIfNoRoomSubscription()

ilChatroomPrivateRoomGUI::exitIfNoRoomSubscription ( ilChatroom  $room, ilChatroomUser  $chat_user  )

protected

Definition at line 39 of file class.ilChatroomPrivateRoomGUI.php.

                                                                                            : void
    {
        if (!$room->isSubscribed($chat_user->getUserId())) {
            $this->sendResponse([
                'success' => false,
                'reason' => 'not subscribed'
            ]);
        }
    }

References ilChatroomUser\getUserId(), ilChatroom\isSubscribed(), and ilChatroomGUIHandler\sendResponse().

Referenced by create(), delete(), and leave().

Here is the call graph for this function:

Here is the caller graph for this function:

leave()

ilChatroomPrivateRoomGUI::leave

(

)

Definition at line 101 of file class.ilChatroomPrivateRoomGUI.php.

                           : void
    {
        $this->redirectIfNoPermission('read');
 
        $room = ilChatroom::byObjectId($this->gui->getObject()->getId());
 
        $this->exitIfNoRoomExists($room);
 
        $subRoom = $this->getRequestValue('sub', $this->refinery->kindlyTo()->int());
        $chat_user = new ilChatroomUser($this->ilUser, $room);
        $this->exitIfNoRoomSubscription($room, $chat_user);
 
        $connector = $this->gui->getConnector();
        $response = $connector->sendLeavePrivateRoom($room->getRoomId(), $subRoom, $chat_user->getUserId());
 
        if ($room->userIsInPrivateRoom($subRoom, $chat_user->getUserId())) {
            $room->unsubscribeUserFromPrivateRoom($subRoom, $chat_user->getUserId());
        }
 
        $this->sendResponse($response);
    }

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

Here is the call graph for this function:

listUsers()

ilChatroomPrivateRoomGUI::listUsers

(

)

Definition at line 144 of file class.ilChatroomPrivateRoomGUI.php.

                               : void
    {
        $this->redirectIfNoPermission('read');
 
        $room = ilChatroom::byObjectId($this->gui->getObject()->getId());
        $this->exitIfNoRoomExists($room);
 
        $response = $room->listUsersInPrivateRoom(
            $this->getRequestValue('sub', $this->refinery->kindlyTo()->int())
        );
        $this->sendResponse($response);
    }

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

Here is the call graph for this function:

---

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

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