| 1 |
<?php |
| 2 |
/* |
| 3 |
* This file is part of the ManageWP Worker plugin. |
| 4 |
* |
| 5 |
* (c) ManageWP LLC <contact@managewp.com> |
| 6 |
* |
| 7 |
* For the full copyright and license information, please view the LICENSE |
| 8 |
* file that was distributed with this source code. |
| 9 |
*/ |
| 10 |
|
| 11 |
interface MWP_Stream_Interface |
| 12 |
{ |
| 13 |
/** |
| 14 |
* Closes the stream and any underlying resources. |
| 15 |
*/ |
| 16 |
public function close(); |
| 17 |
|
| 18 |
/** |
| 19 |
* Returns the current position of the file read/write pointer |
| 20 |
* |
| 21 |
* @return int|bool Returns the position of the file pointer or false on error |
| 22 |
*/ |
| 23 |
public function tell(); |
| 24 |
|
| 25 |
/** |
| 26 |
* @return bool |
| 27 |
*/ |
| 28 |
public function isSeekable(); |
| 29 |
|
| 30 |
/** |
| 31 |
* @param int $offset |
| 32 |
* @param int $whence |
| 33 |
* |
| 34 |
* @return bool |
| 35 |
*/ |
| 36 |
public function seek($offset, $whence = SEEK_SET); |
| 37 |
|
| 38 |
/** |
| 39 |
* Returns true if the stream is at the end of the stream. |
| 40 |
* |
| 41 |
* @return bool |
| 42 |
*/ |
| 43 |
public function eof(); |
| 44 |
|
| 45 |
/** |
| 46 |
* Read data from the stream |
| 47 |
* |
| 48 |
* @param int $length Read up to $length bytes from the object and return |
| 49 |
* them. Fewer than $length bytes may be returned if |
| 50 |
* underlying stream call returns fewer bytes. |
| 51 |
* |
| 52 |
* @return string Returns the data read from the stream. |
| 53 |
*/ |
| 54 |
public function read($length); |
| 55 |
} |
| 56 |
|