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 PhpOffice\PhpSpreadsheet\Cell\Coordinate;
use PhpOffice\PhpSpreadsheet\Exception as PhpSpreadsheetException;

class RowCellIterator extends CellIterator
{
    /**
     * Current iterator position.
     *
     * @var int
     */
    private $currentColumnIndex;

    /**
     * Row index.
     *
     * @var int
     */
    private $rowIndex = 1;

    /**
     * Start position.
     *
     * @var int
     */
    private $startColumnIndex = 1;

    /**
     * End position.
     *
     * @var int
     */
    private $endColumnIndex = 1;

    /**
     * Create a new column iterator.
     *
     * @param Worksheet $worksheet The worksheet to iterate over
     * @param int $rowIndex The row that we want to iterate
     * @param string $startColumn The column address at which to start iterating
     * @param string $endColumn Optionally, the column address at which to stop iterating
     */
< public function __construct(Worksheet $worksheet = null, $rowIndex = 1, $startColumn = 'A', $endColumn = null)
> public function __construct(?Worksheet $worksheet = null, $rowIndex = 1, $startColumn = 'A', $endColumn = null)
{ // Set subject and row index $this->worksheet = $worksheet; $this->rowIndex = $rowIndex; $this->resetEnd($endColumn); $this->resetStart($startColumn); } /** * (Re)Set the start column and the current column pointer. * * @param string $startColumn The column address at which to start iterating *
< * @throws PhpSpreadsheetException < * < * @return RowCellIterator
> * @return $this
*/ public function resetStart($startColumn = 'A') { $this->startColumnIndex = Coordinate::columnIndexFromString($startColumn); $this->adjustForExistingOnlyRange(); $this->seek(Coordinate::stringFromColumnIndex($this->startColumnIndex)); return $this; } /** * (Re)Set the end column. * * @param string $endColumn The column address at which to stop iterating *
< * @throws PhpSpreadsheetException < * < * @return RowCellIterator
> * @return $this
*/ public function resetEnd($endColumn = null) { $endColumn = $endColumn ? $endColumn : $this->worksheet->getHighestColumn(); $this->endColumnIndex = Coordinate::columnIndexFromString($endColumn); $this->adjustForExistingOnlyRange(); return $this; } /** * Set the column pointer to the selected column. * * @param string $column The column address to set the current pointer at *
< * @throws PhpSpreadsheetException < * < * @return RowCellIterator
> * @return $this
*/ public function seek($column = 'A') {
> $columnx = $column;
$column = Coordinate::columnIndexFromString($column);
< if (($column < $this->startColumnIndex) || ($column > $this->endColumnIndex)) { < throw new PhpSpreadsheetException("Column $column is out of range ({$this->startColumnIndex} - {$this->endColumnIndex})"); < } elseif ($this->onlyExistingCells && !($this->worksheet->cellExistsByColumnAndRow($column, $this->rowIndex))) {
> if ($this->onlyExistingCells && !($this->worksheet->cellExistsByColumnAndRow($column, $this->rowIndex))) {
throw new PhpSpreadsheetException('In "IterateOnlyExistingCells" mode and Cell does not exist'); }
> if (($column < $this->startColumnIndex) || ($column > $this->endColumnIndex)) { $this->currentColumnIndex = $column; > throw new PhpSpreadsheetException("Column $columnx is out of range ({$this->startColumnIndex} - {$this->endColumnIndex})"); > }
return $this; } /** * Rewind the iterator to the starting column. */
< public function rewind()
> public function rewind(): void
{ $this->currentColumnIndex = $this->startColumnIndex; } /** * Return the current cell in this worksheet row. * * @return \PhpOffice\PhpSpreadsheet\Cell\Cell */ public function current() { return $this->worksheet->getCellByColumnAndRow($this->currentColumnIndex, $this->rowIndex); } /** * Return the current iterator key. * * @return string */ public function key() { return Coordinate::stringFromColumnIndex($this->currentColumnIndex); } /** * Set the iterator to its next value. */
< public function next()
> public function next(): void
{ do { ++$this->currentColumnIndex; } while (($this->onlyExistingCells) && (!$this->worksheet->cellExistsByColumnAndRow($this->currentColumnIndex, $this->rowIndex)) && ($this->currentColumnIndex <= $this->endColumnIndex)); } /** * Set the iterator to its previous value.
< * < * @throws PhpSpreadsheetException
*/
< public function prev()
> public function prev(): void
{ do { --$this->currentColumnIndex; } while (($this->onlyExistingCells) && (!$this->worksheet->cellExistsByColumnAndRow($this->currentColumnIndex, $this->rowIndex)) && ($this->currentColumnIndex >= $this->startColumnIndex)); } /** * Indicate if more columns exist in the worksheet range of columns that we're iterating. * * @return bool */ public function valid() { return $this->currentColumnIndex <= $this->endColumnIndex && $this->currentColumnIndex >= $this->startColumnIndex; } /** * Return the current iterator position. * * @return int */ public function getCurrentColumnIndex() { return $this->currentColumnIndex; } /** * Validate start/end values for "IterateOnlyExistingCells" mode, and adjust if necessary.
< * < * @throws PhpSpreadsheetException
*/
< protected function adjustForExistingOnlyRange()
> protected function adjustForExistingOnlyRange(): void
{ if ($this->onlyExistingCells) { while ((!$this->worksheet->cellExistsByColumnAndRow($this->startColumnIndex, $this->rowIndex)) && ($this->startColumnIndex <= $this->endColumnIndex)) { ++$this->startColumnIndex; }
< if ($this->startColumnIndex > $this->endColumnIndex) { < throw new PhpSpreadsheetException('No cells exist within the specified range'); < }
while ((!$this->worksheet->cellExistsByColumnAndRow($this->endColumnIndex, $this->rowIndex)) && ($this->endColumnIndex >= $this->startColumnIndex)) { --$this->endColumnIndex;
< } < if ($this->endColumnIndex < $this->startColumnIndex) { < throw new PhpSpreadsheetException('No cells exist within the specified range');
} } } }