ilChatroomPostMessageGUI Class Reference

Class ilChatroomPostMessageGUI. More...

Inheritance diagram for ilChatroomPostMessageGUI:

Collaboration diagram for ilChatroomPostMessageGUI:

Public Member Functions
	executeDefault ($method)
	Prepares and posts message fetched from $_REQUEST['message'] to recipients fetched from $_REQUEST['recipient'] and adds an entry to history if successful. More...
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...

Private Member Functions
	buildMessage ($messageString, $params, ilChatroomUser $chat_user)
	Instantiates stdClass, sets $data->user, $data->message, $data->public and $data->recipients using given $chat_user, $messageString and $params and returns $data. More...

Additional Inherited Members
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 inherited from ilChatroomGUIHandler
	$gui
	$ilUser
	$ilCtrl
	$ilLng
	$webDirectory
	$upload

Detailed Description

Class ilChatroomPostMessageGUI.

Author

Jan Posselt jposs.nosp@m.elt@.nosp@m.datab.nosp@m.ay.d.nosp@m.e

Version

$Id$

@TODO DELETE THIS

Definition at line 11 of file class.ilChatroomPostMessageGUI.php.

Member Function Documentation

buildMessage()

ilChatroomPostMessageGUI::buildMessage (   $messageString,   $params, ilChatroomUser  $chat_user  )

private

Instantiates stdClass, sets $data->user, $data->message, $data->public and $data->recipients using given $chat_user, $messageString and $params and returns $data.

Parameters

string	$messageString
array	$params
ilChatroomUser	$chat_user

Returns

stdClass

Definition at line 96 of file class.ilChatroomPostMessageGUI.php.

    {
        $data = new stdClass();
 
        $data->user      = $this->gui->object->getPersonalInformation($chat_user);
        $data->message   = $messageString;
        $data->timestamp = time() * 1000;//date( 'c' );
        $data->type      = 'message';
        isset($params['sub']) ? ($data->sub = $params['sub']) : false;
        $data->public          = (int) $params['public'];
        $data->recipients      = $params['recipients']; // ? explode(",", $params['recipients']) : array();
        $data->recipient_names = $params['recipient_names'];
 
        return $data;
    }

References $data, and $params.

Referenced by executeDefault().

Here is the caller graph for this function:

executeDefault()

ilChatroomPostMessageGUI::executeDefault

(

$method

)

Prepares and posts message fetched from $_REQUEST['message'] to recipients fetched from $_REQUEST['recipient'] and adds an entry to history if successful.

@global ilObjUser $ilUser

Parameters

string

$method

Reimplemented from ilChatroomGUIHandler.

Definition at line 20 of file class.ilChatroomPostMessageGUI.php.

    {
        throw new Exception('METHOD_NOT_IN_USE', 1456435027);
        global $ilUser, $ilCtrl;
 
        require_once 'Modules/Chatroom/classes/class.ilChatroom.php';
        require_once 'Modules/Chatroom/classes/class.ilChatroomUser.php';
 
        $this->redirectIfNoPermission('read');
 
        $room = ilChatroom::byObjectId($this->gui->object->getId());
 
        $chat_user = new ilChatroomUser($ilUser, $room);
        $user_id   = $chat_user->getUserId();
 
        if (!$room) {
            throw new Exception('unkown room');
        } elseif (!$room->isSubscribed($chat_user->getUserId())) {
            throw new Exception('not subscribed');
        } elseif (isset($_REQUEST['sub']) && !$room->userIsInPrivateRoom($_REQUEST['sub'], $chat_user->getUserId())) {
            $response = json_encode(array(
                'success' => false,
                'reason'  => 'not subscribed to private room'
            ));
            echo json_encode($response);
            exit;
        }
 
        $scope  = $room->getRoomId();
        $params = array();
 
        if (($recipient = $_REQUEST['recipient'])) {
            $params['recipients']      = join(',', array_unique(array($user_id, $recipient)));
            $params['recipient_names'] = implode(',', array($chat_user->getUsername(), $_REQUEST['recipient_name']));
            $params['public']          = isset($_REQUEST['public']) ? (int) $_REQUEST['public'] : 0;
        } else {
            $params['public'] = 1;
        }
 
        if ($_REQUEST['sub']) {
            $params['sub'] = (int) $_REQUEST['sub'];
        }
 
        $messageObject = $this->buildMessage(
            ilUtil::stripSlashes($_REQUEST['message']),
            $params,
            $chat_user
        );
 
        $message = json_encode($messageObject);
 
        $params = array_merge($params, array('message' => $message));
        //print_r($params);exit;
        $query     = http_build_query($params);
        $connector = $this->gui->getConnector();
        $response  = $connector->post($scope, $query);
 
        $responseObject = json_decode($response);
 
        if ($responseObject->success == true /*&& $room->getSetting( 'enable_history' )*/) {
            $room->addHistoryEntry($messageObject, $recipient, $publicMessage);
        }
 
        echo $response;
        exit;
    }

References ilChatroomGUIHandler\$ilCtrl, ilChatroomGUIHandler\$ilUser, $message, $params, $query, $response, buildMessage(), ilChatroom\byObjectId(), exit, ilChatroomGUIHandler\redirectIfNoPermission(), and ilUtil\stripSlashes().

Here is the call graph for this function:

---

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

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