OO interface to PHP streams
Expanded class hierarchy of StreamInterface
All classes that implement StreamInterface
interface StreamInterface {
/**
* Convert the stream to a string if the stream is readable and the stream is seekable.
*
* @return string
*/
public function __toString();
/**
* Get stream metadata
*
* @param string $key Specific metadata to retrieve
*
* @return array|mixed|null
*/
public function getMetaData($key = null);
/**
* Get the stream resource
*
* @return resource
*/
public function getStream();
/**
* Set the stream that is wrapped by the object
*
* @param resource $stream Stream resource to wrap
* @param int $size Size of the stream in bytes. Only pass if the size cannot be obtained from the stream.
*
* @return self
*/
public function setStream($stream, $size = null);
/**
* Get the stream wrapper type
*
* @return string
*/
public function getWrapper();
/**
* Wrapper specific data attached to this stream.
*
* @return string
*/
public function getWrapperData();
/**
* Get a label describing the underlying implementation of the stream
*
* @return string
*/
public function getStreamType();
/**
* Get the URI/filename associated with this stream
*
* @return string
*/
public function getUri();
/**
* Get the size of the stream if able
*
* @return int|bool
*/
public function getSize();
/**
* Check if the stream is readable
*
* @return bool
*/
public function isReadable();
/**
* Check if the stream is writable
*
* @return bool
*/
public function isWritable();
/**
* Check if the stream has been consumed
*
* @return bool
*/
public function isConsumed();
/**
* Check if the stream is a local stream vs a remote stream
*
* @return bool
*/
public function isLocal();
/**
* Check if the string is repeatable
*
* @return bool
*/
public function isSeekable();
/**
* Specify the size of the stream in bytes
*
* @param int $size Size of the stream contents in bytes
*
* @return Stream
*/
public function setSize($size);
/**
* Seek to a position in the stream
*
* @param int $offset Stream offset
* @param int $whence Where the offset is applied
*
* @return bool Returns TRUE on success or FALSE on failure
* @link http://www.php.net/manual/en/function.fseek.php
*/
public function seek($offset, $whence = SEEK_SET);
/**
* Read data from the stream
*
* @param int $length Up to length number of bytes read.
*
* @return string|bool Returns the data read from the stream or FALSE on failure or EOF
*/
public function read($length);
/**
* Write data to the stream
*
* @param string $string The string that is to be written.
*
* @return int|bool Returns the number of bytes written to the stream on success or FALSE on failure.
*/
public function write($string);
/**
* Returns the current position of the file read/write pointer
*
* @return int|bool Returns the position of the file pointer or false on error
*/
public function ftell();
/**
* Rewind to the beginning of the stream
*
* @return bool Returns true on success or false on failure
*/
public function rewind();
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
StreamInterface:: |
public | function | Returns the current position of the file read/write pointer | 2 |
StreamInterface:: |
public | function | Get stream metadata | 2 |
StreamInterface:: |
public | function | Get the size of the stream if able | 2 |
StreamInterface:: |
public | function | Get the stream resource | 2 |
StreamInterface:: |
public | function | Get a label describing the underlying implementation of the stream | 2 |
StreamInterface:: |
public | function | Get the URI/filename associated with this stream | 2 |
StreamInterface:: |
public | function | Get the stream wrapper type | 2 |
StreamInterface:: |
public | function | Wrapper specific data attached to this stream. | 2 |
StreamInterface:: |
public | function | Check if the stream has been consumed | 2 |
StreamInterface:: |
public | function | Check if the stream is a local stream vs a remote stream | 2 |
StreamInterface:: |
public | function | Check if the stream is readable | 2 |
StreamInterface:: |
public | function | Check if the string is repeatable | 2 |
StreamInterface:: |
public | function | Check if the stream is writable | 2 |
StreamInterface:: |
public | function | Read data from the stream | 2 |
StreamInterface:: |
public | function | Rewind to the beginning of the stream | 2 |
StreamInterface:: |
public | function | Seek to a position in the stream | 2 |
StreamInterface:: |
public | function | Specify the size of the stream in bytes | 2 |
StreamInterface:: |
public | function | Set the stream that is wrapped by the object | 2 |
StreamInterface:: |
public | function | Write data to the stream | 2 |
StreamInterface:: |
public | function | Convert the stream to a string if the stream is readable and the stream is seekable. | 2 |