ILIAS\FileUpload\FileUploadImpl Class Reference

Class FileUploadImpl. More...

Inheritance diagram for ILIAS\FileUpload\FileUploadImpl:

Collaboration diagram for ILIAS\FileUpload\FileUploadImpl:

Public Member Functions
	__construct (PreProcessorManager $processorManager, Filesystems $filesystems, GlobalHttpState $globalHttpState)
	FileUploadImpl constructor. More...
	moveOneFileTo (UploadResult $uploadResult, $destination, $location=Location::STORAGE, $file_name='', $override_existing=false)
	Moves a single UploadResult to the given destination. Parameters UploadResult $UploadResult Which upload result do you want to move? string $destination Where do you want to move the file? int $location Location::[STORAGE|WEB|CUSTOMIZING] string $file_name Do you want to rename the file? bool $override_existing Override existing file with same name Returns void More...
	moveFilesTo ($destination, $location=Location::STORAGE)
	uploadSizeLimit ()
	register (PreProcessor $preProcessor)
	getResults ()
	hasUploads ()
	hasBeenProcessed ()
Public Member Functions inherited from ILIAS\FileUpload\FileUpload
	process ()
	Invokes all preprocessors for each uploaded file in the sequence they got registered. More...

Protected Member Functions
	flattenUploadedFiles ($uploadedFiles)

Private Member Functions
	regenerateUploadResultWithPath (UploadResult $result, $path)
	Generate an exact copy of the result with the given path. More...
	regenerateUploadResultWithCopyError (UploadResult $result, $errorReason)
	Creates a clone of the given result and set the status to rejected with the passed error message. More...
	selectFilesystem ($location)
	Selects the correct filesystem by the given Location constant. More...
	rejectFailedUpload (UploadedFileInterface $file, Metadata $metadata)
	Reject a failed upload with the given metadata. More...

Private Attributes
	$processorManager
	$filesystems
	$globalHttpState
	$processed
	$moved
	$uploadResult
	$rejectedUploadResult
	$uploadStreams

Detailed Description

Class FileUploadImpl.

Author

Nicolas Schäfli ns@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Since

5.3

Version

1.0.0

Definition at line 29 of file FileUploadImpl.php.

Constructor & Destructor Documentation

__construct()

ILIAS\FileUpload\FileUploadImpl::__construct	(	PreProcessorManager	$processorManager,
		Filesystems	$filesystems,
		GlobalHttpState	$globalHttpState
	)

FileUploadImpl constructor.

Parameters

PreProcessorManager	$processorManager	The processor manager which should be used.
Filesystems	$filesystems	The Filesystems implementation which should be used.
GlobalHttpState	$globalHttpState	The http implementation which should be used to detect the uploaded files.

Definition at line 75 of file FileUploadImpl.php.

References ILIAS\FileUpload\FileUploadImpl\$filesystems, ILIAS\FileUpload\FileUploadImpl\$globalHttpState, ILIAS\FileUpload\FileUploadImpl\$processorManager, and ILIAS\Filesystem\filesystems().

    {
        $this->processorManager = $processorManager;
        $this->filesystems = $filesystems;
        $this->globalHttpState = $globalHttpState;
        $this->processed = false;
        $this->moved = false;
        $this->uploadResult = [];
        $this->rejectedUploadResult = [];
    }

Here is the call graph for this function:

Member Function Documentation

flattenUploadedFiles()

ILIAS\FileUpload\FileUploadImpl::flattenUploadedFiles (   $uploadedFiles )

protected

Parameters

array

$uploadedFiles

Returns

UploadedFileInterface[]

Definition at line 351 of file FileUploadImpl.php.

Referenced by ILIAS\FileUpload\FileUploadImpl\hasUploads(), and ILIAS\FileUpload\FileUploadImpl\register().

    {
        $recursiveIterator = new RecursiveIteratorIterator(
            new RecursiveArrayIterator(
                $uploadedFiles,
                RecursiveArrayIterator::CHILD_ARRAYS_ONLY
            ),
            RecursiveIteratorIterator::LEAVES_ONLY
        );

        return iterator_to_array($recursiveIterator, false);
    }

Here is the caller graph for this function:

