|
| | __construct (int $hwm=16384) |
| |
| | __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) |
| |
| | getMetadata (?string $key=null) |
| | Get stream metadata as an associative array or retrieve a specific key.
|
| |
| | 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) |
| | Reads data from the buffer.
|
| |
| | read (int $length) |
| | Read data from the stream.
|
| |
| | rewind () |
| | Seek to the beginning of the stream.
|
| |
|
| seek ($offset, $whence=SEEK_SET) |
| |
| | seek (int $offset, int $whence=SEEK_SET) |
| | Seek to a position in the stream.
|
| |
| | tell () |
| | Returns the current position of the file read/write pointer.
|
| |
|
| write ($string) |
| | Writes data to the buffer.
|
| |
| | write (string $string) |
| | Write data to the stream.
|
| |
◆ __construct()
| GuzzleHttp\Psr7\BufferStream::__construct |
( |
int | $hwm = 16384 | ) |
|
- Parameters
-
| int | $hwm | High water mark, representing the preferred maximum buffer size. If the size of the buffer exceeds the high water mark, then calls to write will continue to succeed but will return 0 to inform writers to slow down until the buffer has been drained by reading from it. |
◆ __toString()
| GuzzleHttp\Psr7\BufferStream::__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\BufferStream::close |
( |
| ) |
|
◆ detach()
| GuzzleHttp\Psr7\BufferStream::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\BufferStream::eof |
( |
| ) |
|
◆ getContents()
| GuzzleHttp\Psr7\BufferStream::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() [1/2]
| GuzzleHttp\Psr7\BufferStream::getMetadata |
( |
| $key = null | ) |
|
◆ getMetadata() [2/2]
| Psr\Http\Message\StreamInterface::getMetadata |
( |
?string | $key = null | ) |
|
|
inherited |
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 | null | $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()
| GuzzleHttp\Psr7\BufferStream::getSize |
( |
| ) |
|
◆ isReadable()
| GuzzleHttp\Psr7\BufferStream::isReadable |
( |
| ) |
|
◆ isSeekable()
| GuzzleHttp\Psr7\BufferStream::isSeekable |
( |
| ) |
|
◆ isWritable()
| GuzzleHttp\Psr7\BufferStream::isWritable |
( |
| ) |
|
◆ read()
| Psr\Http\Message\StreamInterface::read |
( |
int | $length | ) |
|
|
inherited |
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. |
◆ rewind()
| GuzzleHttp\Psr7\BufferStream::rewind |
( |
| ) |
|
◆ seek()
| Psr\Http\Message\StreamInterface::seek |
( |
int | $offset, |
|
|
int | $whence = SEEK_SET ) |
|
inherited |
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. |
◆ tell()
| GuzzleHttp\Psr7\BufferStream::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()
| Psr\Http\Message\StreamInterface::write |
( |
string | $string | ) |
|
|
inherited |
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. |
The documentation for this class was generated from the following file:
- lib/guzzlehttp/psr7/src/BufferStream.php
1.13.2