Property | Type | Description | |
---|---|---|---|
$cellValueFormatter | Helper to format cell values | ||
$currentlyProcessedRowData | Contains the data for the currently processed row (key = cell index, value = cell value) | ||
$filePath | Path of the XLSX file being read | ||
$hasReachedEndOfFile | Indicates whether all rows have been read | ||
$lastColumnIndexProcessed | Last column index processed (zero-based) | ||
$lastRowIndexProcessed | Last row index processed (one-based) | ||
$nextRowIndexToBeProcessed | Row index to be processed next (one-based) | ||
$numColumns | The number of columns the sheet has (0 meaning undefined) | ||
$numReadRows | TODO: This variable can be deleted when row indices get preserved | ||
$rowDataBuffer | Buffer used to store the row data, while checking if there are more rows to read | ||
$sheetDataXMLFilePath | string | Path of the sheet data XML file as in [Content_Types].xml | |
$shouldPreserveEmptyRows | Whether empty rows should be returned or skipped | ||
$styleHelper | Helper to work with styles | ||
$xmlProcessor | Helper Object to process XML nodes | ||
$xmlReader | The XMLReader object that will help read sheet's XML data |
Method | Description | |
---|---|---|
__construct ( string $filePath, string $sheetDataXMLFilePath, |
||
current ( ) : array | null | Return the current element, either an empty row or from the buffer. | |
end ( ) : void | Cleans up what was created to iterate over the object. | |
key ( ) : integer | Return the key of the current element. Here, the row index. | |
next ( ) : void | Move forward to next element. Reads data describing the next unprocessed row. | |
rewind ( ) : void | Rewind the Iterator to the first element. | |
valid ( ) : boolean | Checks if current position is valid |
Method | Description | |
---|---|---|
doesNeedDataForNextRowToBeProcessed ( ) : boolean | Returns whether we need data for the next row to be processed. | |
getCellValue ( DOMNode $node ) : string | integer | float | boolean | DateTime | null | Returns the (unescaped) correctly marshalled, cell value associated to the given XML node. | |
getColumnIndex ( Box\Spout\Reader\Wrapper\XMLReader $xmlReader ) : integer | ||
getRowIndex ( Box\Spout\Reader\Wrapper\XMLReader $xmlReader ) : integer | ||
isEmptyRow ( array $rowData ) : boolean | ||
normalizeSheetDataXMLFilePath ( string $sheetDataXMLFilePath ) : string | ||
processCellStartingNode ( Box\Spout\Reader\Wrapper\XMLReader $xmlReader ) : integer | ||
processDimensionStartingNode ( Box\Spout\Reader\Wrapper\XMLReader $xmlReader ) : integer | ||
processRowEndingNode ( ) : integer | ||
processRowStartingNode ( Box\Spout\Reader\Wrapper\XMLReader $xmlReader ) : integer | ||
processWorksheetEndingNode ( ) : integer | ||
readDataForNextRow ( ) : void |
public __construct ( string $filePath, string $sheetDataXMLFilePath, |
||
$filePath | string | Path of the XLSX file being read |
$sheetDataXMLFilePath | string | Path of the sheet data XML file as in [Content_Types].xml |
$options | Reader's current options | |
$sharedStringsHelper | Helper to work with shared strings |
protected doesNeedDataForNextRowToBeProcessed ( ) : boolean | ||
return | boolean | Whether we need data for the next row to be processed. |
protected getColumnIndex ( Box\Spout\Reader\Wrapper\XMLReader $xmlReader ) : integer | ||
$xmlReader | Box\Spout\Reader\Wrapper\XMLReader | XMLReader object, positioned on a " |
return | integer | Column index |
protected getRowIndex ( Box\Spout\Reader\Wrapper\XMLReader $xmlReader ) : integer | ||
$xmlReader | Box\Spout\Reader\Wrapper\XMLReader | XMLReader object, positioned on a " |
return | integer | Row index |
protected isEmptyRow ( array $rowData ) : boolean | ||
$rowData | array | |
return | boolean | Whether the given row is empty |
protected normalizeSheetDataXMLFilePath ( string $sheetDataXMLFilePath ) : string | ||
$sheetDataXMLFilePath | string | Path of the sheet data XML file as in [Content_Types].xml |
return | string | Path of the XML file containing the sheet data, without the leading slash. |
protected processCellStartingNode ( Box\Spout\Reader\Wrapper\XMLReader $xmlReader ) : integer | ||
$xmlReader | Box\Spout\Reader\Wrapper\XMLReader | XMLReader object, positioned on a " |
return | integer | A return code that indicates what action should the processor take next |
protected processDimensionStartingNode ( Box\Spout\Reader\Wrapper\XMLReader $xmlReader ) : integer | ||
$xmlReader | Box\Spout\Reader\Wrapper\XMLReader | XMLReader object, positioned on a " |
return | integer | A return code that indicates what action should the processor take next |
protected processRowEndingNode ( ) : integer | ||
return | integer | A return code that indicates what action should the processor take next |
protected processRowStartingNode ( Box\Spout\Reader\Wrapper\XMLReader $xmlReader ) : integer | ||
$xmlReader | Box\Spout\Reader\Wrapper\XMLReader | XMLReader object, positioned on a " |
return | integer | A return code that indicates what action should the processor take next |
protected processWorksheetEndingNode ( ) : integer | ||
return | integer | A return code that indicates what action should the processor take next |
protected $currentlyProcessedRowData |
protected $hasReachedEndOfFile |
protected $lastColumnIndexProcessed |
protected $lastRowIndexProcessed |
protected $nextRowIndexToBeProcessed |
protected $numColumns |
protected $numReadRows |
protected $rowDataBuffer |
protected string $sheetDataXMLFilePath | ||
return | string |
protected $shouldPreserveEmptyRows |
protected StyleHelper,Box\Spout\Reader\XLSX\Helper $styleHelper | ||
return |