Moodle PHP Documentation 4.1
Moodle 4.1.19+ (Build: 20250706) (3342f23b299)
Box\Spout\Reader\ReaderInterface Interface Reference
Inheritance diagram for Box\Spout\Reader\ReaderInterface:
Box\Spout\Reader\ReaderAbstract Box\Spout\Reader\CSV\Reader Box\Spout\Reader\ODS\Reader Box\Spout\Reader\XLSX\Reader

Public Member Functions

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

Member Function Documentation

◆ close()

Box\Spout\Reader\ReaderInterface::close ( )

Closes the reader, preventing any additional reading.

Return values
void

Implemented in Box\Spout\Reader\ReaderAbstract.

◆ getSheetIterator()

Box\Spout\Reader\ReaderInterface::getSheetIterator ( )

Returns an iterator to iterate over sheets.

Exceptions
Box\Spout\Reader\Exception\ReaderNotOpenedExceptionIf called before opening the reader
Return values
IteratorTo iterate over sheets

Implemented in Box\Spout\Reader\ReaderAbstract.

◆ open()

Box\Spout\Reader\ReaderInterface::open ( $filePath)

Prepares the reader to read the given file.

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

Parameters
string$filePathPath of the file to be read
Exceptions
Box\Spout\Common\Exception\IOException
Return values
void

Implemented in Box\Spout\Reader\ReaderAbstract.


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