getResults()

ILIAS\FileUpload\FileUploadImpl::getResults

(

)

Implements ILIAS\FileUpload\FileUpload.

Definition at line 321 of file FileUploadImpl.php.

    {
        if ($this->processed) {
            return array_merge($this->uploadResult, $this->rejectedUploadResult);
        }

        throw new IllegalStateException('Can not fetch results without processing the uploads.');
    }

hasBeenProcessed()

ILIAS\FileUpload\FileUploadImpl::hasBeenProcessed

(

)

Returns

bool

Implements ILIAS\FileUpload\FileUpload.

Definition at line 368 of file FileUploadImpl.php.

References ILIAS\FileUpload\FileUploadImpl\$processed.

    {
        return $this->processed;
    }

hasUploads()

ILIAS\FileUpload\FileUploadImpl::hasUploads

(

)

Implements ILIAS\FileUpload\FileUpload.

Definition at line 334 of file FileUploadImpl.php.

References ILIAS\FileUpload\FileUploadImpl\flattenUploadedFiles().

    {
        if ($this->moved) {
            return false;
        }

        $uploadedFiles = $this->flattenUploadedFiles($this->globalHttpState->request()->getUploadedFiles());

        return (count($uploadedFiles) > 0);
    }

Here is the call graph for this function:

moveFilesTo()

ILIAS\FileUpload\FileUploadImpl::moveFilesTo	(		$destination,
			$location = Location::STORAGE
	)

Implements ILIAS\FileUpload\FileUpload.

Definition at line 117 of file FileUploadImpl.php.

References $destination, $key, $location, $path, ILIAS\FileUpload\FileUploadImpl\$uploadResult, ILIAS\Filesystem\Stream\Streams\ofPsr7Stream(), ILIAS\FileUpload\FileUploadImpl\regenerateUploadResultWithCopyError(), ILIAS\FileUpload\FileUploadImpl\regenerateUploadResultWithPath(), ILIAS\FileUpload\DTO\ProcessingStatus\REJECTED, and ILIAS\FileUpload\FileUploadImpl\selectFilesystem().

    {
        if ($this->processed === false) {
            throw new \RuntimeException('Can not move unprocessed files.');
        }

        if ($this->moved === true) {
            throw new \RuntimeException('Can not move the files a second time.');
        }

        $filesystem = $this->selectFilesystem($location);
        $tempResults = [];

        foreach ($this->uploadResult as $key => $uploadResult) {
            if ($uploadResult->getStatus()->getCode() == ProcessingStatus::REJECTED) {
                continue;
            }

            try {
                $path = $destination . '/' . $uploadResult->getName();
                $filesystem->writeStream($path, Streams::ofPsr7Stream($this->uploadStreams[$key]));
                $tempResults[] = $this->regenerateUploadResultWithPath($uploadResult, $path);
            } catch (IOException $ex) {
                $this->regenerateUploadResultWithCopyError($uploadResult, $ex->getMessage());
            }
        }

        $this->uploadResult = $tempResults;
        $this->uploadStreams = null;
        $this->moved = true;
    }

Here is the call graph for this function:

moveOneFileTo()

ILIAS\FileUpload\FileUploadImpl::moveOneFileTo	(	UploadResult	$uploadResult,
			$destination,
			$location = Location::STORAGE,
			$file_name = '',
			$override_existing = false
	)

Moves a single UploadResult to the given destination.

Parameters

UploadResult	$UploadResult	Which upload result do you want to move?
string	$destination	Where do you want to move the file?
int	$location	Location::[STORAGE|WEB|CUSTOMIZING]
string	$file_name	Do you want to rename the file?
bool	$override_existing	Override existing file with same name

Returns

void

Implements ILIAS\FileUpload\FileUpload.

Definition at line 89 of file FileUploadImpl.php.

