ILIAS\FileUpload\Handler\BasicFileInfoResult Class Reference

Class BasicFileInfoResult. More...

Inheritance diagram for ILIAS\FileUpload\Handler\BasicFileInfoResult:

Collaboration diagram for ILIAS\FileUpload\Handler\BasicFileInfoResult:

Public Member Functions
	__construct (private string $file_identification_key, private string $file_identifier, private string $name, private int $size, private string $mime_type)
	getFileIdentifier ()
	getName ()
	getSize ()
	getMimeType ()
	jsonSerialize ()
	@inheritDoc More...
	getFileIdentifier ()
	getName ()
	getSize ()
	getMimeType ()

Detailed Description

Class BasicFileInfoResult.

Author

Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 28 of file BasicFileInfoResult.php.

Constructor & Destructor Documentation

__construct()

ILIAS\FileUpload\Handler\BasicFileInfoResult::__construct	(	private string	$file_identification_key,
		private string	$file_identifier,
		private string	$name,
		private int	$size,
		private string	$mime_type
	)

Parameters

int

$size

in Bytes, we will change this to DataSize in the future

Definition at line 33 of file BasicFileInfoResult.php.

    {
    }

Member Function Documentation

getFileIdentifier()

ILIAS\FileUpload\Handler\BasicFileInfoResult::getFileIdentifier

(

)

Implements ILIAS\FileUpload\Handler\FileInfoResult.

Definition at line 38 of file BasicFileInfoResult.php.

                                       : string
    {
        return $this->file_identifier;
    }

getMimeType()

ILIAS\FileUpload\Handler\BasicFileInfoResult::getMimeType

(

)

Implements ILIAS\FileUpload\Handler\FileInfoResult.

Definition at line 56 of file BasicFileInfoResult.php.

                                 : string
    {
        return $this->mime_type;
    }

getName()

ILIAS\FileUpload\Handler\BasicFileInfoResult::getName

(

)

Implements ILIAS\FileUpload\Handler\FileInfoResult.

Definition at line 44 of file BasicFileInfoResult.php.

                             : string
    {
        return $this->name;
    }

getSize()

ILIAS\FileUpload\Handler\BasicFileInfoResult::getSize

(

)

Returns

int in Bytes, we will change this to DataSize in the future

Implements ILIAS\FileUpload\Handler\FileInfoResult.

Definition at line 50 of file BasicFileInfoResult.php.

                             : int
    {
        return $this->size;
    }

jsonSerialize()

ILIAS\FileUpload\Handler\BasicFileInfoResult::jsonSerialize ( )

final

@inheritDoc

Definition at line 65 of file BasicFileInfoResult.php.

                                         : array
    {
        $str = $this->file_identification_key ?? UploadHandler::DEFAULT_FILE_ID_PARAMETER;
 
        return [
            'name' => $this->name,
            'size' => $this->size,
            'mime_type' => $this->mime_type,
            $str => $this->file_identifier,
        ];
    }

References ILIAS\UI\Component\Input\Field\UploadHandler\DEFAULT_FILE_ID_PARAMETER.

---

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

• components/ILIAS/FileUpload/src/Handler/BasicFileInfoResult.php