ILIAS\Filesystem\Stream\Streams Class Reference

Stream factory which enables the user to create streams without the knowledge of the concrete class. More...

Collaboration diagram for ILIAS\Filesystem\Stream\Streams:

Static Public Member Functions
static	ofString (string $string)
	Creates a new stream with an initial value. More...
static	ofResource ($resource)
	Wraps an already created resource with the stream abstraction. More...
static	ofReattachableResource ($resource)
static	ofFileInsideZIP (string $path_to_zip, string $path_inside_zip)
static	ofPsr7Stream (StreamInterface $stream)
	Create a FileStream from a Psr7 compliant stream. More...

Detailed Description

Stream factory which enables the user to create streams without the knowledge of the concrete class.

Author

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

Fabian Schmid fabia.nosp@m.n@sr.nosp@m..solu.nosp@m.tion.nosp@m.s

Definition at line 31 of file Streams.php.

Member Function Documentation

ofFileInsideZIP()

static ILIAS\Filesystem\Stream\Streams::ofFileInsideZIP ( string  $path_to_zip, string  $path_inside_zip  )

static

Definition at line 84 of file Streams.php.

Referenced by ILIAS\Exercise\IRSS\CollectionWrapper\addEntryOfZipResourceToCollection(), and ILIAS\FileDelivery\Delivery\StreamDelivery\deliverFromToken().

                                                                                        : \ILIAS\Filesystem\Stream\ZIPStream
    {
        // we try to open the zip file with the path inside the zip file, once with a leading slash and once without
        try {
            $resource = fopen('zip://' . $path_to_zip . '#/' . $path_inside_zip, 'rb');
        } catch (\Throwable) {
            $resource = null;
        }
        try {
            $resource = $resource ?: fopen('zip://' . $path_to_zip . '#' . $path_inside_zip, 'rb');
        } catch (\Throwable) {
            $resource = null;
        }

        if (!is_resource($resource)) {
            throw new \InvalidArgumentException(
                'The argument $path_to_zip must be an existing zip file path and $path_inside_zip must be a valid path inside the zip file.'
            );
        }
        return new ZIPStream($resource);
    }

Here is the caller graph for this function:

ofPsr7Stream()

static ILIAS\Filesystem\Stream\Streams::ofPsr7Stream ( StreamInterface  $stream )

static

Create a FileStream from a Psr7 compliant stream.

Please not that the stream must be detached from the psr7 stream in order to create the filesystem stream.

Parameters

StreamInterface

$stream

The stream which should be parsed into a FileStream.

Returns

FileStream The newly created stream.

Definition at line 113 of file Streams.php.

