PHP Interface Akeneo\Component\SpreadsheetParser\SpreadsheetInterface

Author: Antoine Guigan ([email protected])
Show file Open project: akeneo-labs/spreadsheet-parser Interface Usage Examples

Public Methods

Method Description
createRowIterator ( integer $worksheetIndex, array $options = [] ) : Iterator Returns a row iterator for the current worksheet index
getWorksheetIndex ( string $name ) : integer | false Returns a worksheet index by name
getWorksheets ( ) : string[] Returns an array containing all worksheet names

Method Details

createRowIterator() public method

Returns a row iterator for the current worksheet index
public createRowIterator ( integer $worksheetIndex, array $options = [] ) : Iterator
$worksheetIndex integer
$options array
return Iterator

getWorksheetIndex() public method

Returns a worksheet index by name
public getWorksheetIndex ( string $name ) : integer | false
$name string
return integer | false Returns false in case there is no worksheet with this name

getWorksheets() public method

The keys of the array should be the indexes of the worksheets
public getWorksheets ( ) : string[]
return string[]