splitRange and ProtectedRange

Fix #1457, which had gone stale but is now re-opened. The `Coordinate::splitRange` method expects a string of cell ranges, but it is a bit limited. Excel sometimes uses comma for union and space for intersection, and sometimes vice versa. `splitRange` uses comma for union, and doesn't do anything with spaces. This PR adds a new method `Coordinate::allRanges` which handles both union and intersection, and adds a parameter to indicate whether comma means union or intersection (with space meaning the other). Also, since the issue specifically mentioned this as a problem for `ProtectedRange`, an `allRanges` method is added to that class.

Author: oleibman

src/PhpSpreadsheet/Cell/Coordinate.php

@@ -136,7 +136,8 @@ public static function absoluteCoordinate(string $cellAddress): string
     }
 
     /**
-     * Split range into coordinate strings.
+     * Split range into coordinate strings, using comma for union
+     * and ignoring intersection (space).
      *
      * @param string $range e.g. 'B4:D9' or 'B4:D9,H2:O11' or 'B4'
      *
@@ -160,6 +161,28 @@ public static function splitRange(string $range): array
         return $outArray;
     }
 
+    /**
+     * Split range into coordinate strings, resolving unions and intersections.
+     *
+     * @param string $range e.g. 'B4:D9' or 'B4:D9,H2:O11' or 'B4'
+     * @param bool $unionIsComma true=comma is union, space is intersection
+     *                           false=space is union, comma is intersection
+     *
+     * @return array<array<string>> Array containing one or more arrays containing one or two coordinate strings
+     *                                e.g. ['B4','D9'] or [['B4','D9'], ['H2','O11']]
+     *                                        or ['B4']
+     */
+    public static function allRanges(string $range, bool $unionIsComma = true): array
+    {
+        if (!$unionIsComma) {
+            $range = str_replace([',', ' ', "\0"], ["\0", ',', ' '], $range);
+        }
+
+        return self::splitRange(
+            self::resolveUnionAndIntersection($range)
+        );
+    }
+
     /**
      * Build range from coordinate strings.
      *

src/PhpSpreadsheet/Worksheet/ProtectedRange.php

@@ -2,6 +2,8 @@
 
 namespace PhpOffice\PhpSpreadsheet\Worksheet;
 
+use PhpOffice\PhpSpreadsheet\Cell\Coordinate;
+
 class ProtectedRange
 {
     private string $name = '';
@@ -42,4 +44,16 @@ public function getSecurityDescriptor(): string
     {
         return $this->securityDescriptor;
     }
+
+    /**
+     * Split range into coordinate strings.
+     *
+     * @return array<array<string>> Array containing one or more arrays containing one or two coordinate strings
+     *                                e.g. ['B4','D9'] or [['B4','D9'], ['H2','O11']]
+     *                                        or ['B4']
+     */
+    public function allRanges(): array
+    {
+        return Coordinate::allRanges($this->sqref, false);
+    }
 }

tests/PhpSpreadsheetTests/Worksheet/Issue1457Test.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpOffice\PhpSpreadsheetTests\Worksheet;
+
+use PhpOffice\PhpSpreadsheet\Worksheet\Worksheet;
+use PHPUnit\Framework\TestCase;
+
+class Issue1457Test extends TestCase
+{
+    public function testIssue1457(): void
+    {
+        $sheet = new Worksheet();
+        $sheet->protectCells('C14:O15 C161:O1081 C16:H160 J16:O160 Q5');
+        $protectedRanges = $sheet->getProtectedCellRanges();
+        self::assertCount(1, $protectedRanges);
+        $range0 = reset($protectedRanges);
+        $expected = [
+            ['C14', 'O15'],
+            ['C161', 'O1081'],
+            ['C16', 'H160'],
+            ['J16', 'O160'],
+            ['Q5'],
+        ];
+        self::assertSame($expected, $range0->allRanges());
+    }
+}