Collaboration diagram for ILIAS\FileUpload\DTO\ProcessingStatus:

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

	getCode ()

	getMessage ()

Data Fields
const	OK = 1

const	REJECTED = 2

const	PENDING = 3

const	DENIED = 4

Private Attributes
int	$code

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 34 of file ProcessingStatus.php.

Constructor & Destructor Documentation

◆ __construct()

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

ProcessingStatus constructor.

Parameters

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

Exceptions

InvalidArgumentException Thrown if the given code is not OK or REJECTED. The exception can also be thrown if the given arguments are not of the correct type.

Definition at line 70 of file ProcessingStatus.php.

    {
        if (!in_array($code, [self::OK, self::REJECTED, self::DENIED, self::PENDING], true)) {
            throw new \InvalidArgumentException(
                'Invalid upload status code received. The code must be OK or REJECTED.'
            );
        }
 
        $this->code = $code;
    }

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

Member Function Documentation

◆ getCode()

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

Definition at line 81 of file ProcessingStatus.php.

                             : int
    {
        return $this->code;
    }

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

◆ getMessage()

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

Definition at line 86 of file ProcessingStatus.php.

                                : string
    {
        return $this->message;
    }

References $message.

Referenced by ILIAS\FileUpload\FileUploadImpl\hardRemoveUpload().

Here is the caller graph for this function:

Field Documentation

◆ $code

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

private

Definition at line 57 of file ProcessingStatus.php.

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

◆ DENIED

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

Definition at line 55 of file ProcessingStatus.php.

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

◆ OK

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

Definition at line 40 of file ProcessingStatus.php.

◆ PENDING

const ILIAS\FileUpload\DTO\ProcessingStatus::PENDING = 3

Definition at line 50 of file ProcessingStatus.php.

Referenced by ILIAS\FileUpload\Processor\AbstractRecursiveZipPreProcessor\process().

◆ REJECTED

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

Definition at line 45 of file ProcessingStatus.php.

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

components/ILIAS/FileUpload/src/DTO/ProcessingStatus.php

Public Member Functions

Data Fields

Private Attributes