Inheritance diagram for ilChatroomGUIHandler:

Collaboration diagram for ilChatroomGUIHandler:

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

Protected Member Functions
	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
	$gui

	$ilUser

	$ilCtrl

	$ilLng

	$webDirectory

	$upload

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

Constructor & Destructor Documentation

◆ __construct()

ilChatroomGUIHandler::__construct ( ilChatroomObjectGUI $gui )

Parameters

ilChatroomObjectGUI $gui

Reimplemented in ilChatroomAdminViewGUI, ilChatroomHistoryGUI, ilChatroomInfoGUI, ilChatroomInitialGUI, ilChatroomInviteUsersToPrivateRoomGUI, ilChatroomPrivateRoomGUI, and ilChatroomSettingsGUI.

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

    {
        global $DIC;
 
        $this->gui          = $gui;
        $this->ilUser       = $DIC->user();
        $this->ilCtrl       = $DIC->ctrl();
        $this->ilLng        = $DIC->language();
        $this->upload       = $DIC->upload();
        $this->webDirectory = $DIC->filesystem()->web();
    }

References $DIC, and $gui.

Member Function Documentation

◆ canModerate()

ilChatroomGUIHandler::canModerate	(	$room,
		$subRoom,
		$user_id
	)

protected

Checks if the user has permission to moderate a ilChatroom.

Parameters

ilChatroom	$room
int	$subRoom
int	$user_id

Returns: bool

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

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

References hasPermission(), and isMainRoom().

Referenced by exitIfNoRoomPermission(), and ilChatroomTaskHandlerMock\mockedCanModerate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ execute()

ilChatroomGUIHandler::execute ( $method )

Executes given $method if existing, otherwise executes executeDefault() method.

Parameters

string $method

Returns: mixed

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

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

References executeDefault().

Here is the call graph for this function:

◆ executeDefault()

ilChatroomGUIHandler::executeDefault ( $requestedMethod )

abstract

Parameters

string $requestedMethod

Returns: mixed

Reimplemented in ilChatroomAdminSmiliesGUI, ilChatroomAdminViewGUI, ilChatroomBanGUI, ilChatroomClearGUI, ilChatroomCreateGUI, ilChatroomHistoryGUI, ilChatroomInitialGUI, ilChatroomInviteUsersToPrivateRoomGUI, ilChatroomKickGUI, ilChatroomPollGUI, ilChatroomPostMessageGUI, ilChatroomPrivateRoomGUI, ilChatroomAdminSmileyGUI, ilChatroomGetPermissionsGUI, ilChatroomSettingsGUI, ilChatroomUploadFileGUI, and ilChatroomTaskHandlerMock.

Referenced by execute().

Here is the caller graph for this function:

◆ exitIfNoRoomExists()

