<?php namespace PhpOffice\PhpSpreadsheet\Worksheet; use PhpOffice\PhpSpreadsheet\Exception as PhpSpreadsheetException; class RowIterator implements \Iterator { /** * Worksheet to iterate. * * @var Worksheet */ private $subject; /** * Current iterator position. * * @var int */ private $position = 1; /** * Start position. * * @var int */ private $startRow = 1; /** * End position. * * @var int */ private $endRow = 1; /** * Create a new row iterator. * * @param Worksheet $subject The worksheet to iterate over * @param int $startRow The row number at which to start iterating * @param int $endRow Optionally, the row number at which to stop iterating */ public function __construct(Worksheet $subject, $startRow = 1, $endRow = null) { // Set subject $this->subject = $subject; $this->resetEnd($endRow); $this->resetStart($startRow); } /** * Destructor. */ public function __destruct() { unset($this->subject); } /** * (Re)Set the start row and the current row pointer. * * @param int $startRow The row number at which to start iterating * * @throws PhpSpreadsheetException * * @return RowIterator */ public function resetStart($startRow = 1) { if ($startRow > $this->subject->getHighestRow()) { throw new PhpSpreadsheetException("Start row ({$startRow}) is beyond highest row ({$this->subject->getHighestRow()})"); } $this->startRow = $startRow; if ($this->endRow < $this->startRow) { $this->endRow = $this->startRow; } $this->seek($startRow); return $this; } /** * (Re)Set the end row. * * @param int $endRow The row number at which to stop iterating * * @return RowIterator */ public function resetEnd($endRow = null) { $this->endRow = ($endRow) ? $endRow : $this->subject->getHighestRow(); return $this; } /** * Set the row pointer to the selected row. * * @param int $row The row number to set the current pointer at * * @throws PhpSpreadsheetException * * @return RowIterator */ public function seek($row = 1) { if (($row < $this->startRow) || ($row > $this->endRow)) { throw new PhpSpreadsheetException("Row $row is out of range ({$this->startRow} - {$this->endRow})"); } $this->position = $row; return $this; } /** * Rewind the iterator to the starting row. */ public function rewind() { $this->position = $this->startRow; } /** * Return the current row in this worksheet. * * @return Row */ public function current() { return new Row($this->subject, $this->position); } /** * Return the current iterator key. * * @return int */ public function key() { return $this->position; } /** * Set the iterator to its next value. */ public function next() { ++$this->position; } /** * Set the iterator to its previous value. */ public function prev() { --$this->position; } /** * Indicate if more rows exist in the worksheet range of rows that we're iterating. * * @return bool */ public function valid() { return $this->position <= $this->endRow && $this->position >= $this->startRow; } }