Inheritance diagram for ILIAS\FileUpload\Processor\PreProcessorManagerImpl:

Collaboration diagram for ILIAS\FileUpload\Processor\PreProcessorManagerImpl:

Public Member Functions
	with (PreProcessor $processor)
	@inheritDoc More...

	process (FileStream $stream, Metadata $metadata)
	@inheritDoc More...

	with (PreProcessor $processor)
	Adds the processor to the current manager. More...

	process (FileStream $stream, Metadata $metadata)
	Invokes the registered processors until one rejects the file or fails. More...

Private Attributes
array	$processors = []

Detailed Description

Class PreProcessorManagerImpl.

A pool of preprocessors which can be executed for a particular stream. If once of the processors fail while processing a stream, it will get rejected to protect ILIAS.

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 37 of file PreProcessorManagerImpl.php.

Member Function Documentation

◆ process()

ILIAS\FileUpload\Processor\PreProcessorManagerImpl::process	(	FileStream	$stream,
		Metadata	$metadata
	)

@inheritDoc

Implements ILIAS\FileUpload\Processor\PreProcessorManager.

Definition at line 56 of file PreProcessorManagerImpl.php.

                                                                   : ProcessingStatus
    {
        try {
            $result = null;
            foreach ($this->processors as $processor) {
                $stream->rewind();
                $result = $processor->process($stream, $metadata);
                if ($result->getCode() === ProcessingStatus::REJECTED || $result->getCode() === ProcessingStatus::DENIED) {
                    return $result;
                }
            }
 
            if (is_null($result)) {
                return new ProcessingStatus(ProcessingStatus::OK, 'No processors were registered.');
            }
 
            return $result;
        } catch (\Exception $ex) {
            return new ProcessingStatus(ProcessingStatus::REJECTED, 'Processor failed with exception message "' . $ex->getMessage() . '"');
        }
    }

References ILIAS\FileUpload\DTO\ProcessingStatus\DENIED, ILIAS\FileUpload\DTO\ProcessingStatus\OK, and ILIAS\FileUpload\DTO\ProcessingStatus\REJECTED.

◆ with()

ILIAS\FileUpload\Processor\PreProcessorManagerImpl::with ( PreProcessor $processor )

@inheritDoc

Implements ILIAS\FileUpload\Processor\PreProcessorManager.

Definition at line 47 of file PreProcessorManagerImpl.php.

                                                 : void
    {
        $this->processors[] = $processor;
    }

Field Documentation

◆ $processors

PreProcessor[] ILIAS\FileUpload\Processor\PreProcessorManagerImpl::$processors = []

private

Definition at line 42 of file PreProcessorManagerImpl.php.

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

components/ILIAS/FileUpload/src/Processor/PreProcessorManagerImpl.php