ilCtrlAwareStorageUploadHandler Class Reference

Class ilCtrlAwareStorageUploadHandler. More...

Inheritance diagram for ilCtrlAwareStorageUploadHandler:

Collaboration diagram for ilCtrlAwareStorageUploadHandler:

Public Member Functions
	__construct (ResourceStakeholder $stakeholder)
	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)

Protected Attributes
ResourceStakeholder	$stakeholder
ILIAS ResourceStorage Services	$storage
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

Additional Inherited Members
Data Fields inherited from ILIAS\UI\Component\Input\Field\UploadHandler
const	DEFAULT_FILE_ID_PARAMETER = 'file_id'

Detailed Description

Class ilCtrlAwareStorageUploadHandler.

Author

Fabian Schmid fabia.nosp@m.n@sr.nosp@m..solu.nosp@m.tion.nosp@m.s

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

Constructor & Destructor Documentation

__construct()

ilCtrlAwareStorageUploadHandler::__construct

(

ResourceStakeholder

$stakeholder

)

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

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

    {
        global $DIC;
        parent::__construct();
        $this->storage = $DIC->resourceStorage();
        $this->stakeholder = $stakeholder;
    }

Here is the call graph for this function:

Member Function Documentation

getInfoForExistingFiles()

ilCtrlAwareStorageUploadHandler::getInfoForExistingFiles

(

array

$file_ids

)

Parameters

array

$file_ids

Returns

BasicFileInfoResult[]

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

Definition at line 106 of file class.ilCtrlAwareStorageUploadHandler.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()

ilCtrlAwareStorageUploadHandler::getInfoResult

(

string

$identifier

)

Returns

null|FileInfoResult for the file with the given identifier or null if the file does not exist.

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

Definition at line 91 of file class.ilCtrlAwareStorageUploadHandler.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()

ilCtrlAwareStorageUploadHandler::getRemoveResult ( string  $identifier )

protected

Definition at line 77 of file class.ilCtrlAwareStorageUploadHandler.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()

ilCtrlAwareStorageUploadHandler::getUploadResult ( )

protected

Definition at line 50 of file class.ilCtrlAwareStorageUploadHandler.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()) {
            if (!$this->is_chunked) {
                $identifier = $this->storage->manage()->upload($result, $this->stakeholder)->serialize();
                $status = HandlerResult::STATUS_OK;
                $message = "file upload OK";
            } else {
                $identifier = '';
                $status = HandlerResult::STATUS_FAILED;
                $message = 'chunking not supported';
            }
        } 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:

Field Documentation

$stakeholder

ResourceStakeholder ilCtrlAwareStorageUploadHandler::$stakeholder

protected

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

Referenced by __construct().

$storage

ILIAS ResourceStorage Services ilCtrlAwareStorageUploadHandler::$storage

protected

Definition at line 40 of file class.ilCtrlAwareStorageUploadHandler.php.

---

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

• Services/FileServices/classes/UploadService/class.ilCtrlAwareStorageUploadHandler.php