| 1 |
<?php |
| 2 |
|
| 3 |
namespace Box\Spout\Reader; |
| 4 |
|
| 5 |
/** |
| 6 |
* Interface ReaderInterface |
| 7 |
* |
| 8 |
* @package Box\Spout\Reader |
| 9 |
*/ |
| 10 |
interface ReaderInterface |
| 11 |
{ |
| 12 |
/** |
| 13 |
* Prepares the reader to read the given file. It also makes sure |
| 14 |
* that the file exists and is readable. |
| 15 |
* |
| 16 |
* @param string $filePath Path of the file to be read |
| 17 |
* @return void |
| 18 |
* @throws \Box\Spout\Common\Exception\IOException |
| 19 |
*/ |
| 20 |
public function open($filePath); |
| 21 |
|
| 22 |
/** |
| 23 |
* Returns an iterator to iterate over sheets. |
| 24 |
* |
| 25 |
* @return \Iterator To iterate over sheets |
| 26 |
* @throws \Box\Spout\Reader\Exception\ReaderNotOpenedException If called before opening the reader |
| 27 |
*/ |
| 28 |
public function getSheetIterator(); |
| 29 |
|
| 30 |
/** |
| 31 |
* Closes the reader, preventing any additional reading |
| 32 |
* |
| 33 |
* @return void |
| 34 |
*/ |
| 35 |
public function close(); |
| 36 |
} |
| 37 |
|