GuzzleHttp\Psr7\Stream Class Reference

Inheritance diagram for GuzzleHttp\Psr7\Stream:

Collaboration diagram for GuzzleHttp\Psr7\Stream:

Public Member Functions
static	__construct ($stream, $options=[])
	This constructor accepts an associative array of options. More...
	__get ($name)
	__destruct ()
	Closes the stream when the destructed. More...
	__toString ()
	Reads all data from the stream into a string, from the beginning to end. More...
	getContents ()
	Returns the remaining contents in a string. More...
	close ()
	Closes the stream and any underlying resources. More...
	detach ()
	Separates any underlying resources from the stream. More...
	getSize ()
	Get the size of the stream if known. 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...
	eof ()
	Returns true if the stream is at the end of the stream. More...
	tell ()
	Returns the current position of the file read/write pointer. More...
	rewind ()
	Seek to the beginning of the stream. More...
	seek ($offset, $whence=SEEK_SET)
	Seek to a position in the stream. More...
	read ($length)
	Read data from the stream. More...
	write ($string)
	Write data to the stream. More...
	getMetadata ($key=null)
	Get stream metadata as an associative array or retrieve a specific key. More...

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

Static Private Attributes
static	$readWriteHash

Detailed Description

Definition at line 11 of file Stream.php.

Constructor & Destructor Documentation

__construct()

static GuzzleHttp\Psr7\Stream::__construct	(		$stream,
			$options = []
	)

This constructor accepts an associative array of options.

• size: (int) If a read stream would otherwise have an indeterminate size, but the size is known due to foreknowledge, then you can provide that size, in bytes.
• metadata: (array) Any additional metadata to return when the metadata of the stream is accessed.

Parameters

resource	$stream	Stream resource to wrap.
array	$options	Associative array of options.

Exceptions

Definition at line 51 of file Stream.php.

References $options, GuzzleHttp\Psr7\Stream\$stream, GuzzleHttp\Psr7\Stream\getMetadata(), and size.

    {
        if (!is_resource($stream)) {
            throw new \InvalidArgumentException('Stream must be a resource');
        }

        if (isset($options['size'])) {
            $this->size = $options['size'];
        }

        $this->customMetadata = isset($options['metadata'])
            ? $options['metadata']
            : [];

        $this->stream = $stream;
        $meta = stream_get_meta_data($this->stream);
        $this->seekable = $meta['seekable'];
        $this->readable = isset(self::$readWriteHash['read'][$meta['mode']]);
        $this->writable = isset(self::$readWriteHash['write'][$meta['mode']]);
        $this->uri = $this->getMetadata('uri');
    }

Here is the call graph for this function:

__destruct()

GuzzleHttp\Psr7\Stream::__destruct

(

)

Closes the stream when the destructed.

Definition at line 85 of file Stream.php.

References GuzzleHttp\Psr7\Stream\close().

    {
        $this->close();
    }

Here is the call graph for this function:

Member Function Documentation

__get()

GuzzleHttp\Psr7\Stream::__get

(

$name

)

Definition at line 73 of file Stream.php.

References $name.

    {
        if ($name == 'stream') {
            throw new \RuntimeException('The stream is detached');
        }

        throw new \BadMethodCallException('No value for ' . $name);
    }

__toString()

GuzzleHttp\Psr7\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 90 of file Stream.php.

References GuzzleHttp\Psr7\Stream\seek().

    {
        try {
            $this->seek(0);
            return (string) stream_get_contents($this->stream);
        } catch (\Exception $e) {
            return '';
        }
    }

Here is the call graph for this function:

close()

GuzzleHttp\Psr7\Stream::close

(

)

Closes the stream and any underlying resources.

Returns

void

Implements Psr\Http\Message\StreamInterface.

Definition at line 111 of file Stream.php.

References GuzzleHttp\Psr7\Stream\detach().