References $destination, $location, $path, ILIAS\FileUpload\DTO\UploadResult\getName(), ILIAS\FileUpload\DTO\UploadResult\getPath(), ILIAS\FileUpload\DTO\UploadResult\getStatus(), ILIAS\Filesystem\Stream\Streams\ofPsr7Stream(), ILIAS\FileUpload\FileUploadImpl\regenerateUploadResultWithCopyError(), ILIAS\FileUpload\FileUploadImpl\regenerateUploadResultWithPath(), ILIAS\FileUpload\DTO\ProcessingStatus\REJECTED, and ILIAS\FileUpload\FileUploadImpl\selectFilesystem().

    {
        if ($this->processed === false) {
            throw new \RuntimeException('Can not move unprocessed files.');
        }
        $filesystem = $this->selectFilesystem($location);
        $tempResults = [];

        if ($uploadResult->getStatus()->getCode() == ProcessingStatus::REJECTED) {
            return false;
        }

        try {
            $path = rtrim($destination, "/") . '/' . ($file_name == "" ? $uploadResult->getName() : $file_name);
            if ($override_existing && $filesystem->has($path)) {
                $filesystem->delete($path);
            }
            $filesystem->writeStream($path, Streams::ofPsr7Stream($this->uploadStreams[$uploadResult->getPath()]));
            $tempResults[] = $this->regenerateUploadResultWithPath($uploadResult, $path);
        } catch (IOException $ex) {
            $this->regenerateUploadResultWithCopyError($uploadResult, $ex->getMessage());
        }
    }

Here is the call graph for this function:

regenerateUploadResultWithCopyError()

ILIAS\FileUpload\FileUploadImpl::regenerateUploadResultWithCopyError ( UploadResult  $result,   $errorReason  )

private

Creates a clone of the given result and set the status to rejected with the passed error message.

Parameters

UploadResult	$result	The result which should be cloned.
string	$errorReason	The reason why the error occurred.

Returns

UploadResult The newly cloned rejected result.

Definition at line 179 of file FileUploadImpl.php.

References ILIAS\FileUpload\DTO\UploadResult\getMetaData(), ILIAS\FileUpload\DTO\UploadResult\getMimeType(), ILIAS\FileUpload\DTO\UploadResult\getName(), ILIAS\FileUpload\DTO\UploadResult\getSize(), and ILIAS\FileUpload\DTO\ProcessingStatus\REJECTED.

