114 lines
2.8 KiB
PHP
114 lines
2.8 KiB
PHP
<?php
|
|
|
|
namespace OpenSpout\Reader\XLSX;
|
|
|
|
use OpenSpout\Reader\Exception\NoSheetsFoundException;
|
|
use OpenSpout\Reader\IteratorInterface;
|
|
use OpenSpout\Reader\XLSX\Manager\SheetManager;
|
|
|
|
/**
|
|
* Iterate over XLSX sheet.
|
|
*/
|
|
class SheetIterator implements IteratorInterface
|
|
{
|
|
/** @var \OpenSpout\Reader\XLSX\Sheet[] The list of sheet present in the file */
|
|
protected $sheets;
|
|
|
|
/** @var int The index of the sheet being read (zero-based) */
|
|
protected $currentSheetIndex;
|
|
|
|
/**
|
|
* @param SheetManager $sheetManager Manages sheets
|
|
*
|
|
* @throws \OpenSpout\Reader\Exception\NoSheetsFoundException If there are no sheets in the file
|
|
*/
|
|
public function __construct($sheetManager)
|
|
{
|
|
// Fetch all available sheets
|
|
$this->sheets = $sheetManager->getSheets();
|
|
|
|
if (0 === \count($this->sheets)) {
|
|
throw new NoSheetsFoundException('The file must contain at least one sheet.');
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Rewind the Iterator to the first element.
|
|
*
|
|
* @see http://php.net/manual/en/iterator.rewind.php
|
|
*/
|
|
#[\ReturnTypeWillChange]
|
|
public function rewind()
|
|
{
|
|
$this->currentSheetIndex = 0;
|
|
}
|
|
|
|
/**
|
|
* Checks if current position is valid.
|
|
*
|
|
* @see http://php.net/manual/en/iterator.valid.php
|
|
*
|
|
* @return bool
|
|
*/
|
|
#[\ReturnTypeWillChange]
|
|
public function valid()
|
|
{
|
|
return $this->currentSheetIndex < \count($this->sheets);
|
|
}
|
|
|
|
/**
|
|
* Move forward to next element.
|
|
*
|
|
* @see http://php.net/manual/en/iterator.next.php
|
|
*/
|
|
#[\ReturnTypeWillChange]
|
|
public function next()
|
|
{
|
|
// Using isset here because it is way faster than array_key_exists...
|
|
if (isset($this->sheets[$this->currentSheetIndex])) {
|
|
$currentSheet = $this->sheets[$this->currentSheetIndex];
|
|
$currentSheet->getRowIterator()->end();
|
|
|
|
++$this->currentSheetIndex;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Return the current element.
|
|
*
|
|
* @see http://php.net/manual/en/iterator.current.php
|
|
*
|
|
* @return \OpenSpout\Reader\XLSX\Sheet
|
|
*/
|
|
#[\ReturnTypeWillChange]
|
|
public function current()
|
|
{
|
|
return $this->sheets[$this->currentSheetIndex];
|
|
}
|
|
|
|
/**
|
|
* Return the key of the current element.
|
|
*
|
|
* @see http://php.net/manual/en/iterator.key.php
|
|
*
|
|
* @return int
|
|
*/
|
|
#[\ReturnTypeWillChange]
|
|
public function key()
|
|
{
|
|
return $this->currentSheetIndex + 1;
|
|
}
|
|
|
|
/**
|
|
* Cleans up what was created to iterate over the object.
|
|
*/
|
|
#[\ReturnTypeWillChange]
|
|
public function end()
|
|
{
|
|
// make sure we are not leaking memory in case the iteration stopped before the end
|
|
foreach ($this->sheets as $sheet) {
|
|
$sheet->getRowIterator()->end();
|
|
}
|
|
}
|
|
}
|