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 (private string $file_identification_key, private int $status, private string $file_identifier, private string $message)
	BasicHandlerResult constructor. More...
	getStatus ()
	@inheritDoc More...
	getFileIdentifier ()
	@inheritDoc More...
	jsonSerialize ()
	@inheritDoc More...
	getMessage ()
	@inheritDoc More...
	getStatus ()
	getFileIdentifier ()
	getMessage ()

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

Detailed Description

Class BasicHandlerResult.

Author

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

Definition at line 28 of file BasicHandlerResult.php.

Constructor & Destructor Documentation

__construct()

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

BasicHandlerResult constructor.

Definition at line 33 of file BasicHandlerResult.php.

    {
    }

Member Function Documentation

getFileIdentifier()

ILIAS\FileUpload\Handler\BasicHandlerResult::getFileIdentifier

(

)

@inheritDoc

Implements ILIAS\FileUpload\Handler\HandlerResult.

Definition at line 50 of file BasicHandlerResult.php.

                                       : string
    {
        return $this->file_identifier;
    }

getMessage()

ILIAS\FileUpload\Handler\BasicHandlerResult::getMessage

(

)

@inheritDoc

Implements ILIAS\FileUpload\Handler\HandlerResult.

Definition at line 74 of file BasicHandlerResult.php.

                                : string
    {
        return $this->message;
    }

References $message.

getStatus()

ILIAS\FileUpload\Handler\BasicHandlerResult::getStatus

(

)

@inheritDoc

Implements ILIAS\FileUpload\Handler\HandlerResult.

Definition at line 41 of file BasicHandlerResult.php.

                               : int
    {
        return $this->status;
    }

jsonSerialize()

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

final

@inheritDoc

Definition at line 59 of file BasicHandlerResult.php.

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

References $message, and 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/BasicHandlerResult.php