ilChatroomUploadFileGUI Class Reference

Class ilChatroomUploadFileGUI Provides methods to upload a file. More...

Inheritance diagram for ilChatroomUploadFileGUI:

Collaboration diagram for ilChatroomUploadFileGUI:

Public Member Functions
	__construct ()
	executeDefault ($requestedMethod)
	Default execute method. More...
	uploadFile ()
	Saves file, fetched from $_FILES to specified upload path. More...
	getUploadPath ()
	Returns upload path. More...
	checkUploadPath ($path)
	Checks if given upload path exists, is readable or can be created. More...
	deliverFile ()
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
	displayLinkToUploadedFile ($room, $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)

Private Member Functions
	buildMessage ($messageString, $params, ilChatroomUser $chat_user)

Additional Inherited Members
Protected Attributes inherited from ilChatroomGUIHandler
	$gui
	$ilUser
	$ilCtrl
	$ilLng
	$rbacsystem

Detailed Description

Class ilChatroomUploadFileGUI Provides methods to upload a file.

Author

Andreas Kordosz akord.nosp@m.osz@.nosp@m.datab.nosp@m.ay.d.nosp@m.e

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilChatroomUploadFileGUI::__construct

(

)

Definition at line 14 of file class.ilChatroomUploadFileGUI.php.

        {
                throw new Exception('METHOD_NOT_IN_USE', 1456435027);
        }

Member Function Documentation

buildMessage()

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

private

Definition at line 165 of file class.ilChatroomUploadFileGUI.php.

References $data, $params, and date.

Referenced by displayLinkToUploadedFile().

        {
                $data = new stdClass();

                $data->user       = $this->gui->object->getPersonalInformation($chat_user);
                $data->message    = $messageString;
                $data->timestamp  = date('c');
                $data->type       = 'message';
                $data->public     = (int)$params['public'];
                $data->recipients = $params['recipients']; // ? explode(",", $params['recipients']) : array();

                return $data;
        }

Here is the caller graph for this function:

checkUploadPath()

ilChatroomUploadFileGUI::checkUploadPath

(

$path

)

Checks if given upload path exists, is readable or can be created.

Parameters

string

$path

Definition at line 95 of file class.ilChatroomUploadFileGUI.php.

References $path, and ilUtil\makeDirParents().

Referenced by uploadFile().

        {
                $err = false;

                switch(true)
                {
                        case !file_exists($path):
                                if(!ilUtil::makeDirParents($path))
                                {
                                        $err = true;
                                        $msg = 'Error: Upload path could not be created!';
                                }
                                break;

                        case !is_dir($path):
                                $err = true;
                                $msg = 'Error: Upload path is not a directory!';
                                break;

                        case !is_readable($path):
                                $err = true;
                                $msg = 'Error: Upload path is not readable!';
                                break;

                        default:
                }

                if($err)
                {
                        throw new Exception($msg);
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

deliverFile()

ilChatroomUploadFileGUI::deliverFile

(

)

Definition at line 179 of file class.ilChatroomUploadFileGUI.php.

        {
                // send file

                echo "hello world";
        }

displayLinkToUploadedFile()

ilChatroomUploadFileGUI::displayLinkToUploadedFile (   $room,   $chat_user  )

protected

Todo:

erwartet message als json

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

References ilChatroomGUIHandler\$ilCtrl, $params, $query, array, buildMessage(), exit, and ilUtil\stripSlashes().

Referenced by uploadFile().

        {
                global $ilCtrl;

                $scope            = $room->getRoomId();
                $params           = array();
                $params['public'] = 1;
                $message = json_encode($this->buildMessage(
                        json_encode(array(
                                'format'  => array(),
                                'content' => ilUtil::stripSlashes(
                                        'Eine neue Datei mit dem Link ' .
                                        $ilCtrl->getLinkTarget($this->gui, 'uploadFile-deliverFile') .
                                        ' wurde hochgeladen'
                                )
                        )), $params, $chat_user
                ));

                $params = array_merge($params, array('message' => $message));
                $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( $message, $recipient, $publicMessage );
                 }
                 */
                echo $response;
                exit;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

executeDefault()

ilChatroomUploadFileGUI::executeDefault

(

$requestedMethod

)

Default execute method.

Parameters

string

$requestedMethod

Definition at line 23 of file class.ilChatroomUploadFileGUI.php.

        {

        }

getUploadPath()

ilChatroomUploadFileGUI::getUploadPath

(

)

Returns upload path.

Returns

string

Definition at line 84 of file class.ilChatroomUploadFileGUI.php.

References $path, and ilUtil\getDataDir().

Referenced by uploadFile().

        {
                $path = ilUtil::getDataDir() . "/chatroom/" . $this->gui->object->getId() . "/uploads/";

                return $path;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

uploadFile()

ilChatroomUploadFileGUI::uploadFile

(

)

Saves file, fetched from $_FILES to specified upload path.

ilObjUser $ilUser

Todo:

: filename must be unique.

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

References $file, $filename, ilChatroomGUIHandler\$ilCtrl, ilChatroomGUIHandler\$ilUser, $target, ilChatroom\byObjectId(), checkUploadPath(), ilChatroom\checkUserPermissions(), displayLinkToUploadedFile(), getUploadPath(), and ilUtil\moveUploadedFile().

        {
                global $ilCtrl;

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

                $upload_path = $this->getUploadPath();

                $this->checkUploadPath($upload_path);

                $file     = $_FILES['file_to_upload']['tmp_name'];
                $filename = $_FILES['file_to_upload']['name'];
                $type     = $_FILES['file_to_upload']['type'];
                $target   = $upload_path . $filename;

                if(ilUtil::moveUploadedFile($file, $filename, $target))
                {
                        global $ilUser;

                        require_once 'Modules/Chatroom/classes/class.ilChatroom.php';
                        require_once 'Modules/Chatroom/classes/class.ilChatroomUser.php';

                        $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');
                        }
                        else if(!$room->isSubscribed($chat_user->getUserId()))
                        {
                                throw new Exception('not subscribed');
                        }

                        $room->saveFileUploadToDb($user_id, $filename, $type);
                        $this->displayLinkToUploadedFile($room, $chat_user);
                }

        }

Here is the call graph for this function:

---

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

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