PHP Класс Box\Spout\Reader\XLSX\RowIterator

Наследование: implements Box\Spout\Reader\IteratorInterface
Показать файл Открыть проект

Защищенные свойства (Protected)

Свойство Тип Описание
$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 Box\Spout\Reader\XLSX\Helper\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

Открытые методы

Метод Описание
__construct ( string $filePath, string $sheetDataXMLFilePath, ReaderOptions $options, SharedStringsHelper $sharedStringsHelper )
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

Защищенные методы

Метод Описание
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

Описание методов

__construct() публичный Метод

public __construct ( string $filePath, string $sheetDataXMLFilePath, ReaderOptions $options, SharedStringsHelper $sharedStringsHelper )
$filePath string Path of the XLSX file being read
$sheetDataXMLFilePath string Path of the sheet data XML file as in [Content_Types].xml
$options ReaderOptions Reader's current options
$sharedStringsHelper Box\Spout\Reader\XLSX\Helper\SharedStringsHelper Helper to work with shared strings

current() публичный Метод

Return the current element, either an empty row or from the buffer.
См. ссылку: http://php.net/manual/en/iterator.current.php
public current ( ) : array | null
Результат array | null

doesNeedDataForNextRowToBeProcessed() защищенный Метод

We don't need to read data if: we have already read at least one row AND we need to preserve empty rows AND the last row that was read is not the row that need to be processed (i.e. if we need to return empty rows)
protected doesNeedDataForNextRowToBeProcessed ( ) : boolean
Результат boolean Whether we need data for the next row to be processed.

end() публичный Метод

Cleans up what was created to iterate over the object.
public end ( ) : void
Результат void

getCellValue() защищенный Метод

Returns the (unescaped) correctly marshalled, cell value associated to the given XML node.
protected getCellValue ( DOMNode $node ) : string | integer | float | boolean | DateTime | null
$node DOMNode
Результат string | integer | float | boolean | DateTime | null The value associated with the cell (null when the cell has an error)

getColumnIndex() защищенный Метод

protected getColumnIndex ( Box\Spout\Reader\Wrapper\XMLReader $xmlReader ) : integer
$xmlReader Box\Spout\Reader\Wrapper\XMLReader XMLReader object, positioned on a "" node
Результат integer Column index

getRowIndex() защищенный Метод

protected getRowIndex ( Box\Spout\Reader\Wrapper\XMLReader $xmlReader ) : integer
$xmlReader Box\Spout\Reader\Wrapper\XMLReader XMLReader object, positioned on a "" node
Результат integer Row index

isEmptyRow() защищенный Метод

protected isEmptyRow ( array $rowData ) : boolean
$rowData array
Результат boolean Whether the given row is empty

key() публичный Метод

Return the key of the current element. Here, the row index.
См. ссылку: http://php.net/manual/en/iterator.key.php
public key ( ) : integer
Результат integer

next() публичный Метод

Move forward to next element. Reads data describing the next unprocessed row.
См. ссылку: http://php.net/manual/en/iterator.next.php
public next ( ) : void
Результат void

normalizeSheetDataXMLFilePath() защищенный Метод

protected normalizeSheetDataXMLFilePath ( string $sheetDataXMLFilePath ) : string
$sheetDataXMLFilePath string Path of the sheet data XML file as in [Content_Types].xml
Результат string Path of the XML file containing the sheet data, without the leading slash.

processCellStartingNode() защищенный Метод

protected processCellStartingNode ( Box\Spout\Reader\Wrapper\XMLReader $xmlReader ) : integer
$xmlReader Box\Spout\Reader\Wrapper\XMLReader XMLReader object, positioned on a "" starting node
Результат integer A return code that indicates what action should the processor take next

processDimensionStartingNode() защищенный Метод

protected processDimensionStartingNode ( Box\Spout\Reader\Wrapper\XMLReader $xmlReader ) : integer
$xmlReader Box\Spout\Reader\Wrapper\XMLReader XMLReader object, positioned on a "" starting node
Результат integer A return code that indicates what action should the processor take next

processRowEndingNode() защищенный Метод

protected processRowEndingNode ( ) : integer
Результат integer A return code that indicates what action should the processor take next

processRowStartingNode() защищенный Метод

protected processRowStartingNode ( Box\Spout\Reader\Wrapper\XMLReader $xmlReader ) : integer
$xmlReader Box\Spout\Reader\Wrapper\XMLReader XMLReader object, positioned on a "" starting node
Результат integer A return code that indicates what action should the processor take next

processWorksheetEndingNode() защищенный Метод

protected processWorksheetEndingNode ( ) : integer
Результат integer A return code that indicates what action should the processor take next

readDataForNextRow() защищенный Метод

protected readDataForNextRow ( ) : void
Результат void

rewind() публичный Метод

Initializes the XMLReader object that reads the associated sheet data. The XMLReader is configured to be safe from billion laughs attack.
См. ссылку: http://php.net/manual/en/iterator.rewind.php
public rewind ( ) : void
Результат void

valid() публичный Метод

Checks if current position is valid
См. ссылку: http://php.net/manual/en/iterator.valid.php
public valid ( ) : boolean
Результат boolean

Описание свойств

$cellValueFormatter защищенное свойство

Helper to format cell values
protected $cellValueFormatter

$currentlyProcessedRowData защищенное свойство

Contains the data for the currently processed row (key = cell index, value = cell value)
protected $currentlyProcessedRowData

$filePath защищенное свойство

Path of the XLSX file being read
protected $filePath

$hasReachedEndOfFile защищенное свойство

Indicates whether all rows have been read
protected $hasReachedEndOfFile

$lastColumnIndexProcessed защищенное свойство

Last column index processed (zero-based)
protected $lastColumnIndexProcessed

$lastRowIndexProcessed защищенное свойство

Last row index processed (one-based)
protected $lastRowIndexProcessed

$nextRowIndexToBeProcessed защищенное свойство

Row index to be processed next (one-based)
protected $nextRowIndexToBeProcessed

$numColumns защищенное свойство

The number of columns the sheet has (0 meaning undefined)
protected $numColumns

$numReadRows защищенное свойство

TODO: This variable can be deleted when row indices get preserved
protected $numReadRows

$rowDataBuffer защищенное свойство

Buffer used to store the row data, while checking if there are more rows to read
protected $rowDataBuffer

$sheetDataXMLFilePath защищенное свойство

Path of the sheet data XML file as in [Content_Types].xml
protected string $sheetDataXMLFilePath
Результат string

$shouldPreserveEmptyRows защищенное свойство

Whether empty rows should be returned or skipped
protected $shouldPreserveEmptyRows

$styleHelper защищенное свойство

Helper to work with styles
protected StyleHelper,Box\Spout\Reader\XLSX\Helper $styleHelper
Результат Box\Spout\Reader\XLSX\Helper\StyleHelper

$xmlProcessor защищенное свойство

Helper Object to process XML nodes
protected $xmlProcessor

$xmlReader защищенное свойство

The XMLReader object that will help read sheet's XML data
protected $xmlReader