OpenSpout\Reader\ODS\Sheet Class Reference

Inheritance diagram for OpenSpout\Reader\ODS\Sheet:

Public Member Functions
	__construct (RowIterator $rowIterator, int $sheetIndex, string $sheetName, bool $isSheetActive, bool $isSheetVisible)
	getIndex ()
	getName ()
	getRowIterator ()
	isActive ()
	isVisible ()

Constructor & Destructor Documentation

__construct()

OpenSpout\Reader\ODS\Sheet::__construct	(	RowIterator	$rowIterator,
		int	$sheetIndex,
		string	$sheetName,
		bool	$isSheetActive,
		bool	$isSheetVisible )

Parameters

RowIterator	$rowIterator	The corresponding row iterator
int	$sheetIndex	Index of the sheet, based on order in the workbook (zero-based)
string	$sheetName	Name of the sheet
bool	$isSheetActive	Whether the sheet was defined as active
bool	$isSheetVisible	Whether the sheet is visible

Member Function Documentation

getIndex()

OpenSpout\Reader\ODS\Sheet::getIndex

(

)

Return values

int	Index of the sheet, based on order in the workbook (zero-based)

Implements OpenSpout\Reader\SheetInterface.

getName()

OpenSpout\Reader\ODS\Sheet::getName

(

)

Return values

string

Name of the sheet

Implements OpenSpout\Reader\SheetInterface.

getRowIterator()

OpenSpout\Reader\ODS\Sheet::getRowIterator

(

)

Return values

T	iterator to iterate over the sheet's rows

Implements OpenSpout\Reader\SheetInterface.

isActive()

OpenSpout\Reader\ODS\Sheet::isActive

(

)

Return values

bool	Whether the sheet was defined as active

Implements OpenSpout\Reader\SheetInterface.

isVisible()

OpenSpout\Reader\ODS\Sheet::isVisible

(

)

Return values

bool	Whether the sheet is visible

Implements OpenSpout\Reader\SheetWithVisibilityInterface.

---

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

• lib/openspout/src/Reader/ODS/Sheet.php