OpenSpout\Reader\XLSX\Reader Class Reference

Inheritance diagram for OpenSpout\Reader\XLSX\Reader:

Public Member Functions
	__construct (?Options $options=null, ?CachingStrategyFactoryInterface $cachingStrategyFactory=null)
	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.

Protected Member Functions
	closeReader ()
	Closes the reader.
	doesSupportStreamWrapper ()
	Returns whether stream wrappers are supported.
	ensureStreamOpened ()
	openReader (string $filePath)
	Opens the file at the given file path to make it ready to be read.

Member Function Documentation

close()

OpenSpout\Reader\AbstractReader::close ( )

finalinherited

Closes the reader, preventing any additional reading.

Implements OpenSpout\Reader\ReaderInterface.

closeReader()

OpenSpout\Reader\XLSX\Reader::closeReader ( )

protected

Closes the reader.

To be used after reading the file.

Reimplemented from OpenSpout\Reader\AbstractReader.

doesSupportStreamWrapper()

OpenSpout\Reader\XLSX\Reader::doesSupportStreamWrapper ( )

protected

Returns whether stream wrappers are supported.

Reimplemented from OpenSpout\Reader\AbstractReader.

getSheetIterator()

OpenSpout\Reader\XLSX\Reader::getSheetIterator

(

)

Returns an iterator to iterate over sheets.

Return values

T

Exceptions

Exception::ReaderNotOpenedException

If called before opening the reader

Implements OpenSpout\Reader\ReaderInterface.

open()

OpenSpout\Reader\AbstractReader::open ( string $filePath )

inherited

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

If the file at the given path does not exist, is not readable or is corrupted

Implements OpenSpout\Reader\ReaderInterface.

openReader()

OpenSpout\Reader\XLSX\Reader::openReader ( string $filePath )

protected

Opens the file at the given file path to make it ready to be read.

It also parses the sharedStrings.xml file to get all the shared strings available in memory and fetches all the available sheets.

Parameters

string

$filePath

Path of the file to be read

Exceptions

IOException	If the file at the given path or its content cannot be read
NoSheetsFoundException	If there are no sheets in the file

Reimplemented from OpenSpout\Reader\AbstractReader.

---

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

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