Collaboration diagram for ILIAS\FileUpload\DTO\ProcessingStatus:

Public Member Functions
	__construct (int $code, string $reason)
	ProcessingStatus constructor. More...

	getCode ()

	getMessage ()

Data Fields
const	OK = 1
	Upload is ok. More...

const	REJECTED = 2
	Upload got rejected by a processor. More...

const	DENIED = 4
	Upload got denied by a processor, the upload will be removed immediately. More...

Private Attributes
int	$code

string	$message

Detailed Description

Class ProcessingStatus.

The class is used by the processors to give feedback to the UploadService about the validity of the current processed file. 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 36 of file ProcessingStatus.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\FileUpload\DTO\ProcessingStatus::__construct	(	int	$code,
		string	$reason
	)

ProcessingStatus constructor.

Parameters

int	$code	The code OK or REJECTED.
string	$reason	The message which should be set to make the rejection more understandable for other developers.

Exceptions

Definition at line 67 of file ProcessingStatus.php.

References ILIAS\FileUpload\DTO\ProcessingStatus\$code, and ILIAS\LTI\ToolProvider\$reason.

     {
         $this->intTypeCheck($code, 'code');
         $this->stringTypeCheck($reason, 'reason');
 
         if ($code !== self::OK && $code !== self::REJECTED && $code !== self::DENIED) {
             throw new \InvalidArgumentException('Invalid upload status code received. The code must be OK or REJECTED.');
         }
 
         $this->code = $code;
         $this->message = $reason;
     }

Member Function Documentation

◆ getCode()

ILIAS\FileUpload\DTO\ProcessingStatus::getCode ( )

Since: 5.3

Definition at line 84 of file ProcessingStatus.php.

References ILIAS\FileUpload\DTO\ProcessingStatus\$code.

                              : int
     {
         return $this->code;
     }

◆ getMessage()

ILIAS\FileUpload\DTO\ProcessingStatus::getMessage ( )

Since: 5.3

Definition at line 93 of file ProcessingStatus.php.

References ILIAS\FileUpload\DTO\ProcessingStatus\$message.

                                 : string
     {
         return $this->message;
     }

Field Documentation

◆ $code

int ILIAS\FileUpload\DTO\ProcessingStatus::$code

private

Definition at line 51 of file ProcessingStatus.php.

Referenced by ILIAS\FileUpload\DTO\ProcessingStatus\__construct(), and ILIAS\FileUpload\DTO\ProcessingStatus\getCode().

◆ $message

string ILIAS\FileUpload\DTO\ProcessingStatus::$message

private

Definition at line 52 of file ProcessingStatus.php.

Referenced by ILIAS\FileUpload\DTO\ProcessingStatus\getMessage().

◆ DENIED

const ILIAS\FileUpload\DTO\ProcessingStatus::DENIED = 4

Upload got denied by a processor, the upload will be removed immediately.

Definition at line 50 of file ProcessingStatus.php.

Referenced by ILIAS\FileUpload\Processor\PreProcessorManagerImpl\process(), ILIAS\FileUpload\Processor\SVGWhitelistPreProcessor\process(), ILIAS\FileUpload\Processor\SVGBlacklistPreProcessor\process(), ILIAS\FileUpload\FileUploadImpl\process(), and ILIAS\FileUpload\Processor\SVGPreProcessorTest\testMaliciousSVG().

◆ OK

const ILIAS\FileUpload\DTO\ProcessingStatus::OK = 1

Upload is ok.

Definition at line 42 of file ProcessingStatus.php.

◆ REJECTED

const ILIAS\FileUpload\DTO\ProcessingStatus::REJECTED = 2

Upload got rejected by a processor.

Definition at line 46 of file ProcessingStatus.php.

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

src/FileUpload/DTO/ProcessingStatus.php

Public Member Functions

Data Fields

Private Attributes