ILIAS\User\Settings\NewAccountMail\UploadHandlerGUI Class Reference

Inheritance diagram for ILIAS\User\Settings\NewAccountMail\UploadHandlerGUI:

Collaboration diagram for ILIAS\User\Settings\NewAccountMail\UploadHandlerGUI:

Public Member Functions
	__construct (private readonly ResourceStorage $storage, private readonly Stakeholder $stakeholder)
	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 ()
	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

Author

Stephan Kergomard webma.nosp@m.ster.nosp@m.@kerg.nosp@m.omar.nosp@m.d.ch

Definition at line 35 of file class.UploadHandlerGUI.php.

Constructor & Destructor Documentation

__construct()

ILIAS\User\Settings\NewAccountMail\UploadHandlerGUI::__construct	(	private readonly ResourceStorage	$storage,
		private readonly Stakeholder	$stakeholder
	)

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

      {
 
        parent::__construct();
    }

References ILIAS\GlobalScreen\Provider\__construct().

Here is the call graph for this function:

Member Function Documentation

getInfoForExistingFiles()

ILIAS\User\Settings\NewAccountMail\UploadHandlerGUI::getInfoForExistingFiles

(

array

$file_ids

)

Returns

\ILIAS\FileUpload\Handler\BasicFileInfoResult[]

Reimplemented from ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler.

Definition at line 102 of file class.UploadHandlerGUI.php.

                                                            : array
    {
        $info_results = [];
        foreach ($file_ids as $identifier) {
            $info_results[] = $this->getInfoResult($identifier);
        }
 
        return $info_results;
    }

References ILIAS\User\Settings\NewAccountMail\UploadHandlerGUI\getInfoResult().

Here is the call graph for this function:

getInfoResult()

ILIAS\User\Settings\NewAccountMail\UploadHandlerGUI::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 79 of file class.UploadHandlerGUI.php.

                                                     : ?FileInfoResult
    {
        $title = $mime = 'unknown';
        $size = 0;
        if (($id = $this->storage->manage()->find($identifier)) !== null) {
            $revision = $this->storage->manage()->getCurrentRevision($id)->getInformation();
            $title = $revision->getTitle();
            $size = $revision->getSize();
            $mime = $revision->getMimeType();
        }
 
        return new BasicFileInfoResult(
            $this->getFileIdentifierParameterName(),
            $identifier,
            $title,
            $size,
            $mime
        );
    }

References $id, ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler\getFileIdentifierParameterName(), and ILIAS\FileUpload\Handler\FileInfoResult\getSize().

Referenced by ILIAS\User\Settings\NewAccountMail\UploadHandlerGUI\getInfoForExistingFiles().

Here is the call graph for this function:

Here is the caller graph for this function:

getRemoveResult()

ILIAS\User\Settings\NewAccountMail\UploadHandlerGUI::getRemoveResult ( string  $identifier )

protected

Reimplemented from ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler.

Definition at line 69 of file class.UploadHandlerGUI.php.

                                                          : HandlerResult
    {
        return new BasicHandlerResult(
            $this->getFileIdentifierParameterName(),
            HandlerResult::STATUS_OK,
            $identifier,
            'We just don\'t do anything here.'
        );
    }

References ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler\getFileIdentifierParameterName(), and ILIAS\FileUpload\Handler\HandlerResult\STATUS_OK.

Here is the call graph for this function:

getUploadResult()

ILIAS\User\Settings\NewAccountMail\UploadHandlerGUI::getUploadResult ( )

protected

Reimplemented from ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler.

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

                                        : HandlerResult
    {
        $this->upload->process();
 
        $result_array = $this->upload->getResults();
        $result = end($result_array);
 
        if (!($result instanceof UploadResult) || !$result->isOK()) {
            return new BasicHandlerResult(
                $this->getFileIdentifierParameterName(),
                HandlerResult::STATUS_FAILED,
                '',
                $result->getStatus()->getMessage()
            );
        }
 
        return new BasicHandlerResult(
            $this->getFileIdentifierParameterName(),
            HandlerResult::STATUS_OK,
            $this->storage->manage()->upload($result, $this->stakeholder)->serialize(),
            'file upload OK'
        );
    }

References ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler\getFileIdentifierParameterName(), ILIAS\FileUpload\Handler\HandlerResult\STATUS_FAILED, ILIAS\FileUpload\Handler\HandlerResult\STATUS_OK, and ILIAS\Repository\upload().

Here is the call graph for this function:

---

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

• components/ILIAS/User/src/Settings/NewAccountMail/class.UploadHandlerGUI.php