ILIAS\Filesystem\Stream\Stream Class Reference

Class Stream. More...

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

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

Private Attributes
	$readable
	$writeable
	$seekable
	$stream
	$size
	$uri
	$customMetadata

Static Private Attributes
static	$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 17 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.

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

    {
        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');
    }

Here is the call graph for this function:

__destruct()

ILIAS\Filesystem\Stream\Stream::__destruct

(

)

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

(

)

Implements Psr\Http\Message\StreamInterface.

Definition at line 349 of file Stream.php.

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

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

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

Definition at line 380 of file Stream.php.

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

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

Here is the caller graph for this function:

close()

ILIAS\Filesystem\Stream\Stream::close

(

)

Implements Psr\Http\Message\StreamInterface.

Definition at line 110 of file Stream.php.

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

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

    {
        if ($this->stream !== null && 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

(

)

Implements Psr\Http\Message\StreamInterface.

Definition at line 123 of file Stream.php.

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

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

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

(

)

Implements Psr\Http\Message\StreamInterface.

Definition at line 184 of file Stream.php.

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

    {
        $this->assertStreamAttached();

        return feof($this->stream);
    }

Here is the call graph for this function:

getContents()

ILIAS\Filesystem\Stream\Stream::getContents

(

)

Implements Psr\Http\Message\StreamInterface.

Definition at line 299 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().

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

)

Implements Psr\Http\Message\StreamInterface.

Definition at line 316 of file Stream.php.

References $key.

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

    {

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

(

)

Implements Psr\Http\Message\StreamInterface.

Definition at line 135 of file Stream.php.

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

    {

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

(

)

Implements Psr\Http\Message\StreamInterface.

Definition at line 262 of file Stream.php.

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

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

    {
        return $this->readable;
    }

Here is the caller graph for this function:

isSeekable()

ILIAS\Filesystem\Stream\Stream::isSeekable

(

)

Implements Psr\Http\Message\StreamInterface.

Definition at line 195 of file Stream.php.

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

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

    {
        return $this->seekable;
    }

Here is the caller graph for this function:

isWritable()

ILIAS\Filesystem\Stream\Stream::isWritable

(

)

Implements Psr\Http\Message\StreamInterface.

Definition at line 230 of file Stream.php.

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

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

    {
        return $this->writeable;
    }

Here is the caller graph for this function:

read()

ILIAS\Filesystem\Stream\Stream::read

(

$length

)

Implements Psr\Http\Message\StreamInterface.

Definition at line 271 of file Stream.php.

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

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

(

)

Implements Psr\Http\Message\StreamInterface.

Definition at line 221 of file Stream.php.

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

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

    {
        $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
	)

Implements Psr\Http\Message\StreamInterface.

Definition at line 204 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().

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

(

)

Implements Psr\Http\Message\StreamInterface.

Definition at line 167 of file Stream.php.

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

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

)

Implements Psr\Http\Message\StreamInterface.

Definition at line 239 of file Stream.php.

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

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

$accessMap

ILIAS\Filesystem\Stream\Stream::$accessMap

staticprivate

Initial value:

= [
        'r'     => self::MASK_ACCESS_READ

Definition at line 23 of file Stream.php.

$customMetadata

ILIAS\Filesystem\Stream\Stream::$customMetadata

private

Definition at line 73 of file Stream.php.

$readable

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

private

Initial value:

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

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

$seekable

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

private

Definition at line 57 of file Stream.php.

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

$size

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

private

Definition at line 65 of file Stream.php.

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

$stream

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

private

Definition at line 61 of file Stream.php.

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

$uri

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

private

Definition at line 69 of file Stream.php.

$writeable

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

private

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

MASK_ACCESS_READ_WRITE

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

Definition at line 21 of file Stream.php.

MASK_ACCESS_WRITE

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

Definition at line 20 of file Stream.php.

---

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

• src/Filesystem/Stream/Stream.php