Inheritance diagram for ilChatroomGUIHandler:

Collaboration diagram for ilChatroomGUIHandler:

Public Member Functions
	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
	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
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 ilChatroomGUIHandler.

Author: Jan Posselt jposs.nosp@m.elt@.nosp@m.datab.nosp@m.ay.d.nosp@m.e; Thomas joußen tjous.nosp@m.sen@.nosp@m.datab.nosp@m.ay.d.nosp@m.e

Version: $Id$

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

Member Function Documentation

◆ canModerate()

ilChatroomGUIHandler::canModerate	(	ilChatroom	$room,
		int	$subRoom,
		int	$usrId
	)

protected

Definition at line 205 of file class.ilChatroomGUIHandler.php.

References hasPermission(), isMainRoom(), and ilChatroom\isOwnerOfPrivateRoom().

Referenced by exitIfNoRoomModeratePermission().

                                                                               : bool
     {
         return (
             $this->isMainRoom($subRoom) ||
             $room->isOwnerOfPrivateRoom($usrId, $subRoom) ||
             $this->hasPermission('moderate')
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ execute()

ilChatroomGUIHandler::execute ( string $method )

Definition at line 112 of file class.ilChatroomGUIHandler.php.

References executeDefault().

                                            : void
     {
         $this->ilLng->loadLanguageModule('chatroom');
 
         if (method_exists($this, $method)) {
             $this->$method();
             return;
         }
 
         $this->executeDefault($method);
     }

Here is the call graph for this function:

◆ executeDefault()

ilChatroomGUIHandler::executeDefault ( string $requestedMethod )

abstract

Referenced by execute().

Here is the caller graph for this function:

◆ exitIfNoRoomExists()

ilChatroomGUIHandler::exitIfNoRoomExists ( ?ilChatroom $room )

protected

Checks if a ilChatroom exists.

If not, it will send a json encoded response with success = false

Parameters

?ilChatroom $room

Definition at line 163 of file class.ilChatroomGUIHandler.php.

References sendResponse().

Referenced by ilChatroomBanGUI\active(), ilChatroomHistoryGUI\byDay(), ilChatroomHistoryGUI\bySession(), ilChatroomPrivateRoomGUI\create(), ilChatroomBanGUI\delete(), ilChatroomPrivateRoomGUI\delete(), ilChatroomPrivateRoomGUI\enter(), ilChatroomClearGUI\executeDefault(), ilChatroomKickGUI\executeDefault(), ilChatroomInviteUsersToPrivateRoomGUI\inviteById(), ilChatroomPrivateRoomGUI\leave(), ilChatroomPrivateRoomGUI\listUsers(), ilChatroomKickGUI\main(), and ilChatroomBanGUI\show().

                                                             : void
     {
         if (null === $room) {
             $this->sendResponse([
                 'success' => false,
                 'reason' => 'unknown room',
             ]);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ exitIfNoRoomModeratePermission()

ilChatroomGUIHandler::exitIfNoRoomModeratePermission	(	ilChatroom	$room,
		int	$subRoom,
		ilChatroomUser	$chatUser
	)

protected

Check if user can moderate a chatroom.

If false it send a json decoded response with success = false

Parameters

ilChatroom	$room
int	$subRoom
ilChatroomUser	$chatUser

Definition at line 195 of file class.ilChatroomGUIHandler.php.

References canModerate(), ilChatroomUser\getUserId(), and sendResponse().

Referenced by ilChatroomInviteUsersToPrivateRoomGUI\inviteById().

                                                                                                                : void
     {
         if (!$this->canModerate($room, $subRoom, $chatUser->getUserId())) {
             $this->sendResponse([
                 'success' => false,
                 'reason' => 'not owner of private room',
             ]);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRequestValue()

ilChatroomGUIHandler::getRequestValue	(	string	$key,
		Transformation	$trafo,
			$default = `null`
	)

protected

Parameters

string	$key
Transformation	$trafo
mixed	$default

Returns: mixed|null

Definition at line 90 of file class.ilChatroomGUIHandler.php.

References ILIAS\FileDelivery\http().

Referenced by ilChatroomBanGUI\active(), ilChatroomHistoryGUI\byDay(), ilChatroomInviteUsersToPrivateRoomGUI\byId(), ilChatroomInviteUsersToPrivateRoomGUI\byLogin(), ilChatroomHistoryGUI\bySession(), ilChatroomAdminSmileyGUI\confirmedDeleteMultipleObject(), ilChatroomPrivateRoomGUI\create(), ilChatroomBanGUI\delete(), ilChatroomPrivateRoomGUI\delete(), ilChatroomAdminSmileyGUI\deleteMultipleObject(), ilChatroomAdminSmileyGUI\deleteSmileyObject(), ilChatroomPrivateRoomGUI\enter(), ilChatroomClearGUI\executeDefault(), ilChatroomInfoGUI\executeDefault(), ilChatroomKickGUI\executeDefault(), ilChatroomInviteUsersToPrivateRoomGUI\getUserList(), ilChatroomInviteUsersToPrivateRoomGUI\inviteById(), ilChatroomViewGUI\invitePD(), ilChatroomViewGUI\joinWithCustomName(), ilChatroomPrivateRoomGUI\leave(), ilChatroomPrivateRoomGUI\listUsers(), ilChatroomViewGUI\lostConnection(), ilChatroomKickGUI\main(), ilChatroomAdminSmileyGUI\showDeleteSmileyFormObject(), ilChatroomAdminSmileyGUI\showEditSmileyEntryFormObject(), ilChatroomHistoryGUI\showMessages(), ilChatroomViewGUI\showRoom(), and ilChatroomKickGUI\sub().

     {
         if ($this->http->wrapper()->query()->has($key)) {
             return $this->http->wrapper()->query()->retrieve($key, $trafo);
         }
 
         if ($this->http->wrapper()->post()->has($key)) {
             return $this->http->wrapper()->post()->retrieve($key, $trafo);
         }
 
         return $default;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRoomByObjectId()

ilChatroomGUIHandler::getRoomByObjectId ( int $objectId )

protected

Definition at line 154 of file class.ilChatroomGUIHandler.php.

References ilChatroom\byObjectId().

Referenced by ilChatroomClearGUI\executeDefault().

                                                        : ?ilChatroom
     {
         return ilChatroom::byObjectId($objectId);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasPermission()

ilChatroomGUIHandler::hasPermission ( string $permission )

Definition at line 219 of file class.ilChatroomGUIHandler.php.

References ilChatroom\checkUserPermissions().

Referenced by canModerate().

                                                      : bool
     {
         return ilChatroom::checkUserPermissions($permission, $this->gui->getRefId());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasRequestValue()

ilChatroomGUIHandler::hasRequestValue ( string $key )

protected

Definition at line 103 of file class.ilChatroomGUIHandler.php.

References ILIAS\FileDelivery\http().

Referenced by ilChatroomViewGUI\joinWithCustomName(), ilChatroomViewGUI\lostConnection(), ilChatroomHistoryGUI\showMessages(), and ilChatroomViewGUI\showRoom().

                                                    : bool
     {
         if ($this->http->wrapper()->query()->has($key)) {
             return true;
         }
 
         return $this->http->wrapper()->post()->has($key);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isMainRoom()

ilChatroomGUIHandler::isMainRoom ( int $subRoomId )

protected

Definition at line 214 of file class.ilChatroomGUIHandler.php.

Referenced by canModerate(), and ilChatroomInviteUsersToPrivateRoomGUI\inviteById().

                                                  : bool
     {
         return $subRoomId === 0;
     }

Here is the caller graph for this function:

◆ isSuccessful()

ilChatroomGUIHandler::isSuccessful ( $response )

Checks for success param in an json decoded response.

Parameters

string | false $response

Returns: bool

Definition at line 143 of file class.ilChatroomGUIHandler.php.

References $response.

Referenced by ilChatroomBanGUI\active(), ilChatroomPrivateRoomGUI\create(), ilChatroomPrivateRoomGUI\enter(), ilChatroomKickGUI\executeDefault(), ilChatroomKickGUI\main(), and ilChatroomViewGUI\showRoom().

                                            : bool
     {
         if (!is_string($response)) {
             return false;
         }
 
         $response = json_decode($response, true, 512, JSON_THROW_ON_ERROR);
 
         return $response !== null && array_key_exists('success', $response) && $response['success'];
     }

Here is the caller graph for this function:

◆ redirectIfNoPermission()

ilChatroomGUIHandler::redirectIfNoPermission ( $permission )

Checks for requested permissions and redirects if the permission check failed.

Parameters

string[]|string $permission

Definition at line 130 of file class.ilChatroomGUIHandler.php.

References ilChatroom\checkUserPermissions(), and ROOT_FOLDER_ID.

Referenced by ilChatroomBanGUI\active(), ilChatroomPrivateRoomGUI\create(), ilChatroomPrivateRoomGUI\enter(), ilChatroomClearGUI\executeDefault(), ilChatroomInfoGUI\executeDefault(), ilChatroomKickGUI\executeDefault(), ilChatroomViewGUI\executeDefault(), ilChatroomInviteUsersToPrivateRoomGUI\inviteById(), ilChatroomViewGUI\joinWithCustomName(), ilChatroomPrivateRoomGUI\leave(), ilChatroomPrivateRoomGUI\listUsers(), ilChatroomAdminViewGUI\saveClientSettings(), ilChatroomBanGUI\show(), ilChatroomHistoryGUI\showMessages(), ilChatroomViewGUI\showRoom(), and ilChatroomViewGUI\toggleAutoMessageDisplayState().

                                                        : void
     {
         if (!ilChatroom::checkUserPermissions($permission, $this->gui->getRefId())) {
             $this->ilCtrl->setParameterByClass(ilRepositoryGUI::class, 'ref_id', ROOT_FOLDER_ID);
             $this->ilCtrl->redirectByClass(ilRepositoryGUI::class);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sendResponse()

ilChatroomGUIHandler::sendResponse	(		$response,
		bool	$isJson = `false`
	)

Sends a json encoded response and exits the php process.

Parameters

mixed	$response
bool	$isJson

Definition at line 178 of file class.ilChatroomGUIHandler.php.

References $response, and ILIAS\FileDelivery\http().

Referenced by ilChatroomBanGUI\active(), ilChatroomPrivateRoomGUI\create(), ilChatroomPrivateRoomGUI\delete(), ilChatroomPrivateRoomGUI\enter(), ilChatroomPollGUI\executeDefault(), ilChatroomClearGUI\executeDefault(), ilChatroomKickGUI\executeDefault(), ilChatroomPrivateRoomGUI\exitIfEnterRoomIsNotAllowed(), exitIfNoRoomExists(), exitIfNoRoomModeratePermission(), ilChatroomPrivateRoomGUI\exitIfNoRoomSubscription(), ilChatroomInviteUsersToPrivateRoomGUI\getUserList(), ilChatroomInviteUsersToPrivateRoomGUI\inviteById(), ilChatroomPrivateRoomGUI\leave(), ilChatroomPrivateRoomGUI\listUsers(), ilChatroomViewGUI\lostConnection(), ilChatroomKickGUI\main(), and ilChatroomKickGUI\sub().

                                                                  : void
     {
         $this->http->saveResponse(
             $this->http->response()
                 ->withHeader(ResponseHeader::CONTENT_TYPE, 'application/json')
                 ->withBody(Streams::ofString($isJson ? $response : json_encode($response, JSON_THROW_ON_ERROR)))
         );
         $this->http->sendResponse();
         $this->http->close();
     }