ILIAS\FileUpload\DTO\Metadata Class Reference

Class Metadata. More...

Collaboration diagram for ILIAS\FileUpload\DTO\Metadata:

Public Member Functions
	__construct ($filename, $size, $mimeType)
	Metadata constructor. More...
	getFilename ()
	The filename supplied by the browser. More...
	setFilename ($filename)
	Overwrite the current filename. More...
	getUploadSize ()
	This is always the original file size which was determined by the http service. More...
	getMimeType ()
	Client supplied mime type of the uploaded. More...
	setMimeType ($mimeType)
	Overwrite the current mime type of the file. More...
	additionalMetaData ()
	Provides a string map implementation which allows the processors to store additional values. More...

Private Attributes
	$filename
	$uploadSize
	$mimeType
	$additionalMetaData

Detailed Description

Class Metadata.

The meta data class holds all the data which are passed to each processor. 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 21 of file Metadata.php.

Constructor & Destructor Documentation

__construct()

ILIAS\FileUpload\DTO\Metadata::__construct	(		$filename,
			$size,
			$mimeType
	)

Metadata constructor.

Parameters

string	$filename	The filename of the uploaded file.
int	$size	The original size of the uploaded file.
string	$mimeType	The mime type of the uploaded file.

Exceptions

Definition at line 53 of file Metadata.php.

References ILIAS\FileUpload\DTO\Metadata\$filename, ILIAS\FileUpload\DTO\Metadata\$mimeType, $size, and ILIAS\FileUpload\DTO\Metadata\additionalMetaData().

    {
        $this->stringTypeCheck($filename, "filename");
        $this->intTypeCheck($size, "size");
        $this->stringTypeCheck($mimeType, "mimeType");

        $this->filename = $filename;
        $this->uploadSize = $size;
        $this->mimeType = $mimeType;
        $this->additionalMetaData = new EntryLockingStringMap();
    }

Here is the call graph for this function:

Member Function Documentation

additionalMetaData()

ILIAS\FileUpload\DTO\Metadata::additionalMetaData

(

)

Provides a string map implementation which allows the processors to store additional values.

The string map implementation used by the meta data refuses to overwrite values.

Returns

StringMap

Since

5.3

Definition at line 149 of file Metadata.php.

References ILIAS\FileUpload\DTO\Metadata\$additionalMetaData.

Referenced by ILIAS\FileUpload\DTO\Metadata\__construct(), and ilCountPDFPagesPreProcessors\process().

    {
        return $this->additionalMetaData;
    }

Here is the caller graph for this function:

getFilename()

ILIAS\FileUpload\DTO\Metadata::getFilename

(

)

The filename supplied by the browser.

Please be aware of the fact that this value can be potentially unsafe.

Returns

string

Since

5.3

Definition at line 73 of file Metadata.php.

References ILIAS\FileUpload\DTO\Metadata\$filename.

Referenced by ILIAS\FileUpload\Processor\FilenameSanitizerPreProcessor\process(), ILIAS\FileUpload\Processor\WhitelistExtensionPreProcessor\process(), ILIAS\FileUpload\Processor\BlacklistExtensionPreProcessor\process(), and ILIAS\FileUpload\FileUploadImpl\rejectFailedUpload().

    {
        return $this->filename;
    }

Here is the caller graph for this function:

getMimeType()

ILIAS\FileUpload\DTO\Metadata::getMimeType

(

)

Client supplied mime type of the uploaded.

This value must be threaded as unreliable.

Returns

string

Since

5.3

Definition at line 118 of file Metadata.php.

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

Referenced by ilCountPDFPagesPreProcessors\process(), ILIAS\FileUpload\Processor\BlacklistMimeTypePreProcessor\process(), ILIAS\FileUpload\Processor\WhitelistMimeTypePreProcessor\process(), and ILIAS\FileUpload\FileUploadImpl\rejectFailedUpload().

    {
        return $this->mimeType;
    }

Here is the caller graph for this function:

getUploadSize()

ILIAS\FileUpload\DTO\Metadata::getUploadSize

(

)

This is always the original file size which was determined by the http service.

The current size is provided by the size method of the Stream passed to the processor. Please use the filesystem service to get the file size outside of the processors.

Returns

int

Since

5.3

Definition at line 105 of file Metadata.php.

References ILIAS\FileUpload\DTO\Metadata\$uploadSize.

Referenced by ILIAS\FileUpload\FileUploadImpl\rejectFailedUpload().

    {
        return $this->uploadSize;
    }

Here is the caller graph for this function:

setFilename()

ILIAS\FileUpload\DTO\Metadata::setFilename

(

$filename

)

Overwrite the current filename.

Parameters

string

$filename

The new filename.

Returns

Metadata

Since

5.3

Definition at line 87 of file Metadata.php.

References ILIAS\FileUpload\DTO\Metadata\$filename.

Referenced by ILIAS\FileUpload\Processor\FilenameSanitizerPreProcessor\process().

    {
        $this->stringTypeCheck($filename, "filename");

        $this->filename = $filename;

        return $this;
    }

Here is the caller graph for this function:

setMimeType()

ILIAS\FileUpload\DTO\Metadata::setMimeType

(

$mimeType

)

Overwrite the current mime type of the file.

Parameters

string

$mimeType

The new mime type if the file.

Returns

Metadata

Since

5.3

Definition at line 132 of file Metadata.php.

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

    {
        $this->stringTypeCheck($mimeType, "mimeType");

        $this->mimeType = $mimeType;

        return $this;
    }

Field Documentation

$additionalMetaData

StringMap ILIAS\FileUpload\DTO\Metadata::$additionalMetaData

private

Definition at line 39 of file Metadata.php.

Referenced by ILIAS\FileUpload\DTO\Metadata\additionalMetaData().

$filename

string ILIAS\FileUpload\DTO\Metadata::$filename

private

Definition at line 27 of file Metadata.php.

Referenced by ILIAS\FileUpload\DTO\Metadata\__construct(), ILIAS\FileUpload\DTO\Metadata\getFilename(), and ILIAS\FileUpload\DTO\Metadata\setFilename().

$mimeType

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

private

Definition at line 35 of file Metadata.php.

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

$uploadSize

int ILIAS\FileUpload\DTO\Metadata::$uploadSize

private

Definition at line 31 of file Metadata.php.

Referenced by ILIAS\FileUpload\DTO\Metadata\getUploadSize().

---

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

• src/FileUpload/DTO/Metadata.php