ilUIDemoFileUploadHandlerGUI Class Reference

Class ilUIDemoFileUploadHandlerGUI. More...

Inheritance diagram for ilUIDemoFileUploadHandlerGUI:

Collaboration diagram for ilUIDemoFileUploadHandlerGUI:

Public Member Functions
	getUploadURL ()
	@inheritDoc More...
	getExistingFileInfoURL ()
	@inheritDoc More...
	getFileRemovalURL ()
	@inheritDoc More...
	getFileIdentifierParameterName ()
	@inheritDoc More...
	getInfoResult (string $identifier)
	getInfoForExistingFiles (array $file_ids)
Public Member Functions inherited from ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler
	__construct ()
	ilUIDemoFileUploadHandlerGUI constructor. More...
	getFileIdentifierParameterName ()
	@inheritDoc More...
	getUploadURL ()
	@inheritDoc More...
	getExistingFileInfoURL ()
	@inheritDoc More...
	getFileRemovalURL ()
	@inheritDoc More...
	executeCommand ()
	Since this is a ilCtrl aware UploadHandler executeCommand MUST be implemented. More...
	getInfoResult (string $identifier)
	getInfoForExistingFiles (array $file_ids)
	supportsChunkedUploads ()
	executeCommand ()
	Since this is a ilCtrl aware UploadHandler executeCommand MUST be implemented. More...
	getFileIdentifierParameterName ()
	getUploadURL ()
	getFileRemovalURL ()
	getExistingFileInfoURL ()
	getInfoForExistingFiles (array $file_ids)
	getInfoResult (string $identifier)
	supportsChunkedUploads ()

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

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

Class ilUIDemoFileUploadHandlerGUI.

@ilCtrl_isCalledBy ilUIDemoFileUploadHandlerGUI: ilUIPluginRouterGUI

Definition at line 31 of file class.ilUIDemoFileUploadHandlerGUI.php.

Member Function Documentation

getExistingFileInfoURL()

ilUIDemoFileUploadHandlerGUI::getExistingFileInfoURL

(

)

@inheritDoc

Reimplemented from ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler.

Reimplemented in ilUIAsyncDemoFileUploadHandler, and ilUIAsyncDemoFileUploadHandlerGUI.

Definition at line 45 of file class.ilUIDemoFileUploadHandlerGUI.php.

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

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

getFileIdentifierParameterName()

ilUIDemoFileUploadHandlerGUI::getFileIdentifierParameterName

(

)

@inheritDoc

Reimplemented from ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler.

Definition at line 68 of file class.ilUIDemoFileUploadHandlerGUI.php.

                                                    : string
    {
        return 'my_file_id';
    }

Referenced by getInfoForExistingFiles(), getInfoResult(), getRemoveResult(), and getUploadResult().

Here is the caller graph for this function:

getFileRemovalURL()

ilUIDemoFileUploadHandlerGUI::getFileRemovalURL

(

)

@inheritDoc

Reimplemented from ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler.

Reimplemented in ilUIAsyncDemoFileUploadHandler, and ilUIAsyncDemoFileUploadHandlerGUI.

Definition at line 54 of file class.ilUIDemoFileUploadHandlerGUI.php.

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

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

getInfoForExistingFiles()

ilUIDemoFileUploadHandlerGUI::getInfoForExistingFiles

(

array

$file_ids

)

Parameters

array

$file_ids

Returns

BasicFileInfoResult[]

Reimplemented from ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler.

Definition at line 108 of file class.ilUIDemoFileUploadHandlerGUI.php.

                                                            : array
    {
        $infos = [];
        foreach ($file_ids as $file_id) {
            $infos[] = new BasicFileInfoResult(
                $this->getFileIdentifierParameterName(),
                $file_id,
                "Name $file_id.txt",
                rand(1000, 2000),
                "text/plain"
            );
        }
 
        return $infos;
    }

References getFileIdentifierParameterName().

Here is the call graph for this function:

getInfoResult()

ilUIDemoFileUploadHandlerGUI::getInfoResult

(

string

$identifier

)

Returns

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

Reimplemented from ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler.

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

                                                     : ?FileInfoResult
    {
        return new BasicFileInfoResult(
            $this->getFileIdentifierParameterName(),
            $identifier,
            "My funny Testfile $identifier.txt",
            64,
            ""
        );
    }

References getFileIdentifierParameterName().

Here is the call graph for this function:

getRemoveResult()

ilUIDemoFileUploadHandlerGUI::getRemoveResult ( string  $identifier )

protected

Reimplemented from ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler.

Definition at line 87 of file class.ilUIDemoFileUploadHandlerGUI.php.

                                                          : HandlerResult
    {
        $status = HandlerResult::STATUS_OK;
        $message = 'File Deleted';
 
        return new BasicHandlerResult($this->getFileIdentifierParameterName(), $status, $identifier, $message);
    }

References $message, and getFileIdentifierParameterName().

Here is the call graph for this function:

getUploadResult()

ilUIDemoFileUploadHandlerGUI::getUploadResult ( )

protected

@inheritDoc

Reimplemented from ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler.

Definition at line 77 of file class.ilUIDemoFileUploadHandlerGUI.php.

                                        : HandlerResult
    {
        $status = HandlerResult::STATUS_OK;
        $identifier = md5(random_bytes(65));
        $message = 'Everything ok';
 
        return new BasicHandlerResult($this->getFileIdentifierParameterName(), $status, $identifier, $message);
    }

References $message, and getFileIdentifierParameterName().

Here is the call graph for this function:

getUploadURL()

ilUIDemoFileUploadHandlerGUI::getUploadURL

(

)

@inheritDoc

Reimplemented from ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler.

Reimplemented in ilUIAsyncDemoFileUploadHandler, and ilUIAsyncDemoFileUploadHandlerGUI.

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

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

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

---

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

• Services/UI/classes/class.ilUIDemoFileUploadHandlerGUI.php