Streams.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\Filesystem\Stream;

use Psr\Http\Message\StreamInterface;

final class Streams
{
    public static function ofString(string $string): \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;
    }

    public static function ofResource($resource): \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);
    }

    public static function ofReattachableResource($resource): \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);
    }

    public static function ofFileInsideZIP(string $path_to_zip, string $path_inside_zip): \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);
    }

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