Slim\Http\Stream Class Reference

Represents a data stream as defined in PSR-7. More...

Inheritance diagram for Slim\Http\Stream:

Collaboration diagram for Slim\Http\Stream:

Public Member Functions
	__construct ($stream)
	Create a new Stream. More...
	getMetadata ($key=null)
	Get stream metadata as an associative array or retrieve a specific key. More...
	detach ()
	Separates any underlying resources from the stream. More...
	__toString ()
	Reads all data from the stream into a string, from the beginning to end. More...
	close ()
	Closes the stream and any underlying resources. More...
	getSize ()
	Get the size of the stream if known. More...
	tell ()
	Returns the current position of the file read/write pointer. More...
	eof ()
	Returns true if the stream is at the end of the stream. More...
	isReadable ()
	Returns whether or not the stream is readable. More...
	isWritable ()
	Returns whether or not the stream is writable. More...
	isSeekable ()
	Returns whether or not the stream is seekable. More...
	seek ($offset, $whence=SEEK_SET)
	Seek to a position in the stream. More...
	rewind ()
	Seek to the beginning of the stream. More...
	read ($length)
	Read data from the stream. More...
	write ($string)
	Write data to the stream. More...
	getContents ()
	Returns the remaining contents in a string. More...
	isPipe ()
	Returns whether or not the stream is a pipe. More...

Data Fields
const	FSTAT_MODE_S_IFIFO = 0010000
	Bit mask to determine if the stream is a pipe. More...

Protected Member Functions
	isAttached ()
	Is a resource attached to this stream? More...
	attach ($newStream)
	Attach new resource to this object. More...

Protected Attributes
	$stream
	$meta
	$readable
	$writable
	$seekable
	$size
	$isPipe

Static Protected Attributes
static	$modes

Detailed Description

Represents a data stream as defined in PSR-7.

https://github.com/php-fig/http-message/blob/master/src/StreamInterface.php

Definition at line 20 of file Stream.php.

Constructor & Destructor Documentation

__construct()

Slim\Http\Stream::__construct

(

$stream

)

Create a new Stream.

Parameters

resource

$stream

A PHP resource handle.

Exceptions

InvalidArgumentException

If argument is not a resource.

Definition at line 96 of file Stream.php.

References Slim\Http\Stream\$stream, and Slim\Http\Stream\attach().

    {
        $this->attach($stream);
    }

Here is the call graph for this function:

Member Function Documentation

__toString()

Slim\Http\Stream::__toString

(

)

Reads all data from the stream into a string, from the beginning to end.

This method MUST attempt to seek to the beginning of the stream before reading data and read the stream until the end is reached.

Warning: This could attempt to load a large amount of data into memory.

This method MUST NOT raise an exception in order to conform with PHP's string casting operations.

See also

http://php.net/manual/en/language.oop5.magic.php#object.tostring

Returns

string

Implements Psr\Http\Message\StreamInterface.

Definition at line 194 of file Stream.php.

References Slim\Http\Stream\getContents(), Slim\Http\Stream\isAttached(), and Slim\Http\Stream\rewind().

    {
        if (!$this->isAttached()) {
            return '';
        }

        try {
            $this->rewind();
            return $this->getContents();
        } catch (RuntimeException $e) {
            return '';
        }
    }

Here is the call graph for this function:

attach()

Slim\Http\Stream::attach (   $newStream )

protected

Attach new resource to this object.

Note: This method is not part of the PSR-7 standard.

Parameters

resource

$newStream

A PHP resource handle.

Exceptions

InvalidArgumentException

If argument is not a valid PHP resource.

Definition at line 146 of file Stream.php.

References Slim\Http\Stream\detach(), and Slim\Http\Stream\isAttached().

