ILIAS\FileUpload\Handler\BasicHandlerResult Class Reference

Class BasicHandlerResult. More...

Inheritance diagram for ILIAS\FileUpload\Handler\BasicHandlerResult:

Collaboration diagram for ILIAS\FileUpload\Handler\BasicHandlerResult:

Public Member Functions
	__construct (string $file_identification_key, int $status, string $file_identifier, string $message)
	BasicHandlerResult constructor. More...
	getStatus ()
	@inheritDoc More...
	getFileIdentifier ()
	@inheritDoc More...
	jsonSerialize ()
	@inheritDoc More...
	getMessage ()
	@inheritDoc More...
	getStatus ()
	getFileIdentifier ()
	getMessage ()

Private Attributes
	$file_identification_key
	$status
	$file_identifier
	$message

Additional Inherited Members
Data Fields inherited from ILIAS\FileUpload\Handler\HandlerResult
const	STATUS_OK = 1
const	STATUS_FAILED = 2

Detailed Description

Class BasicHandlerResult.

Author

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

Definition at line 12 of file BasicHandlerResult.php.

Constructor & Destructor Documentation

__construct()

ILIAS\FileUpload\Handler\BasicHandlerResult::__construct	(	string	$file_identification_key,
		int	$status,
		string	$file_identifier,
		string	$message
	)

BasicHandlerResult constructor.

Parameters

int	$status
string	$file_identifier
string	$message

Definition at line 40 of file BasicHandlerResult.php.

    {
        $this->file_identification_key = $file_identification_key;
        $this->status = $status;
        $this->file_identifier = $file_identifier;
        $this->message = $message;
    }

References ILIAS\FileUpload\Handler\BasicHandlerResult\$file_identification_key, ILIAS\FileUpload\Handler\BasicHandlerResult\$file_identifier, ILIAS\FileUpload\Handler\BasicHandlerResult\$message, and ILIAS\FileUpload\Handler\BasicHandlerResult\$status.

Member Function Documentation

getFileIdentifier()

ILIAS\FileUpload\Handler\BasicHandlerResult::getFileIdentifier

(

)

@inheritDoc

Implements ILIAS\FileUpload\Handler\HandlerResult.

Definition at line 61 of file BasicHandlerResult.php.

                                        : string
    {
        return $this->file_identifier;
    }

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

getMessage()

ILIAS\FileUpload\Handler\BasicHandlerResult::getMessage

(

)

@inheritDoc

Implements ILIAS\FileUpload\Handler\HandlerResult.

Definition at line 85 of file BasicHandlerResult.php.

                                 : string
    {
        return $this->message;
    }

References ILIAS\FileUpload\Handler\BasicHandlerResult\$message.

getStatus()

ILIAS\FileUpload\Handler\BasicHandlerResult::getStatus

(

)

@inheritDoc

Implements ILIAS\FileUpload\Handler\HandlerResult.

Definition at line 52 of file BasicHandlerResult.php.

                                : int
    {
        return $this->status;
    }

References ILIAS\FileUpload\Handler\BasicHandlerResult\$status.

jsonSerialize()

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

final

@inheritDoc

Definition at line 70 of file BasicHandlerResult.php.

    {
        $str = $this->file_identification_key ?? UploadHandler::DEFAULT_FILE_ID_PARAMETER;
 
        return [
            'status' => $this->status,
            'message' => $this->message,
            $str => $this->file_identifier,
        ];
    }

References ILIAS\FileUpload\Handler\BasicHandlerResult\$file_identifier, ILIAS\FileUpload\Handler\BasicHandlerResult\$message, ILIAS\FileUpload\Handler\BasicHandlerResult\$status, and ILIAS\UI\Component\Input\Field\UploadHandler\DEFAULT_FILE_ID_PARAMETER.

Field Documentation

$file_identification_key

ILIAS\FileUpload\Handler\BasicHandlerResult::$file_identification_key

private

Definition at line 18 of file BasicHandlerResult.php.

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

$file_identifier

ILIAS\FileUpload\Handler\BasicHandlerResult::$file_identifier

private

Definition at line 26 of file BasicHandlerResult.php.

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

$message

ILIAS\FileUpload\Handler\BasicHandlerResult::$message

private

Definition at line 30 of file BasicHandlerResult.php.

Referenced by ILIAS\FileUpload\Handler\BasicHandlerResult\__construct(), ILIAS\FileUpload\Handler\BasicHandlerResult\getMessage(), and ILIAS\FileUpload\Handler\BasicHandlerResult\jsonSerialize().

$status

ILIAS\FileUpload\Handler\BasicHandlerResult::$status

private

Definition at line 22 of file BasicHandlerResult.php.

Referenced by ILIAS\FileUpload\Handler\BasicHandlerResult\__construct(), ILIAS\FileUpload\Handler\BasicHandlerResult\getStatus(), and ILIAS\FileUpload\Handler\BasicHandlerResult\jsonSerialize().

---

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

• src/FileUpload/Handler/BasicHandlerResult.php