ILIAS\FileUpload\DTO\UploadResult Class Reference

Class UploadResult. More...

Collaboration diagram for ILIAS\FileUpload\DTO\UploadResult:

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

Private Attributes
	$name
	$size
	$mimeType
	$metaData
	$status
	$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 20 of file UploadResult.php.

Constructor & Destructor Documentation

__construct()

ILIAS\FileUpload\DTO\UploadResult::__construct	(		$name,
			$size,
			$mimeType,
		ImmutableStringMap	$metaData,
		ProcessingStatus	$status,
			$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 62 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->metaData = $metaData;
        $this->status = $status;
        $this->path = $path;
    }

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

Member Function Documentation

getMetaData()

ILIAS\FileUpload\DTO\UploadResult::getMetaData

(

)

Returns

ImmutableStringMap

Since

5.3

Definition at line 112 of file UploadResult.php.

    {
        return $this->metaData;
    }

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

getMimeType()

ILIAS\FileUpload\DTO\UploadResult::getMimeType

(

)

Returns

string

Since

5.3

Definition at line 102 of file UploadResult.php.

    {
        return $this->mimeType;
    }

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

getName()

ILIAS\FileUpload\DTO\UploadResult::getName

(

)

Returns

string

Since

5.3

Definition at line 82 of file UploadResult.php.

    {
        return $this->name;
    }

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

Referenced by ilWebDAVMountInstructionsDocumentFormGUI\getRawMountInstructionsFromFileUpload().

Here is the caller graph for this function:

getPath()

ILIAS\FileUpload\DTO\UploadResult::getPath

(

)

Returns

string

Since

5.3

Definition at line 141 of file UploadResult.php.

    {
        return $this->path;
    }

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

getSize()

ILIAS\FileUpload\DTO\UploadResult::getSize

(

)

Returns

int

Since

5.3

Definition at line 92 of file UploadResult.php.

    {
        return $this->size;
    }

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

getStatus()

ILIAS\FileUpload\DTO\UploadResult::getStatus

(

)

Returns

ProcessingStatus

Since

5.3

Definition at line 122 of file UploadResult.php.

    {
        return $this->status;
    }

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

Referenced by ilWebDAVMountInstructionsDocumentFormGUI\getRawMountInstructionsFromFileUpload().

Here is the caller graph for this function:

isOK()

ILIAS\FileUpload\DTO\UploadResult::isOK

(

)

Returns

bool

Definition at line 131 of file UploadResult.php.

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

References ILIAS\FileUpload\DTO\ProcessingStatus\OK.

Field Documentation

$metaData

ImmutableStringMap ILIAS\FileUpload\DTO\UploadResult::$metaData

private

Definition at line 38 of file UploadResult.php.

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

$mimeType

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

private

Definition at line 34 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 26 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 46 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 30 of file UploadResult.php.

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

$status

ProcessingStatus ILIAS\FileUpload\DTO\UploadResult::$status

private

Definition at line 42 of file UploadResult.php.

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

---

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

• src/FileUpload/DTO/UploadResult.php