fluent-cart / vendor / openspout / openspout / src / Reader / ReaderInterface.php

ReaderInterface.php in FluentCart A New Era of eCommerce – Faster, Lighter, and Simpler 1.3.19, at vendor/openspout/openspout/src/Reader/ReaderInterface.php

32 lines 803 B

Raw Download Zip

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