Moodle PHP Documentation 4.3
Moodle 4.3.5 (Build: 20240610) (7dcfaa79f78)
OpenSpout\Reader\CSV\Sheet Class Reference
Inheritance diagram for OpenSpout\Reader\CSV\Sheet:
OpenSpout\Reader\SheetInterface

Public Member Functions

 __construct (RowIterator $rowIterator)
 
 getIndex ()
 
 getName ()
 
 getRowIterator ()
 
 isActive ()
 

Constructor & Destructor Documentation

◆ __construct()

OpenSpout\Reader\CSV\Sheet::__construct ( RowIterator $rowIterator)
Parameters
RowIterator$rowIteratorCorresponding row iterator

Member Function Documentation

◆ getIndex()

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

Implements OpenSpout\Reader\SheetInterface.

◆ getName()

OpenSpout\Reader\CSV\Sheet::getName ( )
Return values
stringName of the sheet - empty string since CSV does not support that

Implements OpenSpout\Reader\SheetInterface.

◆ getRowIterator()

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

Implements OpenSpout\Reader\SheetInterface.

◆ isActive()

OpenSpout\Reader\CSV\Sheet::isActive ( )
Return values
boolAlways TRUE as there is only one sheet

Implements OpenSpout\Reader\SheetInterface.


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