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...
	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...
	getInfoForExistingFiles (array $file_ids)
	executeCommand ()
	Since this is a ilCtrl aware UploadHandler executeCommand MUST be implemented. More...
	getFileIdentifierParameterName ()
	getUploadURL ()
	getFileRemovalURL ()
	getExistingFileInfoURL ()
	getInfoForExistingFiles (array $file_ids)

Protected Member Functions
	getUploadResult ()
	@inheritDoc More...
	getRemoveResult (string $identifier)
	getInfoResult (string $identifier)
	getUploadResult ()
	getRemoveResult (string $identifier)
	getInfoResult (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'
	$http
	$ctrl
	$upload

Detailed Description

Class ilUIDemoFileUploadHandlerGUI.

@ilCtrl_isCalledBy ilUIDemoFileUploadHandlerGUI: ilUIPluginRouterGUI

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

Member Function Documentation

getExistingFileInfoURL()

ilUIDemoFileUploadHandlerGUI::getExistingFileInfoURL

(

)

@inheritDoc

Reimplemented from ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler.

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

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

getFileIdentifierParameterName()

ilUIDemoFileUploadHandlerGUI::getFileIdentifierParameterName

(

)

@inheritDoc

Reimplemented from ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler.

Definition at line 53 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.

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

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

getInfoForExistingFiles()

ilUIDemoFileUploadHandlerGUI::getInfoForExistingFiles

(

array

$file_ids

)

Parameters

array

$file_ids

Returns

BasicFileInfoResult[]

Reimplemented from ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler.

Definition at line 87 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 )

protected

Reimplemented from ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler.

Definition at line 81 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 72 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 62 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.

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

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

---

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

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