ILIAS\Filesystem\Stream\Stream Class Reference

Inheritance diagram for ILIAS\Filesystem\Stream\Stream:

Collaboration diagram for ILIAS\Filesystem\Stream\Stream:

Public Member Functions
	__construct ($stream, ?StreamOptions $options=null)
	Stream constructor. More...
	close ()
	detach ()
	getSize ()
	tell ()
	eof ()
	isSeekable ()
	seek ($offset, $whence=SEEK_SET)
	rewind ()
	isWritable ()
	write ($string)
	isReadable ()
	read ($length)
	getContents ()
	getMetadata ($key=null)
	__toString ()
	__destruct ()

Data Fields
const	MASK_ACCESS_READ = 01
const	MASK_ACCESS_WRITE = 02
const	MASK_ACCESS_READ_WRITE = 03

Protected Member Functions
	assertStreamAttached ()
	Checks if the stream is attached to the wrapper. More...

Protected Attributes
static array string	$_mode = null
bool	$readable
bool	$writeable
bool	$seekable
	$stream
int	$size = null
string	$uri = null
array	$customMetadata

Static Protected Attributes
static array	$accessMap

Detailed Description

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 29 of file Stream.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Filesystem\Stream\Stream::__construct	(		$stream,
		?StreamOptions	$options = null
	)

Stream constructor.

Parameters

resource	$stream	The resource which should be wrapped by the Stream.
StreamOptions | null	$options	The additional options which are accessible via getMetadata

Definition at line 79 of file Stream.php.

References ILIAS\Filesystem\Stream\Stream\$stream, ILIAS\Filesystem\Stream\Stream\getMetadata(), and null.

    {
        if (!is_resource($stream)) {
            throw new \InvalidArgumentException(
                'Stream must be a valid resource but "' . gettype($stream) . '" was given.'
            );
        }

        if ($options !== null) {
            $this->customMetadata = $options->getMetadata();
            $this->size = ($options->getSize() !== -1) ? $options->getSize() : null;
        } else {
            $this->customMetadata = [];
        }

        $this->stream = $stream;

        $meta = stream_get_meta_data($this->stream);
        $this->_mode = $mode = $meta['mode'];

        $this->readable = array_key_exists(
            $mode,
            self::$accessMap
        ) && (bool) (self::$accessMap[$mode] & self::MASK_ACCESS_READ);
        $this->writeable = array_key_exists(
            $mode,
            self::$accessMap
        ) && (bool) (self::$accessMap[$mode] & self::MASK_ACCESS_WRITE);
        $this->seekable = $meta['seekable'];
        $this->uri = $this->getMetadata('uri');
    }

Here is the call graph for this function:

__destruct()

ILIAS\Filesystem\Stream\Stream::__destruct

(

)

Definition at line 352 of file Stream.php.

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

    {
        //cleanup the resource on object destruction if the stream is not detached.
        if (!is_null($this->stream)) {
            $this->close();
        }
    }

Here is the call graph for this function:

Member Function Documentation

__toString()

ILIAS\Filesystem\Stream\Stream::__toString

(

)

Definition at line 338 of file Stream.php.

References ILIAS\Filesystem\Stream\Stream\getContents(), and ILIAS\Filesystem\Stream\Stream\rewind().

                                : string
    {
        try {
            $this->rewind();
            return $this->getContents();
        } catch (\Exception) {
            //to string must not throw an error.
            return '';
        }
    }

Here is the call graph for this function:

assertStreamAttached()

ILIAS\Filesystem\Stream\Stream::assertStreamAttached ( )

protected

Checks if the stream is attached to the wrapper.

An exception if thrown if the stream is already detached.

Exceptions

Definition at line 366 of file Stream.php.

References null.

Referenced by ILIAS\Filesystem\Stream\Stream\eof(), ILIAS\Filesystem\Stream\Stream\getContents(), ILIAS\Filesystem\Stream\Stream\read(), ILIAS\Filesystem\Stream\Stream\seek(), ILIAS\Filesystem\Stream\Stream\tell(), and ILIAS\Filesystem\Stream\Stream\write().

                                             : void
    {
        if ($this->stream === null) {
            throw new \RuntimeException('Stream is detached');
        }
    }

Here is the caller graph for this function:

close()

ILIAS\Filesystem\Stream\Stream::close

(

)

Definition at line 114 of file Stream.php.

References ILIAS\Filesystem\Stream\Stream\detach(), and ILIAS\Filesystem\Util\PHPStreamFunctions\fclose().

