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 (string $file_identification_key, string $file_identifier, string $name, int $size, string $mime_type)
	getFileIdentifier ()
	getName ()
	getSize ()
	getMimeType ()
	jsonSerialize ()

Private Attributes
string	$mime_type
string	$file_identifier
int	$size
string	$name
string	$file_identification_key

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	(	string	$file_identification_key,
		string	$file_identifier,
		string	$name,
		int	$size,
		string	$mime_type
	)

Parameters

int

$size

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

Definition at line 39 of file BasicFileInfoResult.php.

References ILIAS\FileUpload\Handler\BasicFileInfoResult\$file_identification_key, ILIAS\FileUpload\Handler\BasicFileInfoResult\$file_identifier, ILIAS\FileUpload\Handler\BasicFileInfoResult\$mime_type, ILIAS\FileUpload\Handler\BasicFileInfoResult\$name, and ILIAS\FileUpload\Handler\BasicFileInfoResult\$size.

      {
        $this->file_identification_key = $file_identification_key;
        $this->file_identifier = $file_identifier;
        $this->name = $name;
        $this->size = $size;
        $this->mime_type = $mime_type;
    }

Member Function Documentation

getFileIdentifier()

ILIAS\FileUpload\Handler\BasicFileInfoResult::getFileIdentifier

(

)

Implements ILIAS\FileUpload\Handler\FileInfoResult.

Definition at line 54 of file BasicFileInfoResult.php.

References ILIAS\FileUpload\Handler\BasicFileInfoResult\$file_identifier.

                                       : string
    {
        return $this->file_identifier;
    }

getMimeType()

ILIAS\FileUpload\Handler\BasicFileInfoResult::getMimeType

(

)

Implements ILIAS\FileUpload\Handler\FileInfoResult.

Definition at line 72 of file BasicFileInfoResult.php.

References ILIAS\FileUpload\Handler\BasicFileInfoResult\$mime_type.

                                 : string
    {
        return $this->mime_type;
    }

getName()

ILIAS\FileUpload\Handler\BasicFileInfoResult::getName

(

)

Implements ILIAS\FileUpload\Handler\FileInfoResult.

Definition at line 60 of file BasicFileInfoResult.php.

References ILIAS\FileUpload\Handler\BasicFileInfoResult\$name.

                             : 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 66 of file BasicFileInfoResult.php.

References ILIAS\FileUpload\Handler\BasicFileInfoResult\$size.

                             : int
    {
        return $this->size;
    }

jsonSerialize()

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

final

Definition at line 81 of file BasicFileInfoResult.php.

References ILIAS\FileUpload\Handler\BasicFileInfoResult\$file_identifier, ILIAS\FileUpload\Handler\BasicFileInfoResult\$mime_type, ILIAS\FileUpload\Handler\BasicFileInfoResult\$name, ILIAS\FileUpload\Handler\BasicFileInfoResult\$size, and ILIAS\UI\Component\Input\Field\UploadHandler\DEFAULT_FILE_ID_PARAMETER.

                                         : 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,
        ];
    }

Field Documentation

$file_identification_key

string ILIAS\FileUpload\Handler\BasicFileInfoResult::$file_identification_key

private

Definition at line 34 of file BasicFileInfoResult.php.

Referenced by ILIAS\FileUpload\Handler\BasicFileInfoResult\__construct().

$file_identifier

string ILIAS\FileUpload\Handler\BasicFileInfoResult::$file_identifier

private

Definition at line 31 of file BasicFileInfoResult.php.

Referenced by ILIAS\FileUpload\Handler\BasicFileInfoResult\__construct(), ILIAS\FileUpload\Handler\BasicFileInfoResult\getFileIdentifier(), and ILIAS\FileUpload\Handler\BasicFileInfoResult\jsonSerialize().

$mime_type

string ILIAS\FileUpload\Handler\BasicFileInfoResult::$mime_type

private

Definition at line 30 of file BasicFileInfoResult.php.

Referenced by ILIAS\FileUpload\Handler\BasicFileInfoResult\__construct(), ILIAS\FileUpload\Handler\BasicFileInfoResult\getMimeType(), and ILIAS\FileUpload\Handler\BasicFileInfoResult\jsonSerialize().

$name

string ILIAS\FileUpload\Handler\BasicFileInfoResult::$name

private

Definition at line 33 of file BasicFileInfoResult.php.

Referenced by ILIAS\FileUpload\Handler\BasicFileInfoResult\__construct(), ILIAS\FileUpload\Handler\BasicFileInfoResult\getName(), and ILIAS\FileUpload\Handler\BasicFileInfoResult\jsonSerialize().

$size

int ILIAS\FileUpload\Handler\BasicFileInfoResult::$size

private

Definition at line 32 of file BasicFileInfoResult.php.

Referenced by ILIAS\FileUpload\Handler\BasicFileInfoResult\__construct(), ILIAS\FileUpload\Handler\BasicFileInfoResult\getSize(), and ILIAS\FileUpload\Handler\BasicFileInfoResult\jsonSerialize().

---

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

• src/FileUpload/Handler/BasicFileInfoResult.php