Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.10.x will end 8 November 2021 (12 months).
  • Bug fixes for security issues in 3.10.x will end 9 May 2022 (18 months).
  • PHP version: minimum PHP 7.2.0 Note: minimum PHP version has increased since Moodle 3.8. PHP 7.3.x and 7.4.x are supported too.
<?php

namespace PhpOffice\PhpSpreadsheet\Worksheet;

> use Iterator as NativeIterator;
use PhpOffice\PhpSpreadsheet\Exception as PhpSpreadsheetException;
< class RowIterator implements \Iterator
> /** > * @implements NativeIterator<int, Row> > */ > class RowIterator implements NativeIterator
{ /** * 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);
> $this->subject = null; // @phpstan-ignore-line
} /** * (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
> * @return $this
*/
< public function resetStart($startRow = 1)
> public function resetStart(int $startRow = 1)
{ if ($startRow > $this->subject->getHighestRow()) {
< throw new PhpSpreadsheetException("Start row ({$startRow}) is beyond highest row ({$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
> * @return $this
*/ public function resetEnd($endRow = null) {
< $this->endRow = ($endRow) ? $endRow : $this->subject->getHighestRow();
> $this->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
> * @return $this
*/
< public function seek($row = 1)
> public function seek(int $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()
> public function rewind(): void
{ $this->position = $this->startRow; } /** * Return the current row in this worksheet.
< * < * @return Row
*/
< public function current()
> public function current(): Row
{ return new Row($this->subject, $this->position); } /** * Return the current iterator key.
< * < * @return int
*/
< public function key()
> public function key(): int
{ return $this->position; } /** * Set the iterator to its next value. */
< public function next()
> public function next(): void
{ ++$this->position; } /** * Set the iterator to its previous value. */
< public function prev()
> public function prev(): void
{ --$this->position; } /** * Indicate if more rows exist in the worksheet range of rows that we're iterating.
< * < * @return bool
*/
< public function valid()
> public function valid(): bool
{ return $this->position <= $this->endRow && $this->position >= $this->startRow; } }