ILIAS  trunk Revision v5.2.0beta1-34132-g2d4d73d4a0
ILIAS\FileUpload\DTO\ProcessingStatus Class Reference

Class ProcessingStatus. More...

+ 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 PENDING = 3
 Upload is pending. 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$codeThe code OK or REJECTED.
string$reasonThe message which should be set to make the rejection more understandable for other developers.
Exceptions

Definition at line 69 of file ProcessingStatus.php.

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

70  {
71  if (!in_array($code, [self::OK, self::REJECTED, self::DENIED, self::PENDING], true)) {
72  throw new \InvalidArgumentException(
73  'Invalid upload status code received. The code must be OK or REJECTED.'
74  );
75  }
76 
77  $this->code = $code;
78  $this->message = $reason;
79  }
string $reason
Error message for last request processed.
Definition: System.php:102

Member Function Documentation

◆ getCode()

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

Definition at line 81 of file ProcessingStatus.php.

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

81  : int
82  {
83  return $this->code;
84  }

◆ getMessage()

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

Definition at line 86 of file ProcessingStatus.php.

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

86  : string
87  {
88  return $this->message;
89  }

Field Documentation

◆ $code

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

◆ $message

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

◆ DENIED

◆ OK

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

Upload is ok.

Definition at line 41 of file ProcessingStatus.php.

Referenced by ILIAS\ResourceStorage\AbstractBaseTest\getDummyUploadResult(), ILIAS\FileUpload\DTO\UploadResult\isOK(), ILIAS\LegalDocuments\FileUpload\PreProcessor\process(), ILIAS\FileUpload\Processor\FilenameSanitizerPreProcessor\process(), ILIAS\FileUpload\Processor\AbstractRecursiveZipPreProcessor\process(), ILIAS\FileUpload\Processor\BlacklistFileHeaderPreProcessor\process(), ILIAS\FileUpload\Processor\WhitelistFileHeaderPreProcessor\process(), ILIAS\FileUpload\Processor\PreProcessorManagerImpl\process(), ILIAS\FileUpload\Processor\SVGWhitelistPreProcessor\process(), ILIAS\FileUpload\Processor\WhitelistExtensionPreProcessor\process(), ILIAS\FileUpload\Processor\BlacklistMimeTypePreProcessor\process(), ILIAS\FileUpload\Processor\WhitelistMimeTypePreProcessor\process(), ILIAS\FileUpload\Processor\SVGBlacklistPreProcessor\process(), ILIAS\FileUpload\Processor\SVGPreProcessorTest\testMaliciousSVG(), ILIAS\LegalDocuments\test\FileUpload\PreProcessorTest\testProcess(), ILIAS\FileUpload\Processor\PreProcessorManagerImplTest\testProcessInvalidFileWhichShouldGetRejected(), ILIAS\FileUpload\Processor\PreProcessorManagerImplTest\testProcessValidFileWhichShouldSucceed(), ILIAS\FileUpload\Processor\PreProcessorManagerImplTest\testProcessValidFileWithFailingProcessorWhichShouldGetRejected(), ILIAS\FileUpload\Processor\FilenameOverridePreProcessorTest\testProcessWhichShouldSucceed(), ILIAS\FileUpload\Processor\BlacklistFileHeaderPreProcessorTest\testProcessWhichShouldSucceed(), ILIAS\FileUpload\Processor\WhitelistExtensionPreProcessorTest\testProcessWhichShouldSucceed(), ILIAS\FileUpload\Processor\WhitelistFileHeaderPreProcessorTest\testProcessWhichShouldSucceed(), ILIAS\FileUpload\Processor\BlacklistExtensionPreProcessorTest\testProcessWhichShouldSucceed(), ILIAS\FileUpload\FileUploadImplTest\testProcessWhichShouldSucceed(), ILIAS\FileUpload\Processor\WhitelistExtensionPreProcessorTest\testProcessWithoutExtensionWhichShouldSucceed(), ILIAS\FileUpload\Processor\PreProcessorManagerImplTest\testProcessWithoutProcessorsWhichShouldSucceed(), ILIAS\FileUpload\Processor\WhitelistMimeTypePreProcessorTest\testProcessWithWhitelistedAnyKindOfOggMimeTypeWhichShouldSucceed(), ILIAS\FileUpload\Processor\WhitelistMimeTypePreProcessorTest\testProcessWithWhitelistedAnyKindOfTextMimeTypeWhichShouldSucceed(), ILIAS\FileUpload\Processor\WhitelistMimeTypePreProcessorTest\testProcessWithWhitelistedMimeTypeWhichShouldSucceed(), ILIAS\FileUpload\Processor\SVGPreProcessorTest\testSaneSVG(), and ILIAS\FileUpload\Processor\SVGPreProcessorTest\testSomeComplexSaneSVG().

