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.
-
Implements
Stringable
Methods |
public
abstract
__toString
() :
string
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 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
|
public
abstract
close
() Closes the stream and any underlying resources.
|
public
abstract
detach
() Separates any underlying resources from the stream. After the stream has been detached, the stream is in an unusable state.
|
public
abstract
eof
() Returns true if the stream is at the end of the stream.
|
public
abstract
getContents
() Returns the remaining contents in a string
|
public
abstract
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
|
public
abstract
getSize
() Get the size of the stream if known.
|
public
abstract
isReadable
() Returns whether or not the stream is readable.
|
public
abstract
isSeekable
() Returns whether or not the stream is seekable.
|
public
abstract
isWritable
() Returns whether or not the stream is writable.
|
public
abstract
read
(
$length
) Read data from the stream.
|
public
abstract
rewind
() Seek to the beginning of the stream. If the stream is not seekable, this method will raise an exception;
|
public
abstract
seek
(
$offset
,
$whence
=
0
) Seek to a position in the stream.
|
public
abstract
tell
() Returns the current position of the file read/write pointer
|
public
abstract
write
(
$string
) Write data to the stream.
|