Referenced by ILIAS\Filesystem\Stream\Stream\__destruct().

                           : void
    {
        if (is_resource($this->stream)) {
            PHPStreamFunctions::fclose($this->stream);
        }

        $this->detach();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

detach()

ILIAS\Filesystem\Stream\Stream::detach

(

)

Definition at line 126 of file Stream.php.

References ILIAS\Filesystem\Stream\Stream\$stream, and null.

Referenced by ILIAS\Filesystem\Stream\Stream\close(), ILIAS\Filesystem\Stream\Streams\ofPsr7Stream(), ILIAS\ResourceStorage\Flavour\Machine\DefaultMachines\Extract\General\readImage(), and ILIAS\ResourceStorage\Flavour\Machine\DefaultMachines\Extract\PDF\readImage().

    {
        $stream = $this->stream;
        $this->stream = $this->size = $this->uri = null;

        return $stream;
    }

Here is the caller graph for this function:

eof()

ILIAS\Filesystem\Stream\Stream::eof

(

)

Definition at line 183 of file Stream.php.

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

                         : bool
    {
        $this->assertStreamAttached();

        return feof($this->stream);
    }

Here is the call graph for this function:

getContents()

ILIAS\Filesystem\Stream\Stream::getContents

(

)

Definition at line 290 of file Stream.php.

References ILIAS\Filesystem\Stream\Stream\assertStreamAttached(), and ILIAS\Filesystem\Util\PHPStreamFunctions\stream_get_contents().

Referenced by ILIAS\Filesystem\Stream\Stream\__toString().

                                 : string
    {
        $this->assertStreamAttached();

        $content = PHPStreamFunctions::stream_get_contents($this->stream);

        if ($content === false) {
            throw new \RuntimeException('Unable to read stream contents');
        }

        return $content;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getMetadata()

ILIAS\Filesystem\Stream\Stream::getMetadata

(

$key = null

)

Definition at line 306 of file Stream.php.

References null.

Referenced by ILIAS\Filesystem\Stream\Stream\__construct(), ILIAS\Export\ExportHandler\Repository\Element\Wrapper\IRSS\Handler\getStreamOfContainerEntry(), ILIAS\ResourceStorage\Flavour\Machine\DefaultMachines\Extract\Video\readImage(), and ILIAS\ResourceStorage\Flavour\Machine\DefaultMachines\Extract\PDF\readImage().

    {
        //return empty array if stream is detached
        if ($this->stream === null) {
            return [];
        }

        //return merged metadata if key is missing
        if ($key === null) {
            return array_merge(stream_get_meta_data($this->stream), $this->customMetadata);
        }

        //return value if key was provided

        //try fetch data from custom metadata
        if (array_key_exists($key, $this->customMetadata)) {
            return $this->customMetadata[$key];
        }

        //try to fetch data from php resource metadata
        $meta = stream_get_meta_data($this->stream);
        if (array_key_exists($key, $meta)) {
            return $meta[$key];
        }

        //the key was not found in standard and custom metadata.
        return null;
    }

Here is the caller graph for this function:

getSize()

ILIAS\Filesystem\Stream\Stream::getSize

(

)

Definition at line 137 of file Stream.php.

References ILIAS\Filesystem\Stream\Stream\$size, and null.

                             : ?int
    {
        //check if we know the size
        if ($this->size !== null) {
            return $this->size;
        }

        //check if stream is detached
        if ($this->stream === null) {
            return null;
        }

        //clear stat cache if we got a uri (indicates that we have a file resource)
        if ($this->uri !== null) {
            clearstatcache(true, $this->uri);
        }

        $stats = fstat($this->stream) ?: [];
        if (array_key_exists('size', $stats)) {
            $this->size = $stats['size'];
            return $this->size;
        }

        //unable to determine stream size
        return null;
    }

isReadable()

ILIAS\Filesystem\Stream\Stream::isReadable

(

)

Definition at line 255 of file Stream.php.

References ILIAS\Filesystem\Stream\Stream\$readable.

Referenced by ILIAS\Filesystem\Stream\Stream\read().

                                : bool
    {
        return $this->readable;
    }

Here is the caller graph for this function:

isSeekable()

ILIAS\Filesystem\Stream\Stream::isSeekable

(

)

Definition at line 193 of file Stream.php.

References ILIAS\Filesystem\Stream\Stream\$seekable.

Referenced by ILIAS\Filesystem\Stream\Stream\seek().

                                : bool
    {
        return $this->seekable;
    }

Here is the caller graph for this function:

isWritable()

ILIAS\Filesystem\Stream\Stream::isWritable

(

)

Definition at line 225 of file Stream.php.

References ILIAS\Filesystem\Stream\Stream\$writeable.

Referenced by ILIAS\Filesystem\Stream\Stream\write().

                                : bool
    {
        return $this->writeable;
    }

Here is the caller graph for this function:

read()

ILIAS\Filesystem\Stream\Stream::read

(

$length

)

Definition at line 263 of file Stream.php.

References ILIAS\Filesystem\Stream\Stream\assertStreamAttached(), ILIAS\Filesystem\Util\PHPStreamFunctions\fread(), and ILIAS\Filesystem\Stream\Stream\isReadable().

                                 : string
    {
        $this->assertStreamAttached();

        if (!$this->isReadable()) {
            throw new \RuntimeException('Can not read from non-readable stream');
        }

        if ($length < 0) {
            throw new \RuntimeException('Length parameter must not be negative');
        }

        if ($length === 0) {
            return '';
        }

        $junk = PHPStreamFunctions::fread($this->stream, $length);
        if ($junk === false) {
            throw new \RuntimeException('Unable to read from stream');
        }

        return $junk;
    }

Here is the call graph for this function:

rewind()

ILIAS\Filesystem\Stream\Stream::rewind

(

)

Definition at line 217 of file Stream.php.

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

Referenced by ILIAS\Filesystem\Stream\Stream\__toString().

                            : void
    {
        $this->seek(0);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

seek()

ILIAS\Filesystem\Stream\Stream::seek	(		$offset,
			$whence = SEEK_SET
	)

Definition at line 201 of file Stream.php.

References ILIAS\Filesystem\Stream\Stream\assertStreamAttached(), ILIAS\Filesystem\Util\PHPStreamFunctions\fseek(), and ILIAS\Filesystem\Stream\Stream\isSeekable().

Referenced by ILIAS\Filesystem\Stream\Stream\rewind().

                                                     : void
    {
        $this->assertStreamAttached();

        if (!$this->isSeekable()) {
            throw new \RuntimeException('Stream is not seekable');
        }

        if (PHPStreamFunctions::fseek($this->stream, $offset, $whence) === -1) {
            throw new \RuntimeException("Unable to seek to stream position \"$offset\" with whence \"$whence\"");
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

tell()

ILIAS\Filesystem\Stream\Stream::tell

(

)

Definition at line 167 of file Stream.php.

References ILIAS\Filesystem\Stream\Stream\assertStreamAttached(), and ILIAS\Filesystem\Util\PHPStreamFunctions\ftell().

                          : int
    {
        $this->assertStreamAttached();

        $result = PHPStreamFunctions::ftell($this->stream);

        if ($result === false) {
            throw new \RuntimeException('Unable to determine stream position');
        }

        return $result;
    }

Here is the call graph for this function:

write()

ILIAS\Filesystem\Stream\Stream::write

(

$string

)

Definition at line 233 of file Stream.php.

References ILIAS\Filesystem\Stream\Stream\assertStreamAttached(), ILIAS\Filesystem\Util\PHPStreamFunctions\fwrite(), ILIAS\Filesystem\Stream\Stream\isWritable(), and null.

                                  : int
    {
        $this->assertStreamAttached();

        if (!$this->isWritable()) {
            throw new \RuntimeException('Can not write to a non-writable stream');
        }

        //we can't know the new size
        $this->size = null;
        $result = PHPStreamFunctions::fwrite($this->stream, $string);

        if ($result === false) {
            throw new \RuntimeException('Unable to write to stream');
        }

        return $result;
    }

Here is the call graph for this function:

Field Documentation

$_mode

array string ILIAS\Filesystem\Stream\Stream::$_mode = null

protected

Definition at line 57 of file Stream.php.

$accessMap

array ILIAS\Filesystem\Stream\Stream::$accessMap

staticprotected

Initial value:

= [
        'r' => self::MASK_ACCESS_READ

Definition at line 35 of file Stream.php.

$customMetadata

array ILIAS\Filesystem\Stream\Stream::$customMetadata

protected

Definition at line 71 of file Stream.php.

$readable

bool ILIAS\Filesystem\Stream\Stream::$readable

protected

Definition at line 59 of file Stream.php.

Referenced by ILIAS\Filesystem\Stream\Stream\isReadable().

$seekable

bool ILIAS\Filesystem\Stream\Stream::$seekable

protected

Definition at line 61 of file Stream.php.

Referenced by ILIAS\Filesystem\Stream\Stream\isSeekable().

$size

int ILIAS\Filesystem\Stream\Stream::$size = null

protected

Definition at line 66 of file Stream.php.

Referenced by ILIAS\Filesystem\Stream\Stream\getSize().

$stream

null ILIAS\Filesystem\Stream\Stream::$stream

protected

Definition at line 65 of file Stream.php.

Referenced by ILIAS\Filesystem\Stream\Stream\__construct(), and ILIAS\Filesystem\Stream\Stream\detach().

$uri

string ILIAS\Filesystem\Stream\Stream::$uri = null

protected

Definition at line 67 of file Stream.php.

$writeable

bool ILIAS\Filesystem\Stream\Stream::$writeable

protected

Definition at line 60 of file Stream.php.

Referenced by ILIAS\Filesystem\Stream\Stream\isWritable().

MASK_ACCESS_READ

const ILIAS\Filesystem\Stream\Stream::MASK_ACCESS_READ = 01

Definition at line 31 of file Stream.php.

MASK_ACCESS_READ_WRITE

const ILIAS\Filesystem\Stream\Stream::MASK_ACCESS_READ_WRITE = 03

Definition at line 33 of file Stream.php.

MASK_ACCESS_WRITE

const ILIAS\Filesystem\Stream\Stream::MASK_ACCESS_WRITE = 02

Definition at line 32 of file Stream.php.

---

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

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