ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler Class Reference

Class ilCtrlAwareUploadHandler. More...

Inheritance diagram for ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler:

Collaboration diagram for ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler:

Public Member Functions
	__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
	readChunkedInformation ()
	getUploadResult ()
	getRemoveResult (string $identifier)

Protected Attributes
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 ilCtrlAwareUploadHandler.

Author

Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 30 of file AbstractCtrlAwareUploadHandler.php.

Constructor & Destructor Documentation

__construct()

ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler::__construct

(

)

ilUIDemoFileUploadHandlerGUI constructor.

Definition at line 50 of file AbstractCtrlAwareUploadHandler.php.

References $DIC, ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), and ILIAS\Repository\upload().

    {
        global $DIC;
        $this->ctrl = $DIC->ctrl();
        $this->upload = $DIC->upload();
        $this->http = $DIC->http();
    }

Here is the call graph for this function:

Member Function Documentation

executeCommand()

ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler::executeCommand

(

)

Since this is a ilCtrl aware UploadHandler executeCommand MUST be implemented.

The Implementation MUST make sure, the Upload and the Removal Command are handled correctly

Implements ILIAS\FileUpload\Handler\ilCtrlAwareUploadHandler.

Definition at line 105 of file AbstractCtrlAwareUploadHandler.php.

References $response, ILIAS\Repository\ctrl(), ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler\getFileIdentifierParameterName(), ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler\getInfoForExistingFiles(), ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler\getInfoResult(), ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler\getRemoveResult(), ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler\getUploadResult(), ILIAS\FileDelivery\http(), ILIAS\Filesystem\Stream\Streams\ofString(), ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler\readChunkedInformation(), and ILIAS\FileUpload\Handler\HandlerResult\STATUS_FAILED.

                                    : void
    {
        switch ($this->ctrl->getCmd()) {
            case self::CMD_UPLOAD:
                // Here you must save the file and tell the input item the
                // file-id which will be a FileStorage-ID in a later version
                // of ILIAS and for now you must implement an own ID which allows
                // identifying the file after the request
                try {
                    $this->readChunkedInformation();
                    $content = json_encode($this->getUploadResult());
                } catch (\Throwable $t) {
                    $content = json_encode(
                        new BasicHandlerResult(
                            $this->getFileIdentifierParameterName(),
                            BasicHandlerResult::STATUS_FAILED,
                            '',
                            $t->getMessage()
                        )
                    );
                }
                break;
            case self::CMD_REMOVE:
                // here you delete the previously uploaded file again, you know
                // which file to delete since you defined what 'my_file_id' is.
                $file_identifier = $this->http->request()->getQueryParams()[$this->getFileIdentifierParameterName()];
                $content = json_encode($this->getRemoveResult($file_identifier));
                break;
            case self::CMD_INFO:
                // here you give info about an already existing file
                // return a JsonEncoded \ILIAS\FileUpload\Handler\FileInfoResult
                $file_identifier = $this->http->request()->getQueryParams()[$this->getFileIdentifierParameterName()];
                $content = json_encode($this->getInfoResult($file_identifier));
                break;
            default:
                $content = '';
                break;
        }
        $response = $this->http->response()->withBody(Streams::ofString($content));
        $this->http->saveResponse($response);
        $this->http->sendResponse();
        $this->http->close();
    }

Here is the call graph for this function:

getExistingFileInfoURL()

ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler::getExistingFileInfoURL

(

)

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

Definition at line 80 of file AbstractCtrlAwareUploadHandler.php.

References ILIAS\Repository\ctrl().

                                            : string
    {
        return $this->ctrl->getLinkTargetByClass([static::class], self::CMD_INFO);
    }

Here is the call graph for this function:

getFileIdentifierParameterName()

ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler::getFileIdentifierParameterName

(

)

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

Definition at line 62 of file AbstractCtrlAwareUploadHandler.php.

Referenced by ilMMUploadHandlerGUI\__construct(), ilSkillProfileUploadHandlerGUI\__construct(), ILIAS\File\Icon\ilIconUploadHandlerGUI\__construct(), ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler\executeCommand(), ilMMUploadHandlerGUI\getInfoForExistingFiles(), ilSkillProfileUploadHandlerGUI\getInfoForExistingFiles(), ILIAS\File\Icon\ilIconUploadHandlerGUI\getInfoForExistingFiles(), ilMMUploadHandlerGUI\getInfoResult(), ilSkillProfileUploadHandlerGUI\getInfoResult(), ilMDCopyrightImageUploadHandlerGUI\getInfoResult(), ilCtrlAwareStorageUploadHandler\getInfoResult(), ilObjectCustomIconUploadHandlerGUI\getInfoResult(), ILIAS\File\Icon\ilIconUploadHandlerGUI\getInfoResult(), ilObjectTileImageUploadHandlerGUI\getInfoResult(), ILIAS\FileUpload\Handler\AbstractCtrlAwareIRSSUploadHandler\getInfoResult(), ilMMUploadHandlerGUI\getRemoveResult(), ilSkillProfileUploadHandlerGUI\getRemoveResult(), ilCtrlAwareStorageUploadHandler\getRemoveResult(), ilMDCopyrightImageUploadHandlerGUI\getRemoveResult(), ilObjectCustomIconUploadHandlerGUI\getRemoveResult(), ILIAS\File\Icon\ilIconUploadHandlerGUI\getRemoveResult(), ilObjectTileImageUploadHandlerGUI\getRemoveResult(), ILIAS\FileUpload\Handler\AbstractCtrlAwareIRSSUploadHandler\getRemoveResult(), ilObjBibliographicUploadHandlerGUI\getUploadResult(), ilOrgUnitTypeUploadHandlerGUI\getUploadResult(), ilStudyProgrammeTypeUploadHandlerGUI\getUploadResult(), ilCtrlAwareStorageUploadHandler\getUploadResult(), ilMDCopyrightImageUploadHandlerGUI\getUploadResult(), ILIAS\FileUpload\Handler\AbstractCtrlAwareIRSSUploadHandler\getUploadResult(), ilObjectCustomIconUploadHandlerGUI\getUploadResult(), ilFileVersionsUploadHandlerGUI\getUploadResult(), ilObjectTileImageUploadHandlerGUI\getUploadResult(), ILIAS\FileUpload\Handler\AbstractCtrlAwareIRSSUploadHandler\processChunckedUpload(), and ilFileVersionsUploadHandlerGUI\processChunckedUpload().

                                                    : string
    {
        return self::DEFAULT_FILE_ID_PARAMETER;
    }