Referenced by Slim\Http\Stream\__construct().

    {
        if (is_resource($newStream) === false) {
            throw new InvalidArgumentException(__METHOD__ . ' argument must be a valid PHP resource');
        }

        if ($this->isAttached() === true) {
            $this->detach();
        }

        $this->stream = $newStream;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

close()

Slim\Http\Stream::close

(

)

Closes the stream and any underlying resources.

Implements Psr\Http\Message\StreamInterface.

Definition at line 211 of file Stream.php.

References Slim\Http\Stream\detach(), Slim\Http\Stream\isAttached(), and Slim\Http\Stream\isPipe().

    {
        if ($this->isAttached() === true) {
            if ($this->isPipe()) {
                pclose($this->stream);
            } else {
                fclose($this->stream);
            }
        }

        $this->detach();
    }

Here is the call graph for this function:

detach()

Slim\Http\Stream::detach

(

)

Separates any underlying resources from the stream.

After the stream has been detached, the stream is in an unusable state.

Returns

resource|null Underlying PHP stream, if any

Implements Psr\Http\Message\StreamInterface.

Definition at line 166 of file Stream.php.

References Slim\Http\Stream\$stream, Slim\Http\Stream\isPipe(), and size.

Referenced by Slim\Http\Stream\attach(), and Slim\Http\Stream\close().

    {
        $oldResource = $this->stream;
        $this->stream = null;
        $this->meta = null;
        $this->readable = null;
        $this->writable = null;
        $this->seekable = null;
        $this->size = null;
        $this->isPipe = null;

        return $oldResource;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

eof()

Slim\Http\Stream::eof

(

)

Returns true if the stream is at the end of the stream.

Returns

bool

Implements Psr\Http\Message\StreamInterface.

Definition at line 260 of file Stream.php.

References Slim\Http\Stream\isAttached().

    {
        return $this->isAttached() ? feof($this->stream) : true;
    }

Here is the call graph for this function:

getContents()

Slim\Http\Stream::getContents

(

)

Returns the remaining contents in a string.

Returns

string

Exceptions

RuntimeException

if unable to read or an error occurs while reading.

Implements Psr\Http\Message\StreamInterface.

Definition at line 424 of file Stream.php.

References $contents, and Slim\Http\Stream\isReadable().

Referenced by Slim\Http\Stream\__toString().

    {
        if (!$this->isReadable() || ($contents = stream_get_contents($this->stream)) === false) {
            throw new RuntimeException('Could not get contents of stream');
        }

        return $contents;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getMetadata()

Slim\Http\Stream::getMetadata

(

$key = null

)

Get stream metadata as an associative array or retrieve a specific key.

The keys returned are identical to the keys returned from PHP's stream_get_meta_data() function.

string $key Specific metadata to retrieve. array|mixed|null Returns an associative array if no key is provided. Returns a specific key value if a key is provided and the value is found, or null if the key is not found.

Implements Psr\Http\Message\StreamInterface.

Definition at line 115 of file Stream.php.

References $key, and Slim\Http\Stream\$meta.

Referenced by Slim\Http\Stream\isReadable(), Slim\Http\Stream\isSeekable(), and Slim\Http\Stream\isWritable().

    {
        $this->meta = stream_get_meta_data($this->stream);
        if (is_null($key) === true) {
            return $this->meta;
        }

        return isset($this->meta[$key]) ? $this->meta[$key] : null;
    }

Here is the caller graph for this function:

getSize()

Slim\Http\Stream::getSize

(

)

Get the size of the stream if known.

Returns

int|null Returns the size in bytes if known, or null if unknown.

Implements Psr\Http\Message\StreamInterface.

Definition at line 229 of file Stream.php.

References Slim\Http\Stream\$size, $stats, Slim\Http\Stream\isAttached(), Slim\Http\Stream\isPipe(), and size.

    {
        if (!$this->size && $this->isAttached() === true) {
            $stats = fstat($this->stream);
            $this->size = isset($stats['size']) && !$this->isPipe() ? $stats['size'] : null;
        }

        return $this->size;
    }

Here is the call graph for this function:

isAttached()

Slim\Http\Stream::isAttached ( )

protected

Is a resource attached to this stream?

Note: This method is not part of the PSR-7 standard.

Returns

bool

Definition at line 132 of file Stream.php.

Referenced by Slim\Http\Stream\__toString(), Slim\Http\Stream\attach(), Slim\Http\Stream\close(), Slim\Http\Stream\eof(), Slim\Http\Stream\getSize(), Slim\Http\Stream\isPipe(), Slim\Http\Stream\isReadable(), Slim\Http\Stream\isSeekable(), Slim\Http\Stream\isWritable(), and Slim\Http\Stream\tell().

    {
        return is_resource($this->stream);
    }

Here is the caller graph for this function:

isPipe()

Slim\Http\Stream::isPipe

(

)

Returns whether or not the stream is a pipe.

Returns

bool

Definition at line 438 of file Stream.php.

References Slim\Http\Stream\$isPipe, and Slim\Http\Stream\isAttached().

Referenced by Slim\Http\Stream\close(), Slim\Http\Stream\detach(), Slim\Http\Stream\getSize(), Slim\Http\Stream\isReadable(), Slim\Http\Stream\isSeekable(), and Slim\Http\Stream\tell().

    {
        if ($this->isPipe === null) {
            $this->isPipe = false;
            if ($this->isAttached()) {
                $mode = fstat($this->stream)['mode'];
                $this->isPipe = ($mode & self::FSTAT_MODE_S_IFIFO) !== 0;
            }
        }

        return $this->isPipe;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isReadable()

Slim\Http\Stream::isReadable

(

)

Returns whether or not the stream is readable.

Returns

bool

Implements Psr\Http\Message\StreamInterface.

Definition at line 270 of file Stream.php.

References Slim\Http\Stream\$meta, Slim\Http\Stream\$readable, Slim\Http\Stream\getMetadata(), Slim\Http\Stream\isAttached(), and Slim\Http\Stream\isPipe().

Referenced by Slim\Http\Stream\getContents(), and Slim\Http\Stream\read().

    {
        if ($this->readable === null) {
            if ($this->isPipe()) {
                $this->readable = true;
            } else {
                $this->readable = false;
                if ($this->isAttached()) {
                    $meta = $this->getMetadata();
                    foreach (self::$modes['readable'] as $mode) {
                        if (strpos($meta['mode'], $mode) === 0) {
                            $this->readable = true;
                            break;
                        }
                    }
                }
            }
        }

        return $this->readable;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isSeekable()

Slim\Http\Stream::isSeekable

(

)

Returns whether or not the stream is seekable.

Returns

bool

Implements Psr\Http\Message\StreamInterface.

Definition at line 320 of file Stream.php.

References Slim\Http\Stream\$meta, Slim\Http\Stream\$seekable, Slim\Http\Stream\getMetadata(), Slim\Http\Stream\isAttached(), and Slim\Http\Stream\isPipe().

Referenced by Slim\Http\Stream\rewind(), and Slim\Http\Stream\seek().

    {
        if ($this->seekable === null) {
            $this->seekable = false;
            if ($this->isAttached()) {
                $meta = $this->getMetadata();
                $this->seekable = !$this->isPipe() && $meta['seekable'];
            }
        }

        return $this->seekable;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isWritable()

Slim\Http\Stream::isWritable

(

)

Returns whether or not the stream is writable.

Returns

bool

Implements Psr\Http\Message\StreamInterface.

Definition at line 297 of file Stream.php.

References Slim\Http\Stream\$meta, Slim\Http\Stream\$writable, Slim\Http\Stream\getMetadata(), and Slim\Http\Stream\isAttached().

Referenced by Slim\Http\Stream\write().

    {
        if ($this->writable === null) {
            $this->writable = false;
            if ($this->isAttached()) {
                $meta = $this->getMetadata();
                foreach (self::$modes['writable'] as $mode) {
                    if (strpos($meta['mode'], $mode) === 0) {
                        $this->writable = true;
                        break;
                    }
                }
            }
        }

        return $this->writable;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

read()

Slim\Http\Stream::read

(

$length

)

Read data from the stream.

Parameters

int

$length

Read up to $length bytes from the object and return them. Fewer than $length bytes may be returned if underlying stream call returns fewer bytes.

Returns

string Returns the data read from the stream, or an empty string if no bytes are available.

Exceptions

RuntimeException

if an error occurs.

Implements Psr\Http\Message\StreamInterface.

Definition at line 386 of file Stream.php.

References $data, and Slim\Http\Stream\isReadable().

    {
        if (!$this->isReadable() || ($data = fread($this->stream, $length)) === false) {
            throw new RuntimeException('Could not read from stream');
        }

        return $data;
    }

Here is the call graph for this function:

rewind()

Slim\Http\Stream::rewind

(

)

Seek to the beginning of the stream.

If the stream is not seekable, this method will raise an exception; otherwise, it will perform a seek(0).

See also

seek()

RuntimeException on failure.

Implements Psr\Http\Message\StreamInterface.

Definition at line 367 of file Stream.php.

References Slim\Http\Stream\isSeekable().

Referenced by Slim\Http\RequestBody\__construct(), and Slim\Http\Stream\__toString().

    {
        if (!$this->isSeekable() || rewind($this->stream) === false) {
            throw new RuntimeException('Could not rewind stream');
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

seek()

Slim\Http\Stream::seek	(		$offset,
			$whence = SEEK_SET
	)

Seek to a position in the stream.

int $offset Stream offset int $whence Specifies how the cursor position will be calculated based on the seek offset. Valid values are identical to the built-in PHP $whence values for fseek(). SEEK_SET: Set position equal to offset bytes SEEK_CUR: Set position to current location plus offset SEEK_END: Set position to end-of-stream plus offset. RuntimeException on failure.

Implements Psr\Http\Message\StreamInterface.

Definition at line 347 of file Stream.php.

References Slim\Http\Stream\isSeekable().

    {
        // Note that fseek returns 0 on success!
        if (!$this->isSeekable() || fseek($this->stream, $offset, $whence) === -1) {
            throw new RuntimeException('Could not seek in stream');
        }
    }

Here is the call graph for this function:

tell()

Slim\Http\Stream::tell

(

)

Returns the current position of the file read/write pointer.

Returns

int Position of the file pointer

Exceptions

RuntimeException

on error.

Implements Psr\Http\Message\StreamInterface.

Definition at line 246 of file Stream.php.

References Slim\Http\Stream\isAttached(), and Slim\Http\Stream\isPipe().

    {
        if (!$this->isAttached() || ($position = ftell($this->stream)) === false || $this->isPipe()) {
            throw new RuntimeException('Could not get the position of the pointer in stream');
        }

        return $position;
    }

Here is the call graph for this function:

write()

Slim\Http\Stream::write

(

$string

)

Write data to the stream.

Parameters

string

$string

The string that is to be written.

Returns

int Returns the number of bytes written to the stream.

Exceptions

RuntimeException

on failure.

Implements Psr\Http\Message\StreamInterface.

Definition at line 404 of file Stream.php.

References Slim\Http\Stream\isWritable(), and size.

    {
        if (!$this->isWritable() || ($written = fwrite($this->stream, $string)) === false) {
            throw new RuntimeException('Could not write to stream');
        }

        // reset size so that it will be recalculated on next call to getSize()
        $this->size = null;

        return $written;
    }

Here is the call graph for this function:

Field Documentation

$isPipe

Slim\Http\Stream::$isPipe

protected

Definition at line 87 of file Stream.php.

Referenced by Slim\Http\Stream\isPipe().

$meta

Slim\Http\Stream::$meta

protected

Definition at line 52 of file Stream.php.

Referenced by Slim\Http\Stream\getMetadata(), Slim\Http\Stream\isReadable(), Slim\Http\Stream\isSeekable(), and Slim\Http\Stream\isWritable().

$modes

Slim\Http\Stream::$modes

staticprotected

Initial value:

= [
        'readable' => ['r', 'r+', 'w+', 'a+', 'x+', 'c+']

Definition at line 35 of file Stream.php.

$readable

Slim\Http\Stream::$readable

protected

Definition at line 59 of file Stream.php.

Referenced by Slim\Http\Stream\isReadable().

$seekable

Slim\Http\Stream::$seekable

protected

Definition at line 73 of file Stream.php.

Referenced by Slim\Http\Stream\isSeekable().

$size

Slim\Http\Stream::$size

protected

Definition at line 80 of file Stream.php.

Referenced by Slim\Http\Stream\getSize().

$stream

Slim\Http\Stream::$stream

protected

Definition at line 45 of file Stream.php.

Referenced by Slim\Http\RequestBody\__construct(), Slim\Http\Stream\__construct(), and Slim\Http\Stream\detach().

$writable

Slim\Http\Stream::$writable

protected

Definition at line 66 of file Stream.php.

Referenced by Slim\Http\Stream\isWritable().

FSTAT_MODE_S_IFIFO

const Slim\Http\Stream::FSTAT_MODE_S_IFIFO = 0010000

Bit mask to determine if the stream is a pipe.

This is octal as per header stat.h

Definition at line 27 of file Stream.php.

---

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

• libs/composer/vendor/slim/slim/Slim/Http/Stream.php