Referenced by ILIAS\FileUpload\FileUploadImpl\moveFilesTo(), and ILIAS\FileUpload\FileUploadImpl\moveOneFileTo().

    {
        return new UploadResult(
            $result->getName(),
            $result->getSize(),
            $result->getMimeType(),
            $result->getMetaData(),
            new ProcessingStatus(ProcessingStatus::REJECTED, $errorReason),
            ''
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

regenerateUploadResultWithPath()

ILIAS\FileUpload\FileUploadImpl::regenerateUploadResultWithPath ( UploadResult  $result,   $path  )

private

Generate an exact copy of the result with the given path.

Parameters

UploadResult	$result	The result which should be cloned.
string	$path	The path which should be set on the result clone.

Returns

UploadResult The cloned result with the given path.

Definition at line 158 of file FileUploadImpl.php.

References $path, ILIAS\FileUpload\DTO\UploadResult\getMetaData(), ILIAS\FileUpload\DTO\UploadResult\getMimeType(), ILIAS\FileUpload\DTO\UploadResult\getName(), ILIAS\FileUpload\DTO\UploadResult\getSize(), and ILIAS\FileUpload\DTO\UploadResult\getStatus().

Referenced by ILIAS\FileUpload\FileUploadImpl\moveFilesTo(), and ILIAS\FileUpload\FileUploadImpl\moveOneFileTo().

    {
        return new UploadResult(
            $result->getName(),
            $result->getSize(),
            $result->getMimeType(),
            $result->getMetaData(),
            $result->getStatus(),
            $path
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

register()

ILIAS\FileUpload\FileUploadImpl::register

(

PreProcessor

$preProcessor

)

Implements ILIAS\FileUpload\FileUpload.

Definition at line 232 of file FileUploadImpl.php.

References $file, $metadata, $result, GuzzleHttp\Psr7\$stream, ILIAS\FileUpload\FileUploadImpl\flattenUploadedFiles(), ILIAS\Filesystem\Stream\Streams\ofPsr7Stream(), ILIAS\FileUpload\FileUpload\process(), and ILIAS\FileUpload\FileUploadImpl\rejectFailedUpload().

    {
        if ($this->processed === false) {
            $this->processorManager->with($preProcessor);
        } else {
            throw new IllegalStateException('Can not register processor after the upload was processed.');
        }
    }

Here is the call graph for this function:

rejectFailedUpload()

ILIAS\FileUpload\FileUploadImpl::rejectFailedUpload ( UploadedFileInterface  $file, Metadata  $metadata  )

private

Reject a failed upload with the given metadata.

Parameters

UploadedFileInterface	$file
Metadata	$metadata	The metadata used to create the rejected result.

Returns

void

Definition at line 300 of file FileUploadImpl.php.

References $result, ILIAS\FileUpload\DTO\Metadata\getFilename(), ILIAS\FileUpload\DTO\Metadata\getMimeType(), ILIAS\FileUpload\DTO\Metadata\getUploadSize(), and ILIAS\FileUpload\DTO\ProcessingStatus\REJECTED.

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

    {
        //reject failed upload
        $processingStatus = new ProcessingStatus(ProcessingStatus::REJECTED, 'Upload failed');
        $extraMetadata = new ImmutableMapWrapper(new EntryLockingStringMap());
        $result = new UploadResult(
            $metadata->getFilename(),
            $metadata->getUploadSize(),
            $metadata->getMimeType(),
            $extraMetadata,
            $processingStatus,
            ''
        );

        $this->rejectedUploadResult[] = $result;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

selectFilesystem()

ILIAS\FileUpload\FileUploadImpl::selectFilesystem (   $location )

private

Selects the correct filesystem by the given Location constant.

Parameters

int

$location

The storage location constant defined within the Location interface.

Returns

See also

Location

Exceptions

Definition at line 203 of file FileUploadImpl.php.

References $location, ILIAS\FileUpload\Location\CUSTOMIZING, ILIAS\Filesystem\filesystems(), ILIAS\FileUpload\Location\STORAGE, ILIAS\FileUpload\Location\TEMPORARY, and ILIAS\FileUpload\Location\WEB.

Referenced by ILIAS\FileUpload\FileUploadImpl\moveFilesTo(), and ILIAS\FileUpload\FileUploadImpl\moveOneFileTo().

    {
        switch ($location) {
            case Location::CUSTOMIZING:
                return $this->filesystems->customizing();
            case Location::STORAGE:
                return $this->filesystems->storage();
            case Location::WEB:
                return $this->filesystems->web();
            case Location::TEMPORARY:
                return $this->filesystems->temp();
            default:
                throw new \InvalidArgumentException("No filesystem found for location code \"$location\"");
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

uploadSizeLimit()

ILIAS\FileUpload\FileUploadImpl::uploadSizeLimit

(

)

Implements ILIAS\FileUpload\FileUpload.

Definition at line 223 of file FileUploadImpl.php.

    {
        return \ilUtil::getUploadSizeLimitBytes();
    }

Field Documentation

$filesystems

Filesystems ILIAS\FileUpload\FileUploadImpl::$filesystems

private

Definition at line 39 of file FileUploadImpl.php.

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

$globalHttpState

ILIAS\FileUpload\FileUploadImpl::$globalHttpState

private

Definition at line 43 of file FileUploadImpl.php.

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

$moved

bool ILIAS\FileUpload\FileUploadImpl::$moved

private

Definition at line 51 of file FileUploadImpl.php.

$processed

bool ILIAS\FileUpload\FileUploadImpl::$processed

private

Definition at line 47 of file FileUploadImpl.php.

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

$processorManager

PreProcessorManager ILIAS\FileUpload\FileUploadImpl::$processorManager

private

Definition at line 35 of file FileUploadImpl.php.

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

$rejectedUploadResult

ILIAS\FileUpload\FileUploadImpl::$rejectedUploadResult

private

Definition at line 59 of file FileUploadImpl.php.

$uploadResult

ILIAS\FileUpload\FileUploadImpl::$uploadResult

private

Definition at line 55 of file FileUploadImpl.php.

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

$uploadStreams

ILIAS\FileUpload\FileUploadImpl::$uploadStreams

private

Definition at line 63 of file FileUploadImpl.php.

---

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

• src/FileUpload/FileUploadImpl.php