ilObjFileUploadHandlerGUI Class Reference

Inheritance diagram for ilObjFileUploadHandlerGUI:

Collaboration diagram for ilObjFileUploadHandlerGUI:

Public Member Functions
	__construct ()
	getUploadURL ()
	getExistingFileInfoURL ()
	getFileRemovalURL ()
	overrides parent method in order to provide an async URL. More...
	getInfoResult (string $identifier)
	getInfoForExistingFiles (array $file_ids)
Public Member Functions inherited from ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler
	__construct ()
	ilUIDemoFileUploadHandlerGUI constructor. More...
	getFileIdentifierParameterName ()
	getUploadURL ()
	getExistingFileInfoURL ()
	getFileRemovalURL ()
	executeCommand ()
	Since this is a ilCtrl aware UploadHandler executeCommand MUST be implemented. More...
	getInfoResult (string $identifier)
	getInfoForExistingFiles (array $file_ids)
	supportsChunkedUploads ()

Protected Member Functions
	getUploadResult ()
	getRemoveResult (string $identifier)
Protected Member Functions inherited from ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler
	readChunkedInformation ()
	getUploadResult ()
	getRemoveResult (string $identifier)

Private Attributes
Services	$storage
ilObjFileStakeholder	$stakeholder
array	$class_path = [self::class]

Additional Inherited Members
Data Fields inherited from ILIAS\UI\Component\Input\Field\UploadHandler
const	DEFAULT_FILE_ID_PARAMETER = 'file_id'
Protected Attributes inherited from ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler
const	CMD_UPLOAD = 'upload'
const	CMD_REMOVE = 'remove'
const	CMD_INFO = 'info'
HttpServices	$http
ilCtrl	$ctrl
FileUpload	$upload
bool	$is_chunked = false
int	$chunk_index = 0
int	$amount_of_chunks = 0
string	$chunk_id = null
int	$chunk_total_size = 0

Detailed Description

Author

Thibeau Fuhrer thf@s.nosp@m.tude.nosp@m.r-rai.nosp@m.mann.nosp@m..ch ilObjFileUploadHandlerGUI: ilObjFileGUI, ilRepositoryGUI, ilDashboardGUI

Definition at line 33 of file class.ilObjFileUploadHandlerGUI.php.

Constructor & Destructor Documentation

__construct()

ilObjFileUploadHandlerGUI::__construct

(

)

Definition at line 39 of file class.ilObjFileUploadHandlerGUI.php.

References $DIC, and ILIAS\GlobalScreen\Provider\__construct().

    {
        global $DIC;

        $this->storage = $DIC->resourceStorage();
        $this->stakeholder = new ilObjFileStakeholder($DIC->user()->getId());

        parent::__construct();
    }

Here is the call graph for this function:

Member Function Documentation

getExistingFileInfoURL()

ilObjFileUploadHandlerGUI::getExistingFileInfoURL

(

)

Implements ILIAS\UI\Component\Input\Field\UploadHandler.

Definition at line 60 of file class.ilObjFileUploadHandlerGUI.php.

References ILIAS\Repository\ctrl().

                                            : string
    {
        return $this->ctrl->getLinkTargetByClass($this->class_path, self::CMD_INFO, null, true);
    }

Here is the call graph for this function:

getFileRemovalURL()

ilObjFileUploadHandlerGUI::getFileRemovalURL

(

)

overrides parent method in order to provide an async URL.

Returns

string

Implements ILIAS\UI\Component\Input\Field\UploadHandler.

Definition at line 69 of file class.ilObjFileUploadHandlerGUI.php.

References ILIAS\Repository\ctrl().

                                       : string
    {
        return $this->ctrl->getLinkTargetByClass($this->class_path, self::CMD_REMOVE, null, true);
    }

Here is the call graph for this function:

getInfoForExistingFiles()

ilObjFileUploadHandlerGUI::getInfoForExistingFiles

(

array

$file_ids

)

Parameters

array

$file_ids

Returns

FileInfoResult[]

Implements ILIAS\UI\Component\Input\Field\UploadHandler.

Definition at line 140 of file class.ilObjFileUploadHandlerGUI.php.

