Property | Type | Description | |
---|---|---|---|
$cellValueFormatter | Helper to format cell values | ||
$currentlyProcessedRowData | Contains the data for the currently processed row (key = cell index, value = cell value) | ||
$hasAlreadyBeenRewound | Whether the iterator has already been rewound once | ||
$hasAlreadyReadOneCellInCurrentRow | Whether at least one cell has been read for the row currently being processed | ||
$hasReachedEndOfFile | Indicates whether all rows have been read | ||
$lastProcessedCellValue | Value of the last processed cell (because when reading cell at column N+1, cell N is processed) | ||
$lastRowIndexProcessed | Last row index processed (one-based) | ||
$nextRowIndexToBeProcessed | Row index to be processed next (one-based) | ||
$numColumnsRepeated | Number of times the last cell value should be copied to the cells on its right | ||
$numRowsRepeated | Number of times the last processed row should be repeated | ||
$rowDataBuffer | Buffer used to store the row data, while checking if there are more rows to read | ||
$shouldPreserveEmptyRows | Whether empty rows should be returned or skipped | ||
$xmlProcessor | Helper Object to process XML nodes | ||
$xmlReader | The XMLReader object that will help read sheet's XML data |
Method | Description | |
---|---|---|
__construct ( Box\Spout\Reader\Wrapper\XMLReader $xmlReader, Box\Spout\Reader\ODS\ReaderOptions $options ) | ||
current ( ) : array | null | Return the current element, from the buffer. | |
end ( ) : void | Cleans up what was created to iterate over the object. | |
key ( ) : integer | Return the key of the current element | |
next ( ) : void | Move forward to next element. Empty rows will be skipped. | |
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 | DateInterval | null | Returns the (unescaped) correctly marshalled, cell value associated to the given XML node. | |
getNumColumnsRepeatedForCurrentNode ( Box\Spout\Reader\Wrapper\XMLReader $xmlReader ) : integer | ||
getNumRowsRepeatedForCurrentNode ( Box\Spout\Reader\Wrapper\XMLReader $xmlReader ) : integer | ||
isEmptyRow ( array $rowData, $lastReadCellValue ) : boolean | After finishing processing each cell, a row is considered empty if it contains no cells or if the value of the last read cell is an empty string. | |
processCellStartingNode ( Box\Spout\Reader\Wrapper\XMLReader $xmlReader ) : integer | ||
processRowEndingNode ( ) : integer | ||
processRowStartingNode ( Box\Spout\Reader\Wrapper\XMLReader $xmlReader ) : integer | ||
processTableEndingNode ( ) : integer | ||
readDataForNextRow ( ) : void |
public __construct ( Box\Spout\Reader\Wrapper\XMLReader $xmlReader, Box\Spout\Reader\ODS\ReaderOptions $options ) | ||
$xmlReader | Box\Spout\Reader\Wrapper\XMLReader | XML Reader, positioned on the " |
$options | Box\Spout\Reader\ODS\ReaderOptions | Reader's current options |
protected doesNeedDataForNextRowToBeProcessed ( ) : boolean | ||
return | boolean | Whether we need data for the next row to be processed. |
protected getNumColumnsRepeatedForCurrentNode ( Box\Spout\Reader\Wrapper\XMLReader $xmlReader ) : integer | ||
$xmlReader | Box\Spout\Reader\Wrapper\XMLReader | XMLReader object, positioned on a " |
return | integer | The value of "table:number-columns-repeated" attribute of the current node, or 1 if attribute missing |
protected getNumRowsRepeatedForCurrentNode ( Box\Spout\Reader\Wrapper\XMLReader $xmlReader ) : integer | ||
$xmlReader | Box\Spout\Reader\Wrapper\XMLReader | XMLReader object, positioned on a " |
return | integer | The value of "table:number-rows-repeated" attribute of the current node, or 1 if attribute missing |
protected isEmptyRow ( array $rowData, $lastReadCellValue ) : boolean | ||
$rowData | array | |
return | boolean | Whether the row is empty |
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 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 processTableEndingNode ( ) : integer | ||
return | integer | A return code that indicates what action should the processor take next |
protected $currentlyProcessedRowData |
protected $hasAlreadyBeenRewound |
protected $hasAlreadyReadOneCellInCurrentRow |
protected $hasReachedEndOfFile |
protected $lastProcessedCellValue |
protected $lastRowIndexProcessed |
protected $nextRowIndexToBeProcessed |
protected $numColumnsRepeated |
protected $numRowsRepeated |
protected $rowDataBuffer |
protected $shouldPreserveEmptyRows |