Interface StreamInterface
Describes a data stream.
Typically, an instance will wrap a PHP stream; this interface provides a wrapper around the most common operations, including serialization of the entire stream to a string.
Direct known implementers
Aws\Crypto\AesStreamInterface,
Aws\Crypto\AesStreamInterfaceV2,
GuzzleHttp\Psr7\LazyOpenStream,
GuzzleHttp\Psr7\LimitStream,
GuzzleHttp\Psr7\MultipartStream,
GuzzleHttp\Psr7\NoSeekStream,
GuzzleHttp\Psr7\PumpStream,
GuzzleHttp\Psr7\Stream,
Aws\Handler\GuzzleV5\PsrStream,
Aws\HashingStream,
GuzzleHttp\Psr7\AppendStream,
GuzzleHttp\Psr7\BufferStream,
GuzzleHttp\Psr7\CachingStream,
GuzzleHttp\Psr7\DroppingStream,
GuzzleHttp\Psr7\FnStream,
GuzzleHttp\Psr7\InflateStream
Indirect known implementers
Aws\Crypto\AesDecryptingStream,
Aws\Crypto\AesEncryptingStream,
Aws\Crypto\AesGcmDecryptingStream,
Aws\Crypto\AesGcmEncryptingStream
Methods Summary
-
__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.
-
getSize ( )
Get the size of the stream if known.
-
tell ( )
Returns the current position of the file read/write pointer
-
eof ( )
Returns true if the stream is at the end of the stream.
-
isSeekable ( )
Returns whether or not the stream is seekable.
-
seek ( int $offset, int $whence = SEEK_SET )
Seek to a position in the stream.
-
rewind ( )
Seek to the beginning of the stream.
-
isWritable ( )
Returns whether or not the stream is writable.
-
write ( string $string )
Write data to the stream.
-
isReadable ( )
Returns whether or not the stream is readable.
-
read ( int $length )
Read data from the stream.
-
getContents ( )
Returns the remaining contents in a string
-
getMetadata ( string $key = null )
Get stream metadata as an associative array or retrieve a specific key.
Methods Details
string __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.
Returns
| string |
See
close ( )
Closes the stream and any underlying resources.
resource|null 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 |
integer|null getSize ( )
Get the size of the stream if known.
Returns
| integer|null Returns the size in bytes if known, or null if unknown. |
integer tell ( )
Returns the current position of the file read/write pointer
Returns
| integer Position of the file pointer |
Exceptions
| RuntimeException on error. |
boolean eof ( )
Returns true if the stream is at the end of the stream.
Returns
| boolean |
boolean isSeekable ( )
Returns whether or not the stream is seekable.
Returns
| boolean |
seek ( integer $offset, integer $whence = SEEK_SET )
Seek to a position in the stream.
Parameters
| integer | $offset | Stream offset |
| integer | $whence = SEEK_SET | 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 |
Exceptions
| RuntimeException on failure. |
Link
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).
Exceptions
| RuntimeException on failure. |
See
Link
boolean isWritable ( )
Returns whether or not the stream is writable.
Returns
| boolean |
integer write ( string $string )
Write data to the stream.
Parameters
| string | $string | The string that is to be written. |
Returns
| integer Returns the number of bytes written to the stream. |
Exceptions
| RuntimeException on failure. |
boolean isReadable ( )
Returns whether or not the stream is readable.
Returns
| boolean |
string read ( integer $length )
Read data from the stream.
Parameters
| integer | $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
| RuntimeException if an error occurs. |
string getContents ( )
Returns the remaining contents in a string
Returns
| string |
Exceptions
| RuntimeException if unable to read or an error occurs while reading. |
array|mixed|null getMetadata ( string $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.
Parameters
| string | $key = null | Specific metadata to retrieve. |
Returns
| 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. |