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 ()
	@inheritDoc More...

	detach ()
	@inheritDoc More...

	getSize ()
	@inheritDoc More...

	tell ()
	@inheritDoc More...

	eof ()
	@inheritDoc More...

	isSeekable ()
	@inheritDoc More...

	seek ($offset, $whence=SEEK_SET)
	@inheritDoc More...

	rewind ()
	@inheritDoc More...

	isWritable ()
	@inheritDoc More...

	write ($string)
	@inheritDoc More...

	isReadable ()
	@inheritDoc More...

	read ($length)
	@inheritDoc More...

	getContents ()
	@inheritDoc More...

	getMetadata ($key=null)
	@inheritDoc More...

	__toString ()
	@inheritDoc More...

	__destruct ()
	@inheritDoc More...

Data Fields
const	MASK_ACCESS_READ = 01

const	MASK_ACCESS_WRITE = 02

const	MASK_ACCESS_READ_WRITE = 03

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

Private Attributes
bool	$readable

bool	$writeable

bool	$seekable

	$stream

int	$size = null

string	$uri = null

array	$customMetadata

Static Private Attributes
static array	$accessMap

Detailed Description

Class Stream.

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 32 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	$options	The additional options which are accessible via getMetadata

Definition at line 82 of file Stream.php.

    {
        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);
        $mode = $meta['mode'];
 
        $this->readable = array_key_exists($mode, self::$accessMap) && boolval(self::$accessMap[$mode] & self::MASK_ACCESS_READ);
        $this->writeable = array_key_exists($mode, self::$accessMap) && boolval(self::$accessMap[$mode] & self::MASK_ACCESS_WRITE);
        $this->seekable = boolval($meta['seekable']);
        $this->uri = $this->getMetadata('uri');
    }

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

Here is the call graph for this function:

◆ __destruct()

ILIAS\Filesystem\Stream\Stream::__destruct ( )

@inheritDoc

Definition at line 363 of file Stream.php.

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

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

Here is the call graph for this function:

Member Function Documentation

◆ __toString()

ILIAS\Filesystem\Stream\Stream::__toString ( )

@inheritDoc

Definition at line 348 of file Stream.php.

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

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

Here is the call graph for this function:

◆ assertStreamAttached()

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

private

Checks if the stream is attached to the wrapper.

An exception if thrown if the stream is already detached.

Exceptions

RuntimeException Thrown if the stream is already detached.

Definition at line 379 of file Stream.php.

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

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

Here is the caller graph for this function:

◆ close()

ILIAS\Filesystem\Stream\Stream::close ( )

@inheritDoc

Definition at line 110 of file Stream.php.

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ detach()

ILIAS\Filesystem\Stream\Stream::detach ( )

@inheritDoc

Definition at line 123 of file Stream.php.

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

References ILIAS\Filesystem\Stream\Stream\$stream.

Referenced by ILIAS\Filesystem\Stream\Stream\close(), and ILIAS\Filesystem\Stream\Streams\ofPsr7Stream().

Here is the caller graph for this function:

◆ eof()

ILIAS\Filesystem\Stream\Stream::eof ( )

@inheritDoc

Definition at line 183 of file Stream.php.

                         : bool
    {
        $this->assertStreamAttached();
 
        return feof($this->stream);
    }

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

Here is the call graph for this function:

◆ getContents()

ILIAS\Filesystem\Stream\Stream::getContents ( )

@inheritDoc

Definition at line 298 of file Stream.php.

    {
        $this->assertStreamAttached();
 
        $content = PHPStreamFunctions::stream_get_contents($this->stream);
 
        if ($content === false) {
            throw new \RuntimeException('Unable to read stream contents');
        }
 
        return $content;
    }

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMetadata()

ILIAS\Filesystem\Stream\Stream::getMetadata ( $key = null )

@inheritDoc

Definition at line 315 of file Stream.php.

    {
 
        //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;
    }

References ILIAS\LTI\ToolProvider\$key.

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

Here is the caller graph for this function:

◆ getSize()

ILIAS\Filesystem\Stream\Stream::getSize ( )

@inheritDoc

Definition at line 135 of file Stream.php.

                             : ?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;
    }

References ILIAS\Filesystem\Stream\Stream\$size.

◆ isReadable()

ILIAS\Filesystem\Stream\Stream::isReadable ( )

@inheritDoc

Definition at line 261 of file Stream.php.

                                : bool
    {
        return $this->readable;
    }

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

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

Here is the caller graph for this function:

◆ isSeekable()

ILIAS\Filesystem\Stream\Stream::isSeekable ( )

@inheritDoc

Definition at line 194 of file Stream.php.

                                : bool
    {
        return $this->seekable;
    }

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

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

