Inheritance diagram for GuzzleHttp\Psr7\FnStream:

Public Member Functions
	__construct (array $methods)

	__destruct ()

	__get ($name)

	__toString ()

	__wakeup ()

	close ()

	detach ()

	eof ()

	getContents ()

	getMetadata ($key=null)

	getSize ()

	isReadable ()

	isSeekable ()

	isWritable ()

	read ($length)

	rewind ()

	seek ($offset, $whence=SEEK_SET)

	tell ()

	write ($string)

Static Public Member Functions
static	decorate (StreamInterface $stream, array $methods)

Detailed Description

Compose stream implementations based on a hash of functions.

Allows for easy testing and extension of a provided stream without needing to create a concrete class for a simple extension point.

Definition at line 12 of file FnStream.php.

Constructor & Destructor Documentation

◆ __construct()

GuzzleHttp\Psr7\FnStream::__construct ( array $methods )

Parameters

array $methods Hash of method name to a callable.

Definition at line 28 of file FnStream.php.

◆ __destruct()

GuzzleHttp\Psr7\FnStream::__destruct ( )

The close method is called on the underlying stream only if possible.

Definition at line 51 of file FnStream.php.

Member Function Documentation

◆ __get()

GuzzleHttp\Psr7\FnStream::__get ( $name )

Lazily determine which methods are not implemented.

Exceptions

Definition at line 42 of file FnStream.php.

◆ __toString()

GuzzleHttp\Psr7\FnStream::__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 87 of file FnStream.php.

◆ __wakeup()

GuzzleHttp\Psr7\FnStream::__wakeup ( )

An unserialize would allow the __destruct to run when the unserialized value goes out of scope.

Exceptions

Definition at line 62 of file FnStream.php.

◆ close()

GuzzleHttp\Psr7\FnStream::close ( )

Closes the stream and any underlying resources.

Returns: void

Implements Psr\Http\Message\StreamInterface.

Definition at line 92 of file FnStream.php.

◆ decorate()

static GuzzleHttp\Psr7\FnStream::decorate	(	StreamInterface	$stream,
		array	$methods
	)

static

Adds custom functionality to an underlying stream by intercepting specific method calls.

Parameters

StreamInterface	$stream	Stream to decorate
array	$methods	Hash of method name to a closure

Returns: FnStream

Definition at line 76 of file FnStream.php.

◆ detach()

GuzzleHttp\Psr7\FnStream::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 97 of file FnStream.php.

◆ eof()

GuzzleHttp\Psr7\FnStream::eof ( )

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

Returns: bool

Implements Psr\Http\Message\StreamInterface.

Definition at line 112 of file FnStream.php.

◆ getContents()

GuzzleHttp\Psr7\FnStream::getContents ( )

Returns the remaining contents in a string

Returns: string

Exceptions

Implements Psr\Http\Message\StreamInterface.

Definition at line 152 of file FnStream.php.

◆ getMetadata()

GuzzleHttp\Psr7\FnStream::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 157 of file FnStream.php.

◆ getSize()

GuzzleHttp\Psr7\FnStream::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 102 of file FnStream.php.

◆ isReadable()

GuzzleHttp\Psr7\FnStream::isReadable ( )

Returns whether or not the stream is readable.

Returns: bool

Implements Psr\Http\Message\StreamInterface.

Definition at line 142 of file FnStream.php.

◆ isSeekable()

GuzzleHttp\Psr7\FnStream::isSeekable ( )

Returns whether or not the stream is seekable.

Returns: bool

Implements Psr\Http\Message\StreamInterface.

Definition at line 117 of file FnStream.php.

◆ isWritable()

GuzzleHttp\Psr7\FnStream::isWritable ( )

Returns whether or not the stream is writable.

Returns: bool

Implements Psr\Http\Message\StreamInterface.

Definition at line 132 of file FnStream.php.

◆ read()

GuzzleHttp\Psr7\FnStream::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 147 of file FnStream.php.

◆ rewind()

GuzzleHttp\Psr7\FnStream::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 122 of file FnStream.php.

◆ seek()

GuzzleHttp\Psr7\FnStream::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 127 of file FnStream.php.

◆ tell()

GuzzleHttp\Psr7\FnStream::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 107 of file FnStream.php.

◆ write()

GuzzleHttp\Psr7\FnStream::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 137 of file FnStream.php.

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

FnStream.php

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

◆ __destruct()

Member Function Documentation

◆ __get()

◆ __toString()

◆ __wakeup()

◆ close()

◆ decorate()

◆ detach()

◆ eof()

◆ getContents()

◆ getMetadata()

◆ getSize()

◆ isReadable()

◆ isSeekable()

◆ isWritable()

◆ read()

◆ rewind()

◆ seek()

◆ tell()

◆ write()