ilChatroomPrivateRoomGUI Class Reference

Class ilChatroomPrivateRoomGUI. More...

Inheritance diagram for ilChatroomPrivateRoomGUI:

Collaboration diagram for ilChatroomPrivateRoomGUI:

Public Member Functions
	__construct (ilChatroomObjectGUI $gui)
	ilChatroomPrivateRoomGUI constructor. More...
	executeDefault ($method)
	create ()
	delete ()
	leave ()
	enter ()
	listUsers ()
Public Member Functions inherited from ilChatroomGUIHandler
	__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
	exitIfNoRoomSubscription ($room, $chat_user)
	exitIfEnterRoomIsNotAllowed ($room, $subRoom, $chat_user)
Protected Member Functions inherited from ilChatroomGUIHandler
	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
	$ilUser
Protected Attributes inherited from ilChatroomGUIHandler
	$gui
	$ilUser
	$ilCtrl
	$ilLng
	$webDirectory
	$upload

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 13 of file class.ilChatroomPrivateRoomGUI.php.

Constructor & Destructor Documentation

__construct()

ilChatroomPrivateRoomGUI::__construct

(

ilChatroomObjectGUI

$gui

)

ilChatroomPrivateRoomGUI constructor.

Parameters

ilChatroomObjectGUI

$gui

Reimplemented from ilChatroomGUIHandler.

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

    {
        global $ilUser;
 
        $this->ilUser = $ilUser;
 
        parent::__construct($gui);
    }

References ilChatroomGUIHandler\$gui, and $ilUser.

Member Function Documentation

create()

ilChatroomPrivateRoomGUI::create

(

)

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

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

References $response, $title, ilChatroom\byObjectId(), ilChatroomGUIHandler\exitIfNoRoomExists(), exitIfNoRoomSubscription(), ilChatroomGUIHandler\isSuccessful(), ilChatroomGUIHandler\redirectIfNoPermission(), ilChatroomGUIHandler\sendResponse(), and ilUtil\stripSlashes().

Here is the call graph for this function:

delete()

ilChatroomPrivateRoomGUI::delete

(

)

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

    {
        $room      = ilChatroom::byObjectId($this->gui->object->getId());
        $subRoom   = $_REQUEST['sub'];
        $chat_user = new ilChatroomUser($this->ilUser, $room);
 
        $this->exitIfNoRoomExists($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(), and ilChatroomGUIHandler\sendResponse().

Here is the call graph for this function:

enter()

ilChatroomPrivateRoomGUI::enter

(

)

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

    {
        global $ilUser;
 
        $this->redirectIfNoPermission('read');
 
        $room      = ilChatroom::byObjectId($this->gui->object->getId());
        $subRoom   = $_REQUEST['sub'];
        $chat_user = new ilChatroomUser($ilUser, $room);
 
        $this->exitIfNoRoomExists($room);
        $this->exitIfEnterRoomIsNotAllowed($room, $subRoom, $chat_user);
 
        /*$params = array();
 
        $params['user'] = $chat_user->getUserId();
        $params['sub'] = $_REQUEST['sub'];
        $params['message'] = json_encode( array(
            'type' => 'private_room_entered',
            'user' => $user_id
        ));*/
 
        //$query = http_build_query( $params );
        $connector = $this->gui->getConnector();
        $response  = $connector->sendEnterPrivateRoom($room->getRoomId(), $subRoom, $chat_user->getUserId());
 
        if ($this->isSuccessful($response)) {
            $room->subscribeUserToPrivateRoom($subRoom, $chat_user->getUserId());
        }
 
        /*$message = json_encode( array(
            'type' => 'private_room_entered',
            'user' => $params['user'],
            'sub'       => $params['sub']
        ));
 
        $connector->sendMessage( $room->getRoomId(), $message, array('public' => 1, 'sub' => $params['sub']) );*/
 
        $this->sendResponse($response);
    }

References $ilUser, $response, ilChatroom\byObjectId(), exitIfEnterRoomIsNotAllowed(), ilChatroomGUIHandler\exitIfNoRoomExists(), ilChatroomGUIHandler\isSuccessful(), ilChatroomGUIHandler\redirectIfNoPermission(), and ilChatroomGUIHandler\sendResponse().

Here is the call graph for this function:

executeDefault()

ilChatroomPrivateRoomGUI::executeDefault

(

$requestedMethod

)

Parameters

string

$requestedMethod

Returns

mixed

Reimplemented from ilChatroomGUIHandler.

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

    {
    }

exitIfEnterRoomIsNotAllowed()

ilChatroomPrivateRoomGUI::exitIfEnterRoomIsNotAllowed (   $room,   $subRoom,   $chat_user  )

protected

Parameters

ilChatroom	$room
int	$subRoom
ilChatroomUser	$chat_user

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

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

References ilChatroomGUIHandler\sendResponse().

Referenced by enter().

Here is the call graph for this function:

Here is the caller graph for this function:

exitIfNoRoomSubscription()

ilChatroomPrivateRoomGUI::exitIfNoRoomSubscription (   $room,   $chat_user  )

protected

Parameters

ilChatroom	$room
ilChatroomUser	$chat_user

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

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

References 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 97 of file class.ilChatroomPrivateRoomGUI.php.

    {
        $room      = ilChatroom::byObjectId($this->gui->object->getId());
        $chat_user = new ilChatroomUser($this->ilUser, $room);
        $subRoom   = $_REQUEST['sub'];
 
        $this->exitIfNoRoomExists($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(), and ilChatroomGUIHandler\sendResponse().

Here is the call graph for this function:

listUsers()

ilChatroomPrivateRoomGUI::listUsers

(

)

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

    {
        $room = ilChatroom::byObjectId($this->gui->object->getId());
 
        $response = $room->listUsersInPrivateRoom($_REQUEST['sub']);
        $this->sendResponse($response);
    }

References $response, ilChatroom\byObjectId(), and ilChatroomGUIHandler\sendResponse().

Here is the call graph for this function:

Field Documentation

$ilUser

ilChatroomPrivateRoomGUI::$ilUser

protected

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

Referenced by __construct(), and enter().

---

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

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