Here is the caller graph for this function:

◆ isWritable()

ILIAS\Filesystem\Stream\Stream::isWritable ( )

@inheritDoc

Definition at line 229 of file Stream.php.

                                : bool
    {
        return $this->writeable;
    }

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

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

Here is the caller graph for this function:

◆ read()

ILIAS\Filesystem\Stream\Stream::read ( $length )

@inheritDoc

Definition at line 270 of file Stream.php.

    {
        $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;
    }

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

Referenced by ILIAS\ResourceStorage\Consumer\StreamAccess\TokenStream\getMimeType().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ rewind()

ILIAS\Filesystem\Stream\Stream::rewind ( )

@inheritDoc

Definition at line 220 of file Stream.php.

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

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

Referenced by ILIAS\Filesystem\Stream\Stream\__toString(), and ILIAS\ResourceStorage\Consumer\StreamAccess\TokenStream\getMimeType().

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`
	)

@inheritDoc

Definition at line 203 of file Stream.php.

                                                     : 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\"");
        }
    }

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ tell()

ILIAS\Filesystem\Stream\Stream::tell ( )

@inheritDoc

Definition at line 166 of file Stream.php.

    {
        $this->assertStreamAttached();
 
        $result = PHPStreamFunctions::ftell($this->stream);
 
        if ($result === false) {
            throw new \RuntimeException('Unable to determine stream position');
        }
 
        return $result;
    }

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

Here is the call graph for this function:

◆ write()

ILIAS\Filesystem\Stream\Stream::write ( $string )

@inheritDoc

Definition at line 238 of file Stream.php.

    {
        $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;
    }

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

Here is the call graph for this function:

Field Documentation

◆ $accessMap

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

staticprivate

Initial value:

= [
        'r' => self::MASK_ACCESS_READ,
        'w+' => self::MASK_ACCESS_READ_WRITE,
        'r+' => self::MASK_ACCESS_READ_WRITE,
        'x+' => self::MASK_ACCESS_READ_WRITE,
        'c+' => self::MASK_ACCESS_READ_WRITE,
        'rb' => self::MASK_ACCESS_READ,
        'w+b' => self::MASK_ACCESS_READ_WRITE,
        'r+b' => self::MASK_ACCESS_READ_WRITE,
        'x+b' => self::MASK_ACCESS_READ_WRITE,
        'c+b' => self::MASK_ACCESS_READ_WRITE,
        'rt' => self::MASK_ACCESS_READ,
        'w+t' => self::MASK_ACCESS_READ_WRITE,
        'r+t' => self::MASK_ACCESS_READ_WRITE,
        'x+t' => self::MASK_ACCESS_READ_WRITE,
        'c+t' => self::MASK_ACCESS_READ_WRITE,
        'a+' => self::MASK_ACCESS_READ_WRITE,
        'w' => self::MASK_ACCESS_WRITE,
        'rw' => self::MASK_ACCESS_WRITE,
        'wb' => self::MASK_ACCESS_WRITE,
        'a' => self::MASK_ACCESS_WRITE
    ]

Definition at line 38 of file Stream.php.

◆ $customMetadata

string[] ILIAS\Filesystem\Stream\Stream::$customMetadata

private

Definition at line 73 of file Stream.php.

◆ $readable

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

private

Definition at line 61 of file Stream.php.

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

◆ $seekable

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

private

Definition at line 63 of file Stream.php.

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

◆ $size

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

private

Definition at line 68 of file Stream.php.

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

◆ $stream

resource ILIAS\Filesystem\Stream\Stream::$stream

private

Definition at line 67 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

private

Definition at line 69 of file Stream.php.

◆ $writeable

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

private

Definition at line 62 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 34 of file Stream.php.

◆ MASK_ACCESS_READ_WRITE

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

Definition at line 36 of file Stream.php.

◆ MASK_ACCESS_WRITE

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

Definition at line 35 of file Stream.php.

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

src/Filesystem/Stream/Stream.php

Public Member Functions

Data Fields

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

◆ __destruct()

Member Function Documentation

◆ __toString()

◆ assertStreamAttached()

◆ close()

◆ detach()

◆ eof()

◆ getContents()

◆ getMetadata()

◆ getSize()

◆ isReadable()

◆ isSeekable()

◆ isWritable()

◆ read()

◆ rewind()

◆ seek()

◆ tell()

◆ write()

Field Documentation

◆ $accessMap

◆ $customMetadata

◆ $readable

◆ $seekable

◆ $size

◆ $stream

◆ $uri

◆ $writeable

◆ MASK_ACCESS_READ

◆ MASK_ACCESS_READ_WRITE

◆ MASK_ACCESS_WRITE