References ILIAS\Filesystem\Stream\Stream\detach().

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

                                                                : \ILIAS\Filesystem\Stream\Stream
    {
        $resource = $stream->detach();
        return self::ofResource($resource);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

ofReattachableResource()

static ILIAS\Filesystem\Stream\Streams::ofReattachableResource (   $resource )

static

Definition at line 74 of file Streams.php.

Referenced by ILIAS\ResourceStorage\Resource\ResourceBuilder\extractStream().

                                                            : \ILIAS\Filesystem\Stream\ReattachableStream
    {
        if (!is_resource($resource)) {
            throw new \InvalidArgumentException(
                'The argument $resource must be of type resource but was "' . gettype($resource) . '"'
            );
        }
        return new ReattachableStream($resource);
    }

Here is the caller graph for this function:

ofResource()

static ILIAS\Filesystem\Stream\Streams::ofResource (   $resource )

static

Wraps an already created resource with the stream abstraction.

The stream abstraction only supports streams which are opened with fopen.

Parameters

resource

$resource

The resource which should be wrapped.

Returns

FileStream The newly created stream which wraps the given resource.

See also

fopen()

Definition at line 64 of file Streams.php.

Referenced by ILIAS\FileDelivery\Delivery\LegacyDelivery\deliver(), ILIAS\FileDelivery\Delivery\StreamDelivery\deliverFromToken(), ilDclFileRecordFieldModel\parseValue(), ILIAS\Filesystem\Provider\FlySystem\FlySystemFileStreamAccess\readStream(), ILIAS\ResourceStorage\Consumer\DownloadMultipleConsumer\run(), and ILIAS\Repository\Resources\ZipAdapter\unzipFile().

                                                : \ILIAS\Filesystem\Stream\Stream
    {
        if (!is_resource($resource)) {
            throw new \InvalidArgumentException(
                'The argument $resource must be of type resource but was "' . gettype($resource) . '"'
            );
        }
        return new Stream($resource);
    }

Here is the caller graph for this function:

ofString()

static ILIAS\Filesystem\Stream\Streams::ofString ( string  $string )

static

Creates a new stream with an initial value.

Please note that the whole stream is stored within memory.

Parameters

string

$string

The string which should be written as initial value.

Returns

FileStream The newly created in memory stream.

Definition at line 41 of file Streams.php.

Referenced by ilPropertyFormGUI\checkInput(), ILIAS\FileDelivery\Delivery\ResponseBuilder\ResponseBuilder\PHPResponseBuilder\deliverPartial(), ILIAS\Repository\HTTP\HTTPUtil\deliverString(), ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler\executeCommand(), ILIAS\LegalDocuments\Administration\exitWithJsonResponse(), ilECSSettingsGUI\exportImported(), ilECSSettingsGUI\exportReleased(), ILIAS\ResourceStorage\AbstractBaseTest\getDummyStream(), ilChatroomAuthInputGUI\getRandomValues(), ILIAS\Services\WOPI\Handler\RequestHandler\handleRequest(), ILIAS\GlobalScreen\Client\Notifications\handleRerender(), ILIAS\ResourceStorage\Flavour\Machine\DefaultMachines\CropSquare\maybeRotate(), ilDataCollectionGlobalTemplate\printToStdout(), ILIAS\ResourceStorage\Flavours\SVGDummyMachine\processStream(), ILIAS\ResourceStorage\Flavour\Machine\DefaultMachines\ExtractPages\processStream(), ILIAS\ResourceStorage\Flavour\Machine\NullMachine\processStream(), ILIAS\ResourceStorage\Flavour\FlavourBuilder\runMachine(), ILIAS\COPage\Editor\Server\Response\send(), ILIAS\Repository\send(), ILIAS\Export\PrintProcessGUI\send(), ILIAS\Repository\HTTP\HTTPUtil\sendString(), ILIAS\Saml\Module\sendXMLString(), ILIAS\ResourceStorage\Flavours\FlavourMachineTest\testMachineResult(), ILIAS\FileUpload\Processor\SVGPreProcessorTest\testMaliciousSVG(), ILIAS\ResourceStorage\Flavours\FlavourTest\testNewFlavour(), ILIAS\FileUpload\Processor\BlacklistFileHeaderPreProcessorTest\testProcessWhichShouldSucceed(), ILIAS\FileUpload\Processor\FilenameOverridePreProcessorTest\testProcessWhichShouldSucceed(), ILIAS\FileUpload\Processor\WhitelistExtensionPreProcessorTest\testProcessWhichShouldSucceed(), ILIAS\FileUpload\Processor\WhitelistFileHeaderPreProcessorTest\testProcessWhichShouldSucceed(), ILIAS\FileUpload\Processor\BlacklistExtensionPreProcessorTest\testProcessWhichShouldSucceed(), ILIAS\FileUpload\FileUploadImplTest\testProcessWhichShouldSucceed(), ILIAS\FileUpload\Processor\BlacklistExtensionPreProcessorTest\testProcessWithBlacklistedEmptyExtensionWhichShouldGetRejected(), ILIAS\FileUpload\Processor\BlacklistExtensionPreProcessorTest\testProcessWithBlacklistedExtensionWhichShouldGetRejected(), ILIAS\FileUpload\FileUploadImplTest\testProcessWithFailedUploadWhichShouldGetRejected(), ILIAS\FileUpload\Processor\WhitelistFileHeaderPreProcessorTest\testProcessWithHeaderMismatchWhichShouldGetRejected(), ILIAS\FileUpload\Processor\BlacklistFileHeaderPreProcessorTest\testProcessWithHeaderMismatchWhichShouldGetRejected(), ILIAS\FileUpload\Processor\WhitelistExtensionPreProcessorTest\testProcessWithoutExtensionWhichShouldSucceed(), ILIAS\FileUpload\Processor\WhitelistExtensionPreProcessorTest\testProcessWithoutWhitelistedExtensionWhichShouldGetRejected(), Filesystem\Provider\FlySystem\FlySystemFileStreamAccessTest\testPutStreamWhichShouldSucceed(), Filesystem\Provider\FlySystem\FlySystemFileStreamAccessTest\testPutStreamWithDetachedStreamWhichShouldFail(), Filesystem\Provider\FlySystem\FlySystemFileStreamAccessTest\testPutStreamWithGeneralFailureWhichShouldFail(), ILIAS\FileUpload\Processor\SVGPreProcessorTest\testSaneSVG(), ILIAS\FileUpload\Processor\SVGPreProcessorTest\testSomeComplexSaneSVG(), Filesystem\Provider\FlySystem\FlySystemFileStreamAccessTest\testUpdateStreamWhichShouldSucceed(), Filesystem\Provider\FlySystem\FlySystemFileStreamAccessTest\testUpdateStreamWithDetachedStreamWhichShouldFail(), Filesystem\Provider\FlySystem\FlySystemFileStreamAccessTest\testUpdateStreamWithGeneralFailureWhichShouldFail(), Filesystem\Provider\FlySystem\FlySystemFileStreamAccessTest\testUpdateStreamWithMissingFileWhichShouldFail(), Filesystem\Provider\FlySystem\FlySystemFileStreamAccessTest\testWriteStreamWhichShouldSucceed(), Filesystem\Provider\FlySystem\FlySystemFileStreamAccessTest\testWriteStreamWithDetachedStreamWhichShouldFail(), Filesystem\Provider\FlySystem\FlySystemFileStreamAccessTest\testWriteStreamWithExistingFileWhichShouldFail(), Filesystem\Provider\FlySystem\FlySystemFileStreamAccessTest\testWriteStreamWithFailingAdapterWhichShouldFail(), and ILIAS\ResourceStorage\Flavour\Machine\DefaultMachines\to().

                                                   : \ILIAS\Filesystem\Stream\Stream
    {
        if (!is_string($string)) {
            throw new \InvalidArgumentException(
                'The argument $string must be of type string but was "' . gettype($string) . '"'
            );
        }

        $stream = new Stream(fopen('php://memory', 'rw'));
        $stream->write($string);
        return $stream;
    }

Here is the caller graph for this function:

---

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

• src/Filesystem/Stream/Streams.php