PHP Class Box\Spout\Reader\XLSX\SheetIterator

Inheritance: implements Box\Spout\Reader\IteratorInterface
Datei anzeigen Open project: box/spout

Protected Properties

Property Type Description
$currentSheetIndex The index of the sheet being read (zero-based)
$sheets The list of sheet present in the file

Public Methods

Method Description
__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

Method Details

__construct() public method

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() public method

Return the current element
See link: http://php.net/manual/en/iterator.current.php
public current ( ) : Sheet
return Sheet

end() public method

Cleans up what was created to iterate over the object.
public end ( ) : void
return void

key() public method

Return the key of the current element
See link: http://php.net/manual/en/iterator.key.php
public key ( ) : integer
return integer

next() public method

Move forward to next element
See link: http://php.net/manual/en/iterator.next.php
public next ( ) : void
return void

rewind() public method

Rewind the Iterator to the first element
See link: http://php.net/manual/en/iterator.rewind.php
public rewind ( ) : void
return void

valid() public method

Checks if current position is valid
See link: http://php.net/manual/en/iterator.valid.php
public valid ( ) : boolean
return boolean

Property Details

$currentSheetIndex protected_oe property

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

$sheets protected_oe property

The list of sheet present in the file
protected $sheets