Inheritance diagram for ilMailFormUploadHandlerGUI:

Collaboration diagram for ilMailFormUploadHandlerGUI:

Public Member Functions
	__construct ()
	ilUIDemoFileUploadHandlerGUI constructor. More...

	getInfoResult (string $identifier)

	getInfoForExistingFiles (array $file_ids)

	getInlineConsumer (string $identifier)

	removeFileForIdentifier (string $identifier)

	getStreamConsumer (string $identifier)

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
	getRemoveResult (string $identifier)

Protected Member Functions inherited from ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler
	readChunkedInformation ()

	getUploadResult ()

	getRemoveResult (string $identifier)

Private Member Functions
	mailFiles ()

	acceptedComposeResource (string $identifier)

	requireComposeResource (string $identifier)

Private Attributes
readonly ILIAS ResourceStorage Services	$storage

readonly ilMailAttachmentStakeholder	$stakeholder

readonly ilLanguage	$lng

readonly int	$user_id

ilFileDataMail	$mail_files = null

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

Definition at line 32 of file class.ilMailFormUploadHandlerGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilMailFormUploadHandlerGUI::__construct ( )

ilUIDemoFileUploadHandlerGUI constructor.

Reimplemented from ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler.

Definition at line 40 of file class.ilMailFormUploadHandlerGUI.php.

    {
        global $DIC;
        parent::__construct();
        $this->user_id = $DIC->user()->getId();
        $this->storage = $DIC->resourceStorage();
        $this->stakeholder = new ilMailAttachmentStakeholder();
        $this->lng = $DIC->language();
    }

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), and ILIAS\Repository\lng().

Here is the call graph for this function:

Member Function Documentation

◆ acceptedComposeResource()

ilMailFormUploadHandlerGUI::acceptedComposeResource ( string $identifier )

private

Definition at line 132 of file class.ilMailFormUploadHandlerGUI.php.

                                                                : ?ResourceIdentification
    {
        $id = $this->storage->manage()->find($identifier);
        if ($id === null || !$this->mailFiles()->canUseResourceInCompose($id)) {
            return null;
        }
 
        return $id;
    }

References $id, and mailFiles().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getInfoForExistingFiles()

ilMailFormUploadHandlerGUI::getInfoForExistingFiles ( array $file_ids )

Parameters

array $file_ids

Returns: BasicFileInfoResult[]

Reimplemented from ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler.

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

                                                            : array
    {
        $infos = [];
        foreach ($file_ids as $file_id) {
            $id = $this->acceptedComposeResource($file_id);
            if ($id === null) {
                continue;
            }
            $r = $this->storage->manage()->getCurrentRevision($id)->getInformation();
 
            $infos[] = new BasicFileInfoResult($this->getFileIdentifierParameterName(), $file_id, $r->getTitle(), $r->getSize(), $r->getMimeType());
        }
 
        return $infos;
    }

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

Here is the call graph for this function:

◆ getInfoResult()

ilMailFormUploadHandlerGUI::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 85 of file class.ilMailFormUploadHandlerGUI.php.

                                                     : FileInfoResult
    {
        $id = $this->acceptedComposeResource($identifier);
        if ($id === null) {
            return new BasicFileInfoResult($this->getFileIdentifierParameterName(), 'unknown', 'unknown', 0, 'unknown');
        }
        $r = $this->storage->manage()->getCurrentRevision($id)->getInformation();
 
        return new BasicFileInfoResult($this->getFileIdentifierParameterName(), $identifier, $r->getTitle(), $r->getSize(), $r->getMimeType());
    }

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

Here is the call graph for this function:

◆ getInlineConsumer()

ilMailFormUploadHandlerGUI::getInlineConsumer ( string $identifier )

Definition at line 112 of file class.ilMailFormUploadHandlerGUI.php.

                                                         : InlineConsumer
    {
        return $this->storage->consume()->inline($this->requireComposeResource($identifier));
    }

References requireComposeResource().

Here is the call graph for this function:

◆ getRemoveResult()

ilMailFormUploadHandlerGUI::getRemoveResult ( string $identifier )

protected

Reimplemented from ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler.

Definition at line 75 of file class.ilMailFormUploadHandlerGUI.php.

                                                          : HandlerResultInterface
    {
        $id = $this->acceptedComposeResource($identifier);
        if ($id !== null && $this->mailFiles()->removeFromStage($id)) {
            return new BasicHandlerResult($this->getFileIdentifierParameterName(), HandlerResultInterface::STATUS_OK, $identifier, 'file deleted');
        }
 
        return new BasicHandlerResult($this->getFileIdentifierParameterName(), HandlerResultInterface::STATUS_FAILED, $identifier, 'file not found');
    }

References $id, acceptedComposeResource(), ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler\getFileIdentifierParameterName(), and mailFiles().

Referenced by removeFileForIdentifier().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getStreamConsumer()

ilMailFormUploadHandlerGUI::getStreamConsumer ( string $identifier )

Definition at line 122 of file class.ilMailFormUploadHandlerGUI.php.

                                                         : FileStreamConsumer
    {
        return $this->storage->consume()->stream($this->requireComposeResource($identifier));
    }

References requireComposeResource().

Here is the call graph for this function:

◆ mailFiles()

ilMailFormUploadHandlerGUI::mailFiles ( )

private

Definition at line 127 of file class.ilMailFormUploadHandlerGUI.php.

                                : ilFileDataMail
    {
        return $this->mail_files ??= new ilFileDataMail($this->user_id);
    }

Referenced by acceptedComposeResource(), and getRemoveResult().

Here is the caller graph for this function:

◆ removeFileForIdentifier()

ilMailFormUploadHandlerGUI::removeFileForIdentifier ( string $identifier )

Definition at line 117 of file class.ilMailFormUploadHandlerGUI.php.

                                                               : HandlerResultInterface
    {
        return $this->getRemoveResult($identifier);
    }

References getRemoveResult().

Here is the call graph for this function:

◆ requireComposeResource()

ilMailFormUploadHandlerGUI::requireComposeResource ( string $identifier )

private

Definition at line 142 of file class.ilMailFormUploadHandlerGUI.php.

                                                               : ResourceIdentification
    {
        $id = $this->acceptedComposeResource($identifier);
        if ($id === null) {
            throw new RuntimeException('Mail attachment is not available.');
        }
 
        return $id;
    }