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.

References null.

Referenced by ILIAS\FileDelivery\Delivery\StreamDelivery\deliverFromToken(), ILIAS\components\ResourceStorage\Container\Wrapper\ZipReader\getItem(), ILIAS\Export\ExportHandler\Repository\Element\Wrapper\IRSS\Handler\getStreamOfContainerEntry(), ILIAS\Repository\IRSS\IRSSWrapper\getStreamOfContainerEntry(), and ILIAS\Repository\IRSS\IRSSWrapper\hasContainerEntry().

                                                                                         : 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().

                                                                 : 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().

                                                             : 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(), ILIAS\components\ResourceStorage\Container\Wrapper\ContainerWrapper\download(), ilDclFileRecordFieldModel\parseValue(), ILIAS\Filesystem\Provider\FlySystem\FlySystemFileStreamAccess\readStream(), ILIAS\LegalDocuments\Consumer\DownloadMultipleConsumer\run(), ILIAS\Test\ResponseHandler\sendAsync(), ILIAS\Repository\Resources\ZipAdapter\unzipFile(), and ILIAS\Export\ExportHandler\Consumer\ExportWriter\Handler\writeFileByFilePath().

                                                 : 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.

                                                    : 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:

components/ILIAS/Filesystem/src/Stream/Streams.php

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ ofFileInsideZIP()

◆ ofPsr7Stream()

◆ ofReattachableResource()

◆ ofResource()

◆ ofString()