Moodle PHP Documentation 5.1
Moodle 5.1dev (Build: 20250620) (7d9030acd6e)
OpenSpout\Reader\SheetInterface Interface Reference
Inheritance diagram for OpenSpout\Reader\SheetInterface:
OpenSpout\Reader\CSV\Sheet OpenSpout\Reader\SheetWithMergeCellsInterface OpenSpout\Reader\SheetWithVisibilityInterface OpenSpout\Reader\XLSX\Sheet OpenSpout\Reader\ODS\Sheet OpenSpout\Reader\XLSX\Sheet

Public Member Functions

 getIndex ()
 
 getName ()
 
 getRowIterator ()
 
 isActive ()
 

Member Function Documentation

◆ getIndex()

OpenSpout\Reader\SheetInterface::getIndex ( )
Return values
intIndex of the sheet

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

◆ getName()

OpenSpout\Reader\SheetInterface::getName ( )
Return values
stringName of the sheet

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

◆ getRowIterator()

OpenSpout\Reader\SheetInterface::getRowIterator ( )
Return values
Titerator to iterate over the sheet's rows

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

◆ isActive()

OpenSpout\Reader\SheetInterface::isActive ( )
Return values
boolWhether the sheet was defined as active

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


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