PHP Class Box\Spout\Reader\ODS\SheetIterator

Inheritance: implements Box\Spout\Reader\IteratorInterface

Protected Properties

Property	Type	Description
$currentSheetIndex		The index of the sheet being read (zero-based)
$escaper		Used to unescape XML data
$filePath	string	Path of the file to be read
$hasFoundSheet		Whether there are still at least a sheet to be read
$options		Reader's current options
$xmlReader		The XMLReader object that will help read sheet's XML data

Public Methods

Method	Description
__construct ( string $filePath, Box\Spout\Reader\ODS\ReaderOptions $options )
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, Box\Spout\Reader\ODS\ReaderOptions $options )
$filePath	string	Path of the file to be read
$options	Box\Spout\Reader\ODS\ReaderOptions	Reader's current options

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

$escaper protected_oe property

Used to unescape XML data

protected $escaper

$filePath protected_oe property

Path of the file to be read

protected string $filePath
return	string

$hasFoundSheet protected_oe property

Whether there are still at least a sheet to be read

protected $hasFoundSheet

$options protected_oe property

Reader's current options

protected $options

$xmlReader protected_oe property

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

protected $xmlReader