◆ PENDING

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

Upload is pending.

Definition at line 49 of file ProcessingStatus.php.

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

◆ REJECTED

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

Upload got rejected by a processor.

Definition at line 45 of file ProcessingStatus.php.

Referenced by ILIAS\FileUpload\FileUploadImpl\moveFilesTo(), ILIAS\FileUpload\FileUploadImpl\moveOneFileTo(), ILIAS\FileUpload\Processor\AbstractRecursiveZipPreProcessor\process(), ILIAS\FileUpload\Processor\WhitelistFileHeaderPreProcessor\process(), ILIAS\FileUpload\Processor\BlacklistFileHeaderPreProcessor\process(), ILIAS\FileUpload\Processor\PreProcessorManagerImpl\process(), ILIAS\FileUpload\Processor\WhitelistExtensionPreProcessor\process(), ILIAS\FileUpload\Processor\BlacklistMimeTypePreProcessor\process(), ILIAS\FileUpload\Processor\WhitelistMimeTypePreProcessor\process(), ILIAS\FileUpload\FileUploadImpl\regenerateUploadResultWithCopyError(), ILIAS\FileUpload\FileUploadImpl\rejectFailedUpload(), ILIAS\FileUpload\Processor\PreProcessorManagerImplTest\testProcessInvalidFileWhichShouldGetRejected(), ILIAS\FileUpload\Processor\PreProcessorManagerImplTest\testProcessValidFileWithFailingProcessorWhichShouldGetRejected(), ILIAS\FileUpload\Processor\BlacklistMimeTypePreProcessorTest\testProcessWithBlacklistedAnyKindOfOggMimeTypeWhichGetRejected(), ILIAS\FileUpload\Processor\BlacklistMimeTypePreProcessorTest\testProcessWithBlacklistedAnyKindOfTextMimeTypeWhichGetRejected(), ILIAS\FileUpload\Processor\BlacklistExtensionPreProcessorTest\testProcessWithBlacklistedEmptyExtensionWhichShouldGetRejected(), ILIAS\FileUpload\Processor\BlacklistExtensionPreProcessorTest\testProcessWithBlacklistedExtensionWhichShouldGetRejected(), ILIAS\FileUpload\Processor\BlacklistMimeTypePreProcessorTest\testProcessWithBlacklistedMimeTypeWhichShouldGetRejected(), ILIAS\FileUpload\FileUploadImplTest\testProcessWithFailedUploadWhichShouldGetRejected(), ILIAS\FileUpload\Processor\WhitelistFileHeaderPreProcessorTest\testProcessWithHeaderMismatchWhichShouldGetRejected(), ILIAS\FileUpload\Processor\BlacklistFileHeaderPreProcessorTest\testProcessWithHeaderMismatchWhichShouldGetRejected(), ILIAS\FileUpload\Processor\WhitelistExtensionPreProcessorTest\testProcessWithoutWhitelistedExtensionWhichShouldGetRejected(), ILIAS\FileUpload\Processor\SVGPreProcessorTest\testSaneSVG(), ILIAS\FileUpload\Processor\SVGPreProcessorTest\testSomeComplexSaneSVG(), and ilCertificateBackgroundImageUpload\uploadFile().


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