Add iterateOnlyExistingCells to Constructors

Fix PHPOffice#3721. That issue can already be handled, but requires several statements when one ought to suffice. Adding an extra parameter to the RowCellIterator and ColumnCellIterator constructors is useful, easy, and becomes especially practical now that our supported Php releases all support named parameters (see new test Issue3721Test).

Author: oleibman

src/PhpSpreadsheet/Worksheet/Column.php

@@ -53,9 +53,9 @@ public function getColumnIndex(): string
      * @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 getCellIterator($startRow = 1, $endRow = null): ColumnCellIterator
+    public function getCellIterator($startRow = 1, $endRow = null, bool $iterateOnlyExistingCells = false): ColumnCellIterator
     {
-        return new ColumnCellIterator($this->worksheet, $this->columnIndex, $startRow, $endRow);
+        return new ColumnCellIterator($this->worksheet, $this->columnIndex, $startRow, $endRow, $iterateOnlyExistingCells);
     }
 
     /**
@@ -64,9 +64,9 @@ public function getCellIterator($startRow = 1, $endRow = null): ColumnCellIterat
      * @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 getRowIterator($startRow = 1, $endRow = null): ColumnCellIterator
+    public function getRowIterator($startRow = 1, $endRow = null, bool $iterateOnlyExistingCells = false): ColumnCellIterator
     {
-        return $this->getCellIterator($startRow, $endRow);
+        return $this->getCellIterator($startRow, $endRow, $iterateOnlyExistingCells);
     }
 
     /**

src/PhpSpreadsheet/Worksheet/ColumnCellIterator.php

@@ -47,14 +47,15 @@ class ColumnCellIterator extends CellIterator
      * @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 $worksheet, $columnIndex = 'A', $startRow = 1, $endRow = null)
+    public function __construct(Worksheet $worksheet, $columnIndex = 'A', $startRow = 1, $endRow = null, bool $iterateOnlyExistingCells = false)
     {
         // Set subject
         $this->worksheet = $worksheet;
         $this->cellCollection = $worksheet->getCellCollection();
         $this->columnIndex = Coordinate::columnIndexFromString($columnIndex);
         $this->resetEnd($endRow);
         $this->resetStart($startRow);
+        $this->setIterateOnlyExistingCells($iterateOnlyExistingCells);
     }
 
     /**

src/PhpSpreadsheet/Worksheet/Row.php

@@ -52,9 +52,9 @@ public function getRowIndex(): int
      * @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 getCellIterator($startColumn = 'A', $endColumn = null): RowCellIterator
+    public function getCellIterator($startColumn = 'A', $endColumn = null, bool $iterateOnlyExistingCells = false): RowCellIterator
     {
-        return new RowCellIterator($this->worksheet, $this->rowIndex, $startColumn, $endColumn);
+        return new RowCellIterator($this->worksheet, $this->rowIndex, $startColumn, $endColumn, $iterateOnlyExistingCells);
     }
 
     /**
@@ -63,9 +63,9 @@ public function getCellIterator($startColumn = 'A', $endColumn = null): RowCellI
      * @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 getColumnIterator($startColumn = 'A', $endColumn = null): RowCellIterator
+    public function getColumnIterator($startColumn = 'A', $endColumn = null, bool $iterateOnlyExistingCells = false): RowCellIterator
     {
-        return $this->getCellIterator($startColumn, $endColumn);
+        return $this->getCellIterator($startColumn, $endColumn, $iterateOnlyExistingCells);
     }
 
     /**

src/PhpSpreadsheet/Worksheet/RowCellIterator.php

@@ -47,14 +47,15 @@ class RowCellIterator extends CellIterator
      * @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, $rowIndex = 1, $startColumn = 'A', $endColumn = null)
+    public function __construct(Worksheet $worksheet, $rowIndex = 1, $startColumn = 'A', $endColumn = null, bool $iterateOnlyExistingCells = false)
     {
         // Set subject and row index
         $this->worksheet = $worksheet;
         $this->cellCollection = $worksheet->getCellCollection();
         $this->rowIndex = $rowIndex;
         $this->resetEnd($endColumn);
         $this->resetStart($startColumn);
+        $this->setIterateOnlyExistingCells($iterateOnlyExistingCells);
     }
 
     /**

tests/PhpSpreadsheetTests/Reader/Ods/Issue3721Test.php

@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpOffice\PhpSpreadsheetTests\Reader\Ods;
+
+use PhpOffice\PhpSpreadsheet\Reader\Ods;
+use PHPUnit\Framework\TestCase;
+
+class Issue3721Test extends TestCase
+{
+    public function testIssue2810(): void
+    {
+        // Problems with getHighestDataColumn
+        $filename = 'tests/data/Reader/Ods/issue.3721.ods';
+        $reader = new Ods();
+        $spreadsheet = $reader->load($filename);
+        $sheet = $spreadsheet->getSheetByNameOrThrow('sheet with data');
+        $origHigh = $sheet->getHighestDataColumn();
+        self::assertSame('C', $origHigh);
+        $cells = [];
+        foreach ($sheet->getRowIterator() as $row) {
+            foreach ($row->getCellIterator(iterateOnlyExistingCells: true) as $cell) {
+                $cells[] = $cell->getCoordinate();
+            }
+        }
+        self::assertSame(['A1', 'B1', 'C1', 'A2', 'B2', 'C2'], $cells);
+        self::assertSame('C', $sheet->getHighestDataColumn());
+        self::assertSame('BL', $sheet->getHighestColumn());
+        $spreadsheet->disconnectWorksheets();
+    }
+}