Compose stream implementations based on a hash of functions. More...

Inheritance diagram for GuzzleHttp\Psr7\FnStream:

Collaboration diagram for GuzzleHttp\Psr7\FnStream:

Public Member Functions
	__construct (array $methods)

	__get ($name)
	Lazily determine which methods are not implemented. More...

	__destruct ()
	The close method is called on the underlying stream only if possible. 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...

	detach ()
	Separates any underlying resources from the stream. 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...

	isSeekable ()
	Returns whether or not the stream is seekable. More...

	rewind ()
	Seek to the beginning of the stream. More...

	seek ($offset, $whence=SEEK_SET)
	Seek to a position in the stream. More...

	isWritable ()
	Returns whether or not the stream is writable. More...

	write ($string)
	Write data to the stream. More...

	isReadable ()
	Returns whether or not the stream is readable. More...

	read ($length)
	Read data from the stream. More...

	getContents ()
	Returns the remaining contents in a string. More...

	getMetadata ($key=null)
	Get stream metadata as an associative array or retrieve a specific key. More...

Static Public Member Functions
static	decorate (StreamInterface $stream, array $methods)
	Adds custom functionality to an underlying stream by intercepting specific method calls. More...

Private Attributes
	$methods

Static Private Attributes
static	$slots

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 25 of file FnStream.php.

References GuzzleHttp\Psr7\FnStream\$methods, and $name.

     {
         $this->methods = $methods;
 
         // Create the functions on the class
         foreach ($methods as $name => $fn) {
             $this->{'_fn_' . $name} = $fn;
         }
     }

◆ __destruct()

GuzzleHttp\Psr7\FnStream::__destruct ( )

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

Definition at line 48 of file FnStream.php.

     {
         if (isset($this->_fn_close)) {
             call_user_func($this->_fn_close);
         }
     }

Member Function Documentation

◆ __get()

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

Lazily determine which methods are not implemented.

Exceptions

Definition at line 39 of file FnStream.php.

References $name.

     {
         throw new \BadMethodCallException(str_replace('_fn_', '', $name)
             . '() is not implemented in the FnStream');
     }

◆ __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 75 of file FnStream.php.

     {
         return call_user_func($this->_fn___toString);
     }

◆ close()

GuzzleHttp\Psr7\FnStream::close ( )

Closes the stream and any underlying resources.

Returns: void

Implements Psr\Http\Message\StreamInterface.

Definition at line 80 of file FnStream.php.

     {
         return call_user_func($this->_fn_close);
     }

◆ 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 64 of file FnStream.php.

References GuzzleHttp\Psr7\FnStream\$methods, and GuzzleHttp\Psr7\$stream.

     {
         // If any of the required methods were not provided, then simply
         // proxy to the decorated stream.
         foreach (array_diff(self::$slots, array_keys($methods)) as $diff) {
             $methods[$diff] = [$stream, $diff];
         }
 
         return new self($methods);
     }

◆ 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 85 of file FnStream.php.

     {
         return call_user_func($this->_fn_detach);
     }

◆ 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 100 of file FnStream.php.

     {
         return call_user_func($this->_fn_eof);
     }

◆ getContents()

GuzzleHttp\Psr7\FnStream::getContents ( )

Returns the remaining contents in a string.

Returns: string

Exceptions

Implements Psr\Http\Message\StreamInterface.

Definition at line 140 of file FnStream.php.

     {
         return call_user_func($this->_fn_getContents);
     }

◆ 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 145 of file FnStream.php.

References $key.

     {
         return call_user_func($this->_fn_getMetadata, $key);
     }

◆ 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 90 of file FnStream.php.

     {
         return call_user_func($this->_fn_getSize);
     }

◆ isReadable()

GuzzleHttp\Psr7\FnStream::isReadable ( )

Returns whether or not the stream is readable.

Returns: bool

Implements Psr\Http\Message\StreamInterface.

Definition at line 130 of file FnStream.php.

     {
         return call_user_func($this->_fn_isReadable);
     }

◆ isSeekable()

GuzzleHttp\Psr7\FnStream::isSeekable ( )

Returns whether or not the stream is seekable.

Returns: bool

Implements Psr\Http\Message\StreamInterface.

Definition at line 105 of file FnStream.php.

     {
         return call_user_func($this->_fn_isSeekable);
     }

◆ isWritable()

GuzzleHttp\Psr7\FnStream::isWritable ( )

Returns whether or not the stream is writable.

Returns: bool

Implements Psr\Http\Message\StreamInterface.

Definition at line 120 of file FnStream.php.

     {
         return call_user_func($this->_fn_isWritable);
     }

◆ 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 135 of file FnStream.php.

     {
         return call_user_func($this->_fn_read, $length);
     }

◆ 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 110 of file FnStream.php.

     {
         call_user_func($this->_fn_rewind);
     }

◆ 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 115 of file FnStream.php.

     {
         call_user_func($this->_fn_seek, $offset, $whence);
     }

◆ 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 95 of file FnStream.php.

     {
         return call_user_func($this->_fn_tell);
     }

◆ 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 125 of file FnStream.php.

     {
         return call_user_func($this->_fn_write, $string);
     }

Field Documentation

◆ $methods

GuzzleHttp\Psr7\FnStream::$methods

private

Definition at line 15 of file FnStream.php.

Referenced by GuzzleHttp\Psr7\FnStream\__construct(), and GuzzleHttp\Psr7\FnStream\decorate().

◆ $slots

GuzzleHttp\Psr7\FnStream::$slots

staticprivate

Initial value:

= ['__toString', 'close', 'detach', 'rewind',
        'getSize', 'tell', 'eof', 'isSeekable', 'seek', 'isWritable', 'write',
        'isReadable', 'read', 'getContents', 'getMetadata']

Definition at line 18 of file FnStream.php.

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

libs/composer/vendor/guzzlehttp/psr7/src/FnStream.php

Public Member Functions

Static Public Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

◆ __destruct()

Member Function Documentation

◆ __get()

◆ __toString()

◆ close()

◆ decorate()

◆ detach()

◆ eof()

◆ getContents()

◆ getMetadata()

◆ getSize()

◆ isReadable()

◆ isSeekable()

◆ isWritable()

◆ read()

◆ rewind()

◆ seek()

◆ tell()

◆ write()

Field Documentation

◆ $methods

◆ $slots