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

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

	sendJSONResponse ($response)
	Sends a json encoded response and exits the php process. More...

	sendResponse (string $content, string $type)
	Sends a response and exits the php process. More...

Protected Attributes
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

ILIAS FileDelivery Services	$file_delivery

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

◆ execute()

ilChatroomGUIHandler::execute ( string $method )

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

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

References executeDefault().

Here is the call graph for this function:

◆ executeDefault()

ilChatroomGUIHandler::executeDefault ( string $requestedMethod )

abstract

Reimplemented in ilChatroomAdminViewGUI, ilChatroomBanGUI, ilChatroomClearGUI, ilChatroomHistoryGUI, ilChatroomInfoScreenGUI, ilChatroomInviteUsersToPrivateRoomGUI, ilChatroomKickGUI, ilChatroomPollGUI, ilChatroomSettingsGUI, and ilChatroomViewGUI.

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

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

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

References sendJSONResponse().

Referenced by ilChatroomBanGUI\active(), ilChatroomBanGUI\delete(), ilChatroomClearGUI\executeDefault(), ilChatroomInviteUsersToPrivateRoomGUI\inviteById(), ilChatroomKickGUI\main(), and ilChatroomBanGUI\show().

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

mixed $default

Returns: mixed|null

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

    {
        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;
    }

References ILIAS\FileDelivery\http().

Referenced by ilChatroomBanGUI\active(), ilChatroomInviteUsersToPrivateRoomGUI\byId(), ilChatroomInviteUsersToPrivateRoomGUI\byLogin(), ilChatroomBanGUI\delete(), ilChatroomInviteUsersToPrivateRoomGUI\getUserList(), ilChatroomInviteUsersToPrivateRoomGUI\inviteById(), ilChatroomViewGUI\joinWithCustomName(), and ilChatroomKickGUI\main().

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 151 of file class.ilChatroomGUIHandler.php.

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

References ilChatroom\byObjectId().

Referenced by ilChatroomClearGUI\executeDefault().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasPermission()

ilChatroomGUIHandler::hasPermission ( string $permission )

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

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

References ilChatroom\checkUserPermissions().

Here is the call graph for this function:

◆ hasRequestValue()

ilChatroomGUIHandler::hasRequestValue ( string $key )

protected

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

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

References ILIAS\FileDelivery\http().

Referenced by ilChatroomViewGUI\joinWithCustomName().

Here is the call graph for this function:

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 140 of file class.ilChatroomGUIHandler.php.

                                           : 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'];
    }

References $response.

Referenced by ilChatroomBanGUI\active(), and ilChatroomKickGUI\main().

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 127 of file class.ilChatroomGUIHandler.php.

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

References ilChatroom\checkUserPermissions(), ilCtrl\redirectByClass(), ROOT_FOLDER_ID, and ilCtrl\setParameterByClass().

Referenced by ilChatroomBanGUI\active(), ilChatroomBanGUI\delete(), ilChatroomAdminViewGUI\deliverDocumentation(), ilChatroomClearGUI\executeDefault(), ilChatroomInfoScreenGUI\executeDefault(), ilChatroomInviteUsersToPrivateRoomGUI\inviteById(), ilChatroomViewGUI\joinWithCustomName(), ilChatroomKickGUI\main(), ilChatroomAdminViewGUI\saveClientSettings(), and ilChatroomBanGUI\show().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sendJSONResponse()

ilChatroomGUIHandler::sendJSONResponse ( $response )

protected

Sends a json encoded response and exits the php process.

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

                                                  : void
    {
        $this->sendResponse(json_encode($response), 'application/json');
    }

References $response, and sendResponse().

Referenced by ilChatroomPollGUI\executeDefault(), and exitIfNoRoomExists().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sendResponse()

ilChatroomGUIHandler::sendResponse	(	string	$content,
		string	$type
	)

protected

Sends a response and exits the php process.

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

                                                                  : void
    {
        $this->http->saveResponse(
            $this->http->response()
                ->withHeader(ResponseHeader::CONTENT_TYPE, $type)
                ->withBody(Streams::ofString($content))
        );
        $this->http->sendResponse();
        $this->http->close();
    }