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

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

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

Свойство Тип Описание
$currentSheetIndex The index of the sheet being read (zero-based)
$sheets The list of sheet present in the file

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

Метод Описание
__construct ( string $filePath, ReaderOptions $options, SharedStringsHelper $sharedStringsHelper, Box\Spout\Common\Helper\GlobalFunctionsHelper $globalFunctionsHelper )
current ( ) : Sheet Return the current element
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
rewind ( ) : void Rewind the Iterator to the first element
valid ( ) : boolean Checks if current position is valid

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

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

public __construct ( string $filePath, ReaderOptions $options, SharedStringsHelper $sharedStringsHelper, Box\Spout\Common\Helper\GlobalFunctionsHelper $globalFunctionsHelper )
$filePath string Path of the file to be read
$options ReaderOptions Reader's current options
$sharedStringsHelper Box\Spout\Reader\XLSX\Helper\SharedStringsHelper
$globalFunctionsHelper Box\Spout\Common\Helper\GlobalFunctionsHelper

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

Return the current element
См. ссылку: http://php.net/manual/en/iterator.current.php
public current ( ) : Sheet
Результат Sheet

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

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

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

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

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

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

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

Rewind the Iterator to the first element
См. ссылку: 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

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

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

The index of the sheet being read (zero-based)
protected $currentSheetIndex

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

The list of sheet present in the file
protected $sheets