PHP Class Box\Spout\Reader\XLSX\Sheet

Inheritance: implements Box\Spout\Reader\SheetInterface

Show file Open project: box/spout Class Usage Examples

Protected Properties

Property	Type	Description
$index		Index of the sheet, based on order in the workbook (zero-based)
$name		Name of the sheet
$rowIterator		To iterate over sheet's rows

Public Methods

Method	Description
__construct ( string $filePath, string $sheetDataXMLFilePath, integer $sheetIndex, string $sheetName, ReaderOptions $options, $sharedStringsHelper )
getIndex ( ) : integer
getName ( ) : string
getRowIterator ( ) : RowIterator

Method Details

__construct() public method

public __construct ( string $filePath, string $sheetDataXMLFilePath, integer $sheetIndex, string $sheetName, ReaderOptions $options, $sharedStringsHelper )
$filePath	string	Path of the XLSX file being read
$sheetDataXMLFilePath	string	Path of the sheet data XML file as in [Content_Types].xml
$sheetIndex	integer	Index of the sheet, based on order in the workbook (zero-based)
$sheetName	string	Name of the sheet
$options	ReaderOptions	Reader's current options

getIndex() public method

public getIndex ( ) : integer
return	integer	Index of the sheet, based on order in the workbook (zero-based)

getName() public method

public getName ( ) : string
return	string	Name of the sheet

getRowIterator() public method

public getRowIterator ( ) : RowIterator
return	RowIterator

Property Details

$index protected property

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

protected $index

$name protected property

Name of the sheet

protected $name

$rowIterator protected property

To iterate over sheet's rows

protected $rowIterator