ilChatroomGUIHandler::exitIfNoRoomExists ( $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 72 of file class.ilChatroomGUIHandler.php.

    {
        if (!$room) {
            $this->sendResponse(
                array(
                    'success' => false,
                    'reason'  => 'unkown room',
                )
            );
        }
    }

References sendResponse().

Referenced by ilChatroomBanGUI\active(), ilChatroomPrivateRoomGUI\create(), ilChatroomPrivateRoomGUI\delete(), ilChatroomPrivateRoomGUI\enter(), ilChatroomClearGUI\executeDefault(), ilChatroomKickGUI\executeDefault(), ilChatroomInviteUsersToPrivateRoomGUI\inviteById(), ilChatroomPrivateRoomGUI\leave(), ilChatroomKickGUI\main(), and ilChatroomTaskHandlerMock\mockedExitIfNoRoomExists().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ exitIfNoRoomPermission()

ilChatroomGUIHandler::exitIfNoRoomPermission	(	$room,
		$subRoom,
		$chat_user
	)

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	$chat_user

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

    {
        if (!$this->canModerate($room, $subRoom, $chat_user->getUserId())) {
            $this->sendResponse(
                array(
                    'success' => false,
                    'reason'  => 'not owner of private room',
                )
            );
        }
    }

References canModerate(), and sendResponse().

Referenced by ilChatroomInviteUsersToPrivateRoomGUI\inviteById(), and ilChatroomTaskHandlerMock\mockedExitIfNoRoomPermission().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRoomByObjectId()

ilChatroomGUIHandler::getRoomByObjectId ( $objectId )

protected

Parameters

$objectId

Returns: ilChatroom

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

    {
        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 ( $permission )

Checks for access with ilRbacSystem.

Parameters

string $permission

Returns: bool

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

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

References ilChatroom\checkUserPermissions().

Referenced by canModerate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isMainRoom()

ilChatroomGUIHandler::isMainRoom ( $subRoomId )

protected

Parameters

int $subRoomId

Returns: bool

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

    {
        return $subRoomId == 0;
    }

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

Here is the caller graph for this function:

◆ isSuccessful()

ilChatroomGUIHandler::isSuccessful ( $response )

Checks for success param in an json decoded response.

Parameters

string $response

Returns: boolean

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

    {
        $response = json_decode($response, true);
 
        return $response !== null && array_key_exists('success', $response) && $response['success'];
    }

References $response.

Referenced by ilChatroomBanGUI\active(), ilChatroomPrivateRoomGUI\create(), ilChatroomPrivateRoomGUI\enter(), ilChatroomKickGUI\executeDefault(), 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

array | string $permission

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

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

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

Referenced by ilChatroomBanGUI\active(), ilChatroomAdminViewGUI\clientsettings(), ilChatroomPrivateRoomGUI\create(), ilChatroomPrivateRoomGUI\enter(), ilChatroomClearGUI\executeDefault(), ilChatroomKickGUI\executeDefault(), ilChatroomPostMessageGUI\executeDefault(), ilChatroomInviteUsersToPrivateRoomGUI\inviteById(), ilChatroomAdminViewGUI\saveClientSettings(), ilChatroomAdminViewGUI\saveSettings(), ilChatroomAdminViewGUI\serversettings(), ilChatroomBanGUI\show(), and ilChatroomUploadFileGUI\uploadFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sendResponse()

ilChatroomGUIHandler::sendResponse ( $response )

Sends a json encoded response and exits the php process.

Parameters

array $response

Reimplemented in ilChatroomTaskHandlerMock.

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

    {
        echo json_encode($response);
        exit;
    }

References $response, and exit.

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

Here is the caller graph for this function:

Field Documentation

◆ $gui

ilChatroomGUIHandler::$gui

protected

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

Referenced by ilChatroomAdminViewGUI\__construct(), __construct(), ilChatroomHistoryGUI\__construct(), ilChatroomInfoGUI\__construct(), ilChatroomInitialGUI\__construct(), ilChatroomInviteUsersToPrivateRoomGUI\__construct(), ilChatroomPrivateRoomGUI\__construct(), ilChatroomSettingsGUI\__construct(), and ilChatroomInfoGUI\createInfoScreenGUI().

◆ $ilCtrl

ilChatroomGUIHandler::$ilCtrl

protected

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

Referenced by ilChatroomAdminSmileyGUI\deleteSmileyObject(), ilChatroomUploadFileGUI\displayLinkToUploadedFile(), ilChatroomInitialGUI\executeDefault(), ilChatroomPostMessageGUI\executeDefault(), ilChatroomAdminSmileyGUI\initSmiliesEditForm(), and ilChatroomAdminSmileyGUI\initSmiliesForm().

◆ $ilLng

ilChatroomGUIHandler::$ilLng

protected

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

◆ $ilUser

ilChatroomGUIHandler::$ilUser

protected

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

Referenced by ilChatroomInitialGUI\executeDefault(), ilChatroomPostMessageGUI\executeDefault(), and ilChatroomUploadFileGUI\uploadFile().

◆ $upload

ilChatroomGUIHandler::$upload

protected

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

◆ $webDirectory

ilChatroomGUIHandler::$webDirectory

protected

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

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

Modules/Chatroom/classes/class.ilChatroomGUIHandler.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ canModerate()

◆ execute()

◆ executeDefault()

◆ exitIfNoRoomExists()

◆ exitIfNoRoomPermission()

◆ getRoomByObjectId()

◆ hasPermission()

◆ isMainRoom()

◆ isSuccessful()

◆ redirectIfNoPermission()

◆ sendResponse()

Field Documentation

◆ $gui

◆ $ilCtrl

◆ $ilLng

◆ $ilUser

◆ $upload

◆ $webDirectory