OpenSpout\Reader\ReaderInterface Interface Reference

Inheritance diagram for OpenSpout\Reader\ReaderInterface:

Public Member Functions
	close ()
	Closes the reader, preventing any additional reading.
	getSheetIterator ()
	Returns an iterator to iterate over sheets.
	open (string $filePath)
	Prepares the reader to read the given file.

Member Function Documentation

close()

OpenSpout\Reader\ReaderInterface::close

(

)

Closes the reader, preventing any additional reading.

Implemented in OpenSpout\Reader\AbstractReader.

getSheetIterator()

OpenSpout\Reader\ReaderInterface::getSheetIterator

(

)

Returns an iterator to iterate over sheets.

Return values

T

Exceptions

Exception::ReaderNotOpenedException

If called before opening the reader

Implemented in OpenSpout\Reader\CSV\Reader, OpenSpout\Reader\ODS\Reader, and OpenSpout\Reader\XLSX\Reader.

open()

OpenSpout\Reader\ReaderInterface::open

(

string

$filePath

)

Prepares the reader to read the given file.

It also makes sure that the file exists and is readable.

Parameters

string

$filePath

Path of the file to be read

Exceptions

IOException

Implemented in OpenSpout\Reader\AbstractReader.

---

The documentation for this interface was generated from the following file:

• lib/openspout/src/Reader/ReaderInterface.php