Inheritance diagram for ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler:

Collaboration diagram for ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler:

Public Member Functions
	__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 ()

	getRemoveResult (string $identifier)

	getInfoResult (string $identifier)

Protected Attributes
const	CMD_UPLOAD = 'upload'

const	CMD_REMOVE = 'remove'

const	CMD_INFO = 'info'

	$http

	$ctrl

	$upload

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 13 of file AbstractCtrlAwareUploadHandler.php.

Constructor & Destructor Documentation

◆ __construct()

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

ilUIDemoFileUploadHandlerGUI constructor.

Reimplemented in ilMMUploadHandlerGUI.

Definition at line 35 of file AbstractCtrlAwareUploadHandler.php.

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

References $DIC, and ILIAS\FileDelivery\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.

Reimplemented in ilIndividualAssessmentMemberGUI.

Definition at line 80 of file AbstractCtrlAwareUploadHandler.php.

                                     : 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
                $content = json_encode($this->getUploadResult());
                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();
    }

References $response, ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler\CMD_INFO, ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler\CMD_REMOVE, ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler\CMD_UPLOAD, ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler\getFileIdentifierParameterName(), ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler\getInfoResult(), ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler\getRemoveResult(), ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler\getUploadResult(), ILIAS\FileDelivery\http(), and ILIAS\Filesystem\Stream\Streams\ofString().

Here is the call graph for this function:

◆ getExistingFileInfoURL()

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

@inheritDoc

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

Reimplemented in ilIndividualAssessmentMemberGUI, and ilUIDemoFileUploadHandlerGUI.

Definition at line 65 of file AbstractCtrlAwareUploadHandler.php.

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

◆ getFileIdentifierParameterName()

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

@inheritDoc

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

Reimplemented in ilIndividualAssessmentMemberGUI, and ilUIDemoFileUploadHandlerGUI.

Definition at line 47 of file AbstractCtrlAwareUploadHandler.php.

                                                     : string
    {
        return self::DEFAULT_FILE_ID_PARAMETER;
    }

References ILIAS\UI\Component\Input\Field\UploadHandler\DEFAULT_FILE_ID_PARAMETER.

Referenced by ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler\executeCommand(), ilMMUploadHandlerGUI\getInfoForExistingFiles(), ilMMUploadHandlerGUI\getInfoResult(), and ilMMUploadHandlerGUI\getRemoveResult().

Here is the caller graph for this function:

◆ getFileRemovalURL()

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

@inheritDoc

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

Reimplemented in ilIndividualAssessmentMemberGUI, and ilUIDemoFileUploadHandlerGUI.

Definition at line 74 of file AbstractCtrlAwareUploadHandler.php.

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

◆ getInfoForExistingFiles()

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

abstract

Parameters

array $file_ids

Returns: BasicFileInfoResult[]

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

Reimplemented in ilIndividualAssessmentMemberGUI, ilMMUploadHandlerGUI, and ilUIDemoFileUploadHandlerGUI.

◆ getInfoResult()

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

abstractprotected

Reimplemented in ilIndividualAssessmentMemberGUI, ilMMUploadHandlerGUI, and ilUIDemoFileUploadHandlerGUI.

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

Here is the caller graph for this function:

◆ getRemoveResult()

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

abstractprotected

Reimplemented in ilIndividualAssessmentMemberGUI, ilMMUploadHandlerGUI, and ilUIDemoFileUploadHandlerGUI.

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

Here is the caller graph for this function:

◆ getUploadResult()

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

abstractprotected

Reimplemented in ilIndividualAssessmentMemberGUI, and ilUIDemoFileUploadHandlerGUI.

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

Here is the caller graph for this function:

◆ getUploadURL()

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

@inheritDoc

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

Reimplemented in ilIndividualAssessmentMemberGUI, and ilUIDemoFileUploadHandlerGUI.

Definition at line 56 of file AbstractCtrlAwareUploadHandler.php.

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

Field Documentation

◆ $ctrl

ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler::$ctrl

protected

Definition at line 25 of file AbstractCtrlAwareUploadHandler.php.

◆ $http

ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler::$http

protected

Definition at line 21 of file AbstractCtrlAwareUploadHandler.php.

◆ $upload

ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler::$upload

protected

Definition at line 29 of file AbstractCtrlAwareUploadHandler.php.

◆ CMD_INFO

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

protected

Definition at line 17 of file AbstractCtrlAwareUploadHandler.php.

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

◆ CMD_REMOVE

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

protected

Definition at line 16 of file AbstractCtrlAwareUploadHandler.php.

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

◆ CMD_UPLOAD

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

protected

Definition at line 15 of file AbstractCtrlAwareUploadHandler.php.

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

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

src/FileUpload/Handler/AbstractCtrlAwareUploadHandler.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ executeCommand()

◆ getExistingFileInfoURL()

◆ getFileIdentifierParameterName()

◆ getFileRemovalURL()

◆ getInfoForExistingFiles()

◆ getInfoResult()

◆ getRemoveResult()

◆ getUploadResult()

◆ getUploadURL()

Field Documentation

◆ $ctrl

◆ $http

◆ $upload

◆ CMD_INFO

◆ CMD_REMOVE

◆ CMD_UPLOAD