Here is the caller graph for this function:

getFileRemovalURL()

ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler::getFileRemovalURL

(

)

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

Definition at line 89 of file AbstractCtrlAwareUploadHandler.php.

References ILIAS\Repository\ctrl().

                                       : string
    {
        return $this->ctrl->getLinkTargetByClass([static::class], self::CMD_REMOVE);
    }

Here is the call graph for this function:

getInfoForExistingFiles()

ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler::getInfoForExistingFiles ( array  $file_ids )

abstract

Parameters

array

$file_ids

Returns

BasicFileInfoResult[]

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

Referenced by ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler\executeCommand().

Here is the caller graph for this function:

getInfoResult()

ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler::getInfoResult ( string  $identifier )

abstract

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.

Referenced by ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler\executeCommand().

Here is the caller graph for this function:

getRemoveResult()

ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler::getRemoveResult ( string  $identifier )

abstractprotected

Referenced by ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler\executeCommand().

Here is the caller graph for this function:

getUploadResult()

ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler::getUploadResult ( )

abstractprotected

Referenced by ilMMUploadHandlerGUI\__construct(), ilSkillProfileUploadHandlerGUI\__construct(), ILIAS\File\Icon\ilIconUploadHandlerGUI\__construct(), and ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler\executeCommand().

Here is the caller graph for this function:

getUploadURL()

ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler::getUploadURL

(

)

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

Definition at line 71 of file AbstractCtrlAwareUploadHandler.php.

References ILIAS\Repository\ctrl().

                                  : string
    {
        return $this->ctrl->getLinkTargetByClass([static::class], self::CMD_UPLOAD);
    }

Here is the call graph for this function:

readChunkedInformation()

ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler::readChunkedInformation ( )

protected

Definition at line 94 of file AbstractCtrlAwareUploadHandler.php.

References ILIAS\FileDelivery\http(), and ILIAS\Repository\int().

Referenced by ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler\executeCommand().

                                               : void
    {
        $body = $this->http->request()->getParsedBody();
        $this->chunk_id = $body['dzuuid'] ?? null;
        $this->amount_of_chunks = (int) ($body['dztotalchunkcount'] ?? 0);
        $this->chunk_index = (int) ($body['dzchunkindex'] ?? 0);
        $this->chunk_total_size = (int) ($body['dztotalfilesize'] ?? 0);
        $this->is_chunked = ($this->chunk_id !== null && $this->amount_of_chunks > 0);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

supportsChunkedUploads()

ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler::supportsChunkedUploads

(

)

Returns

bool if this uploadhandler chan handle Chunked Uploads. These come in multiple requests and must be combined to a single file. If your UploadHandler can handle Chunked Uploads, you can use a UI with .

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

Definition at line 161 of file AbstractCtrlAwareUploadHandler.php.

                                            : bool
    {
        return false;
    }

Field Documentation

$amount_of_chunks

int ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler::$amount_of_chunks = 0

protected

Definition at line 42 of file AbstractCtrlAwareUploadHandler.php.

Referenced by ILIAS\FileUpload\Handler\AbstractCtrlAwareIRSSUploadHandler\processChunckedUpload(), and ilFileVersionsUploadHandlerGUI\processChunckedUpload().

$chunk_id

string ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler::$chunk_id = null

protected

Definition at line 43 of file AbstractCtrlAwareUploadHandler.php.

$chunk_index

int ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler::$chunk_index = 0

protected

Definition at line 41 of file AbstractCtrlAwareUploadHandler.php.

$chunk_total_size

int ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler::$chunk_total_size = 0

protected

Definition at line 44 of file AbstractCtrlAwareUploadHandler.php.

$ctrl

ilCtrl ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler::$ctrl

protected

Definition at line 37 of file AbstractCtrlAwareUploadHandler.php.

$http

HttpServices ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler::$http

protected

Definition at line 36 of file AbstractCtrlAwareUploadHandler.php.

$is_chunked

bool ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler::$is_chunked = false

protected

Definition at line 40 of file AbstractCtrlAwareUploadHandler.php.

$upload

FileUpload ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler::$upload

protected

Definition at line 38 of file AbstractCtrlAwareUploadHandler.php.

CMD_INFO

const ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler::CMD_INFO = 'info'

protected

Definition at line 34 of file AbstractCtrlAwareUploadHandler.php.

CMD_REMOVE

const ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler::CMD_REMOVE = 'remove'

protected

Definition at line 33 of file AbstractCtrlAwareUploadHandler.php.

CMD_UPLOAD

const ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler::CMD_UPLOAD = 'upload'

protected

Definition at line 32 of file AbstractCtrlAwareUploadHandler.php.

---

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

• src/FileUpload/Handler/AbstractCtrlAwareUploadHandler.php