Referenced by GuzzleHttp\Psr7\Stream\__destruct().

    {
        if (isset($this->stream)) {
            if (is_resource($this->stream)) {
                fclose($this->stream);
            }
            $this->detach();
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

detach()

GuzzleHttp\Psr7\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 121 of file Stream.php.

References $result, GuzzleHttp\Psr7\Stream\$stream, and size.

Referenced by GuzzleHttp\Psr7\Stream\close().

    {
        if (!isset($this->stream)) {
            return null;
        }

        $result = $this->stream;
        unset($this->stream);
        $this->size = $this->uri = null;
        $this->readable = $this->writable = $this->seekable = false;

        return $result;
    }

Here is the caller graph for this function:

eof()

GuzzleHttp\Psr7\Stream::eof

(

)

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

Returns

bool

Implements Psr\Http\Message\StreamInterface.

Definition at line 174 of file Stream.php.

    {
        return !$this->stream || feof($this->stream);
    }

getContents()

GuzzleHttp\Psr7\Stream::getContents

(

)

Returns the remaining contents in a string.

Returns

string

Exceptions

Implements Psr\Http\Message\StreamInterface.

Definition at line 100 of file Stream.php.

References $contents.

    {
        $contents = stream_get_contents($this->stream);

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

        return $contents;
    }

getMetadata()

GuzzleHttp\Psr7\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 243 of file Stream.php.

References $key.

Referenced by GuzzleHttp\Psr7\Stream\__construct().

    {
        if (!isset($this->stream)) {
            return $key ? null : [];
        } elseif (!$key) {
            return $this->customMetadata + stream_get_meta_data($this->stream);
        } elseif (isset($this->customMetadata[$key])) {
            return $this->customMetadata[$key];
        }

        $meta = stream_get_meta_data($this->stream);

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

Here is the caller graph for this function:

getSize()

GuzzleHttp\Psr7\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 135 of file Stream.php.

References GuzzleHttp\Psr7\Stream\$size, $stats, and size.

    {
        if ($this->size !== null) {
            return $this->size;
        }

        if (!isset($this->stream)) {
            return null;
        }

        // Clear the stat cache if the stream has a URI
        if ($this->uri) {
            clearstatcache(true, $this->uri);
        }

        $stats = fstat($this->stream);
        if (isset($stats['size'])) {
            $this->size = $stats['size'];
            return $this->size;
        }

        return null;
    }

isReadable()

GuzzleHttp\Psr7\Stream::isReadable

(

)

Returns whether or not the stream is readable.

Returns

bool

Implements Psr\Http\Message\StreamInterface.

Definition at line 159 of file Stream.php.

References GuzzleHttp\Psr7\Stream\$readable.

    {
        return $this->readable;
    }

isSeekable()

GuzzleHttp\Psr7\Stream::isSeekable

(

)

Returns whether or not the stream is seekable.

Returns

bool

Implements Psr\Http\Message\StreamInterface.

Definition at line 169 of file Stream.php.

References GuzzleHttp\Psr7\Stream\$seekable.

    {
        return $this->seekable;
    }

isWritable()

GuzzleHttp\Psr7\Stream::isWritable

(

)

Returns whether or not the stream is writable.

Returns

bool

Implements Psr\Http\Message\StreamInterface.

Definition at line 164 of file Stream.php.

References GuzzleHttp\Psr7\Stream\$writable.

    {
        return $this->writable;
    }

read()

GuzzleHttp\Psr7\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

Implements Psr\Http\Message\StreamInterface.

Definition at line 205 of file Stream.php.

    {
        if (!$this->readable) {
            throw new \RuntimeException('Cannot read from non-readable stream');
        }
        if ($length < 0) {
            throw new \RuntimeException('Length parameter cannot be negative');
        }

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

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

        return $string;
    }

rewind()

GuzzleHttp\Psr7\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() on failure.

Implements Psr\Http\Message\StreamInterface.

Definition at line 190 of file Stream.php.

References GuzzleHttp\Psr7\Stream\seek().

    {
        $this->seek(0);
    }

Here is the call graph for this function:

seek()

GuzzleHttp\Psr7\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. on failure.

Implements Psr\Http\Message\StreamInterface.

Definition at line 195 of file Stream.php.

Referenced by GuzzleHttp\Psr7\Stream\__toString(), and GuzzleHttp\Psr7\Stream\rewind().

    {
        if (!$this->seekable) {
            throw new \RuntimeException('Stream is not seekable');
        } elseif (fseek($this->stream, $offset, $whence) === -1) {
            throw new \RuntimeException('Unable to seek to stream position '
                . $offset . ' with whence ' . var_export($whence, true));
        }
    }

Here is the caller graph for this function:

tell()

GuzzleHttp\Psr7\Stream::tell

(

)

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

Returns

int Position of the file pointer

Exceptions

Implements Psr\Http\Message\StreamInterface.

Definition at line 179 of file Stream.php.

References $result.

    {
        $result = ftell($this->stream);

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

        return $result;
    }

write()

GuzzleHttp\Psr7\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

Implements Psr\Http\Message\StreamInterface.

Definition at line 226 of file Stream.php.

References $result, and size.

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

        // We can't know the size after writing anything
        $this->size = null;
        $result = fwrite($this->stream, $string);

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

        return $result;
    }

Field Documentation

$customMetadata

GuzzleHttp\Psr7\Stream::$customMetadata

private

Definition at line 19 of file Stream.php.

$readable

GuzzleHttp\Psr7\Stream::$readable

private

Definition at line 16 of file Stream.php.

Referenced by GuzzleHttp\Psr7\Stream\isReadable().

$readWriteHash

GuzzleHttp\Psr7\Stream::$readWriteHash

staticprivate

Initial value:

= [
        'read' => [
            'r' => true

Definition at line 22 of file Stream.php.

$seekable

GuzzleHttp\Psr7\Stream::$seekable

private

Definition at line 15 of file Stream.php.

Referenced by GuzzleHttp\Psr7\Stream\isSeekable().

$size

GuzzleHttp\Psr7\Stream::$size

private

Definition at line 14 of file Stream.php.

Referenced by GuzzleHttp\Psr7\Stream\getSize().

$stream

GuzzleHttp\Psr7\Stream::$stream

private

Definition at line 13 of file Stream.php.

Referenced by GuzzleHttp\Psr7\Stream\__construct(), and GuzzleHttp\Psr7\Stream\detach().

$uri

GuzzleHttp\Psr7\Stream::$uri

private

Definition at line 18 of file Stream.php.

$writable

GuzzleHttp\Psr7\Stream::$writable

private

Definition at line 17 of file Stream.php.

Referenced by GuzzleHttp\Psr7\Stream\isWritable().

---

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

• libs/composer/vendor/guzzlehttp/psr7/src/Stream.php