References getInfoResult().

                                                            : array
    {
        $info_results = [];
        foreach ($file_ids as $identifier) {
            $info_results[] = $this->getInfoResult($identifier);
        }

        return $info_results;
    }

Here is the call graph for this function:

getInfoResult()

ilObjFileUploadHandlerGUI::getInfoResult

(

string

$identifier

)

Parameters

string

$identifier

Returns

FileInfoResult

Implements ILIAS\UI\Component\Input\Field\UploadHandler.

Definition at line 121 of file class.ilObjFileUploadHandlerGUI.php.

References $id, ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler\getFileIdentifierParameterName(), and ILIAS\FileUpload\Handler\FileInfoResult\getSize().

Referenced by getInfoForExistingFiles().

                                                     : ?FileInfoResult
    {
        if (null !== ($id = $this->storage->manage()->find($identifier))) {
            $revision = $this->storage->manage()->getCurrentRevision($id)->getInformation();
            $title = $revision->getTitle();
            $size = $revision->getSize();
            $mime = $revision->getMimeType();
        } else {
            $title = $mime = 'unknown';
            $size = 0;
        }

        return new BasicFileInfoResult($this->getFileIdentifierParameterName(), $identifier, $title, $size, $mime);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getRemoveResult()

ilObjFileUploadHandlerGUI::getRemoveResult ( string  $identifier )

protected

Parameters

string

$identifier

Returns

HandlerResult

Definition at line 103 of file class.ilObjFileUploadHandlerGUI.php.

References $id, $message, and ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler\getFileIdentifierParameterName().

                                                          : HandlerResult
    {
        if (null !== ($id = $this->storage->manage()->find($identifier))) {
            $this->storage->manage()->remove($id, $this->stakeholder);
            $status = HandlerResult::STATUS_OK;
            $message = "file removal OK";
        } else {
            $status = HandlerResult::STATUS_OK;
            $message = "file with identifier '$identifier' doesn't exist, nothing to do.";
        }

        return new BasicHandlerResult($this->getFileIdentifierParameterName(), $status, $identifier, $message);
    }

Here is the call graph for this function:

getUploadResult()

ilObjFileUploadHandlerGUI::getUploadResult ( )

protected

Returns

HandlerResult

Exceptions

Definition at line 78 of file class.ilObjFileUploadHandlerGUI.php.

References $message, ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler\getFileIdentifierParameterName(), ILIAS\FileUpload\DTO\UploadResult\isOK(), and ILIAS\Repository\upload().

                                        : HandlerResult
    {
        $this->upload->register(new ilCountPDFPagesPreProcessors());
        $this->upload->process();

        $result_array = $this->upload->getResults();
        $result = end($result_array);

        if ($result instanceof UploadResult && $result->isOK()) {
            $identifier = $this->storage->manage()->upload($result, $this->stakeholder)->serialize();
            $status = HandlerResult::STATUS_OK;
            $message = "file upload OK";
        } else {
            $identifier = '';
            $status = HandlerResult::STATUS_FAILED;
            $message = $result->getStatus()->getMessage();
        }

        return new BasicHandlerResult($this->getFileIdentifierParameterName(), $status, $identifier, $message);
    }

Here is the call graph for this function:

getUploadURL()

ilObjFileUploadHandlerGUI::getUploadURL

(

)

Implements ILIAS\UI\Component\Input\Field\UploadHandler.

Definition at line 52 of file class.ilObjFileUploadHandlerGUI.php.

References ILIAS\Repository\ctrl().

                                  : string
    {
        return $this->ctrl->getLinkTargetByClass($this->class_path, self::CMD_UPLOAD, null, true);
    }

Here is the call graph for this function:

Field Documentation

$class_path

array ilObjFileUploadHandlerGUI::$class_path = [self::class]

private

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

$stakeholder

ilObjFileStakeholder ilObjFileUploadHandlerGUI::$stakeholder

private

Definition at line 36 of file class.ilObjFileUploadHandlerGUI.php.

$storage

Services ilObjFileUploadHandlerGUI::$storage

private

Definition at line 35 of file class.ilObjFileUploadHandlerGUI.php.

---

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

• Modules/File/classes/class.ilObjFileUploadHandlerGUI.php