ilChatroomGUIHandler Class Reference

Class ilChatroomGUIHandler. More...

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

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

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

References $gui, $ilCtrl, $ilUser, $lng, and $rbacsystem.

        {
                global $ilUser, $ilCtrl, $lng, $rbacsystem;

                $this->gui        = $gui;
                $this->ilUser     = $ilUser;
                $this->ilCtrl     = $ilCtrl;
                $this->ilLng      = $lng;
                $this->rbacsystem = $rbacsystem;
        }

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

References hasPermission(), and isMainRoom().

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

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

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

References executeDefault().

        {
                $this->ilLng->loadLanguageModule('chatroom');

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

Here is the call graph for this function:

executeDefault()

ilChatroomGUIHandler::executeDefault (   $requestedMethod )

abstract

Parameters

string

$requestedMethod

Returns

mixed

Referenced by ilChatroomInfoGUI\__construct(), execute(), and ilChatroomViewGUI\renderFileUploadForm().

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

References array, and sendResponse().

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

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

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

References array, canModerate(), and sendResponse().

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

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

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

References ilChatroom\byObjectId().

Referenced by ilChatroomClearGUI\executeDefault().

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

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

Referenced by canModerate().

        {
                return $this->rbacsystem->checkAccess($permission, $this->gui->ref_id);
        }

Here is the caller graph for this function:

isMainRoom()

ilChatroomGUIHandler::isMainRoom (   $subRoomId )

protected

Parameters

int

$subRoomId

Returns

bool

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

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

        {
                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

$response

Returns

boolean

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

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

        {
                $response = json_decode($response, true);

                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

array | string

$permission

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

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

Referenced by ilChatroomInfoGUI\__construct(), ilChatroomBanGUI\active(), ilChatroomPrivateRoomGUI\create(), ilChatroomClearGUI\executeDefault(), ilChatroomKickGUI\executeDefault(), and ilChatroomInviteUsersToPrivateRoomGUI\inviteById().

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

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

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

References 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().

        {
                echo json_encode($response);
                exit;
        }

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 __construct(), and ilChatroomInfoGUI\createInfoScreenGUI().

$ilCtrl

ilChatroomGUIHandler::$ilCtrl

protected

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

Referenced by ilChatroomHistoryGUI\__construct(), ilChatroomInfoGUI\__construct(), ilChatroomSettingsGUI\__construct(), __construct(), ilChatroomViewGUI\cancelJoin(), ilChatroomAdminSmileyGUI\deleteSmileyObject(), ilChatroomUploadFileGUI\displayLinkToUploadedFile(), ilChatroomPostMessageGUI\executeDefault(), ilChatroomInitialGUI\executeDefault(), ilChatroomBanGUI\executeDefault(), ilChatroomAdminSmileyGUI\initSmiliesEditForm(), ilChatroomAdminSmileyGUI\initSmiliesForm(), ilChatroomViewGUI\renderFileUploadForm(), ilChatroomKickGUI\sub(), ilChatroomAdminSmileyGUI\updateSmiliesObject(), ilChatroomUploadFileGUI\uploadFile(), and ilChatroomAdminSmileyGUI\uploadSmileyObject().

$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 ilChatroomHistoryGUI\__construct(), __construct(), ilChatroomPostMessageGUI\executeDefault(), ilChatroomInitialGUI\executeDefault(), ilChatroomViewGUI\renderFileUploadForm(), ilChatroomKickGUI\sub(), and ilChatroomUploadFileGUI\uploadFile().

$rbacsystem

ilChatroomGUIHandler::$rbacsystem

protected

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

Referenced by ilChatroomInfoGUI\__construct(), __construct(), ilChatroomAdminSmileyGUI\deleteSmileyObject(), ilChatroomAdminSmileyGUI\editSmiliesObject(), ilChatroomInitialGUI\executeDefault(), ilChatroomAdminSmileyGUI\initSmiliesEditForm(), ilChatroomAdminSmileyGUI\showEditSmileyEntryFormObject(), ilChatroomAdminSmileyGUI\updateSmiliesObject(), and ilChatroomAdminSmileyGUI\uploadSmileyObject().

---

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

• Modules/Chatroom/classes/class.ilChatroomGUIHandler.php