|
| __construct ($stream, array $options=[]) |
| This constructor accepts an associative array of options.
|
|
| __destruct () |
| Closes the stream when the destructed.
|
|
| __toString () |
| Reads all data from the stream into a string, from the beginning to end.
|
|
| close () |
| Closes the stream and any underlying resources.
|
|
| detach () |
| Separates any underlying resources from the stream.
|
|
| eof () |
| Returns true if the stream is at the end of the stream.
|
|
| getContents () |
| Returns the remaining contents in a string.
|
|
| 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.@externalurl http://php.net/manual/en/function.stream-get-meta-data.php - Parameters
-
string | $key | Specific metadata to retrieve. |
- Return values
-
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. |
}
|
|
| getSize () |
| Get the size of the stream if known.
|
|
| isReadable () |
| Returns whether or not the stream is readable.
|
|
| isSeekable () |
| Returns whether or not the stream is seekable.
|
|
| isWritable () |
| Returns whether or not the stream is writable.
|
|
| read ($length) |
| Read data from the stream.
|
|
| rewind () |
| Seek to the beginning of the stream.
|
|
| seek ($offset, $whence=SEEK_SET) |
| Seek to a position in the stream.
|
|
| tell () |
| Returns the current position of the file read/write pointer.
|
|
| write ($string) |
| Write data to the stream.
|
|
◆ __construct()
GuzzleHttp\Psr7\Stream::__construct |
( |
| $stream, |
|
|
array | $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{size? | int, metadata?: array} $options Associative array of options. |
- Exceptions
-
InvalidArgumentException | if the stream is not a stream resource |
◆ __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
- Return values
-
Implements Psr\Http\Message\StreamInterface.
◆ close()
GuzzleHttp\Psr7\Stream::close |
( |
| ) |
|
◆ 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.
- Return values
-
resource|null | Underlying PHP stream, if any |
Implements Psr\Http\Message\StreamInterface.
◆ eof()
GuzzleHttp\Psr7\Stream::eof |
( |
| ) |
|
◆ getContents()
GuzzleHttp\Psr7\Stream::getContents |
( |
| ) |
|
Returns the remaining contents in a string.
- Return values
-
- Exceptions
-
RuntimeException | if unable to read or an error occurs while reading. |
Implements Psr\Http\Message\StreamInterface.
◆ 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.@externalurl http://php.net/manual/en/function.stream-get-meta-data.php
- Parameters
-
string | $key | Specific metadata to retrieve. |
- Return values
-
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. |
}
- Return values
-
Implements Psr\Http\Message\StreamInterface.
◆ getSize()
GuzzleHttp\Psr7\Stream::getSize |
( |
| ) |
|
◆ isReadable()
GuzzleHttp\Psr7\Stream::isReadable |
( |
| ) |
|
◆ isSeekable()
GuzzleHttp\Psr7\Stream::isSeekable |
( |
| ) |
|
◆ isWritable()
GuzzleHttp\Psr7\Stream::isWritable |
( |
| ) |
|
◆ 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. |
- Return values
-
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.
◆ rewind()
GuzzleHttp\Psr7\Stream::rewind |
( |
| ) |
|
◆ seek()
GuzzleHttp\Psr7\Stream::seek |
( |
| $offset, |
|
|
| $whence = SEEK_SET ) |
Seek to a position in the stream.
@externalurl http://www.php.net/manual/en/function.fseek.php
- Parameters
-
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. |
- Exceptions
-
RuntimeException | on failure. |
Implements Psr\Http\Message\StreamInterface.
◆ tell()
GuzzleHttp\Psr7\Stream::tell |
( |
| ) |
|
Returns the current position of the file read/write pointer.
- Return values
-
int | Position of the file pointer |
- Exceptions
-
RuntimeException | on error. |
Implements Psr\Http\Message\StreamInterface.
◆ write()
GuzzleHttp\Psr7\Stream::write |
( |
| $string | ) |
|
Write data to the stream.
- Parameters
-
string | $string | The string that is to be written. |
- Return values
-
int | Returns the number of bytes written to the stream. |
- Exceptions
-
RuntimeException | on failure. |
Implements Psr\Http\Message\StreamInterface.
The documentation for this class was generated from the following file:
- lib/guzzlehttp/psr7/src/Stream.php