ILIAS\FileUpload\DTO\UploadResult Class Reference

Class UploadResult. More...

Collaboration diagram for ILIAS\FileUpload\DTO\UploadResult:

Public Member Functions
	__construct (string $name, int $size, string $mimeType, private ImmutableStringMap $metaData, private ProcessingStatus $status, string $path)
	UploadResult constructor. More...
	getName ()
	getSize ()
	getMimeType ()
	getMetaData ()
	getStatus ()
	isOK ()
	getPath ()

Private Attributes
string	$name
int	$size
string	$mimeType
string	$path

Detailed Description

Class UploadResult.

The upload results are used to tell ILIAS about the file uploads. This class only purpose is to transport data.

Author

Nicolas Schäfli ns@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Since

5.3

Version

1.0

Definition at line 36 of file UploadResult.php.

Constructor & Destructor Documentation

__construct()

ILIAS\FileUpload\DTO\UploadResult::__construct	(	string	$name,
		int	$size,
		string	$mimeType,
		private ImmutableStringMap	$metaData,
		private ProcessingStatus	$status,
		string	$path
	)

UploadResult constructor.

Parameters

string	$name	The name of the uploaded file.
int	$size	The original file size.
string	$mimeType	The mime type of the uploaded file.
ImmutableStringMap	$metaData	Additional meta data. Make sure to wrap the instance with an ImmutableMapWrapper if the instance is mutable.
ProcessingStatus	$status	The status code either OK or REJECTED.
string	$path	The path to the newly moved file.

Since

5.3

Definition at line 58 of file UploadResult.php.

    {
        $this->stringTypeCheck($name, "name");
        $this->stringTypeCheck($mimeType, "mimeType");
        $this->stringTypeCheck($path, "path");
        $this->intTypeCheck($size, "size");
 
        $this->name = $name;
        $this->size = $size;
        $this->mimeType = $mimeType;
        $this->path = $path;
    }

References ILIAS\FileUpload\DTO\UploadResult\$mimeType, ILIAS\FileUpload\DTO\UploadResult\$name, ILIAS\FileUpload\DTO\UploadResult\$path, and ILIAS\FileUpload\DTO\UploadResult\$size.

Member Function Documentation

getMetaData()

ILIAS\FileUpload\DTO\UploadResult::getMetaData

(

)

Since

5.3

Definition at line 102 of file UploadResult.php.

                                 : ImmutableStringMap
    {
        return $this->metaData;
    }

Referenced by ilObjFile\appendUpload(), ILIAS\FileUpload\FileUploadImpl\regenerateUploadResultWithCopyError(), ILIAS\FileUpload\FileUploadImpl\regenerateUploadResultWithPath(), and ilObjFile\replaceWithUpload().

Here is the caller graph for this function:

getMimeType()

ILIAS\FileUpload\DTO\UploadResult::getMimeType

(

)

Since

5.3

Definition at line 93 of file UploadResult.php.

                                 : string
    {
        return $this->mimeType;
    }

References ILIAS\FileUpload\DTO\UploadResult\$mimeType.

Referenced by ILIAS\ResourceStorage\Manager\BaseManager\appendNewRevision(), ILIAS\FileUpload\FileUploadImpl\regenerateUploadResultWithCopyError(), ILIAS\FileUpload\FileUploadImpl\regenerateUploadResultWithPath(), and ILIAS\ResourceStorage\Manager\BaseManager\replaceWithUpload().

Here is the caller graph for this function:

getName()

ILIAS\FileUpload\DTO\UploadResult::getName

(

)

Since

5.3

Definition at line 75 of file UploadResult.php.

                             : string
    {
        return $this->name;
    }

References ILIAS\FileUpload\DTO\UploadResult\$name.

Referenced by ILIAS\Exercise\Submission\SubmissionManager\addUpload(), ILIAS\ResourceStorage\Manager\BaseManager\appendNewRevision(), ilObjFile\appendUpload(), ilWebDAVMountInstructionsDocumentFormGUI\getRawMountInstructionsFromFileUpload(), ImportUploadHandlerGUI\moveUploadedFileToTemp(), ilFileVersionsUploadHandlerGUI\processChunckedUpload(), ILIAS\FileUpload\Handler\AbstractCtrlAwareIRSSUploadHandler\processChunckedUpload(), ILIAS\FileUpload\FileUploadImpl\regenerateUploadResultWithCopyError(), ILIAS\FileUpload\FileUploadImpl\regenerateUploadResultWithPath(), ILIAS\ResourceStorage\Manager\BaseManager\replaceWithUpload(), ilObjFile\replaceWithUpload(), ilFileDataMail\storeUploadedFile(), ILIAS\ResourceStorage\Manager\Manager\upload(), and ilIndividualAssessmentFileStorage\uploadFile().

Here is the caller graph for this function:

getPath()

ILIAS\FileUpload\DTO\UploadResult::getPath

(

)

Since

5.3

Definition at line 126 of file UploadResult.php.

                             : string
    {
        return $this->path;
    }

References ILIAS\FileUpload\DTO\UploadResult\$path.

Referenced by ImportUploadHandlerGUI\moveUploadedFileToTemp(), ilFileVersionsUploadHandlerGUI\processChunckedUpload(), ILIAS\FileUpload\Handler\AbstractCtrlAwareIRSSUploadHandler\processChunckedUpload(), ilFileDataMail\storeUploadedFile(), and ilIndividualAssessmentFileStorage\uploadFile().

Here is the caller graph for this function:

getSize()

ILIAS\FileUpload\DTO\UploadResult::getSize

(

)

Since

5.3

Definition at line 84 of file UploadResult.php.

                             : int
    {
        return $this->size;
    }

References ILIAS\FileUpload\DTO\UploadResult\$size.

Referenced by ILIAS\FileUpload\FileUploadImpl\regenerateUploadResultWithCopyError(), and ILIAS\FileUpload\FileUploadImpl\regenerateUploadResultWithPath().

Here is the caller graph for this function:

getStatus()

ILIAS\FileUpload\DTO\UploadResult::getStatus

(

)

Since

5.3

Definition at line 111 of file UploadResult.php.

                               : ProcessingStatus
    {
        return $this->status;
    }

Referenced by ilWebDAVMountInstructionsDocumentFormGUI\getRawMountInstructionsFromFileUpload(), and ILIAS\FileUpload\FileUploadImpl\regenerateUploadResultWithPath().

Here is the caller graph for this function:

isOK()

ILIAS\FileUpload\DTO\UploadResult::isOK

(

)

Definition at line 117 of file UploadResult.php.

                          : bool
    {
        return $this->status->getCode() === ProcessingStatus::OK;
    }

References ILIAS\FileUpload\DTO\ProcessingStatus\OK.

Referenced by ilWebDAVMountInstructionsDocumentFormGUI\getRawMountInstructionsFromFileUpload(), ilObjBibliographicUploadHandlerGUI\getUploadResult(), ilFileVersionsUploadHandlerGUI\getUploadResult(), ilCtrlAwareStorageUploadHandler\getUploadResult(), ILIAS\FileUpload\Handler\AbstractCtrlAwareIRSSUploadHandler\getUploadResult(), ImportUploadHandlerGUI\getUploadResult(), CustomIconUploadHandlerGUI\getUploadResult(), ilIndividualAssessmentMemberGUI\getUploadResult(), ilMailAttachmentGUI\getUploadResult(), ilMDCopyrightImageUploadHandlerGUI\getUploadResult(), ilMDVocabularyUploadHandlerGUI\getUploadResult(), ilOrgUnitTypeUploadHandlerGUI\getUploadResult(), ilStudyProgrammeTypeUploadHandlerGUI\getUploadResult(), and ilDidacticTemplateIconHandler\handleUpload().

Here is the caller graph for this function:

Field Documentation

$mimeType

string ILIAS\FileUpload\DTO\UploadResult::$mimeType

private

Definition at line 41 of file UploadResult.php.

Referenced by ILIAS\FileUpload\DTO\UploadResult\__construct(), and ILIAS\FileUpload\DTO\UploadResult\getMimeType().

$name

string ILIAS\FileUpload\DTO\UploadResult::$name

private

Definition at line 39 of file UploadResult.php.

Referenced by ILIAS\FileUpload\DTO\UploadResult\__construct(), and ILIAS\FileUpload\DTO\UploadResult\getName().

$path

string ILIAS\FileUpload\DTO\UploadResult::$path

private

Definition at line 42 of file UploadResult.php.

Referenced by ILIAS\FileUpload\DTO\UploadResult\__construct(), and ILIAS\FileUpload\DTO\UploadResult\getPath().

$size

int ILIAS\FileUpload\DTO\UploadResult::$size

private

Definition at line 40 of file UploadResult.php.

Referenced by ILIAS\FileUpload\DTO\UploadResult\__construct(), and ILIAS\FileUpload\DTO\UploadResult\getSize().

---

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

• components/ILIAS/FileUpload/src/DTO/UploadResult.php