Merge pull request #2682 from PHPOffice/Refactoring-Work-on-ReferenceHelper

Some work on refactoring the ReferenceHelper to extract the logic for updating cell references. This is a preliminary step toward allowing updates to absolute cell references, required to update Conditional Formatting rules.

And a bugfix when deleting cells that contain hyperlinks (the hperlinks weren't being deleted, so were being "inherited" by whatever cell moved to that address).

Plus some additional unit tests for the ReferenceHelper.

Author: Mark Baker

CHANGELOG.md

@@ -39,6 +39,7 @@ and this project adheres to [Semantic Versioning](https://semver.org).
 
 ### Fixed
 
+- Fix bug when deleting cells with hyperlinks, where the hyperlink was then being "inherited" by whatever cell moved to that cell address.
 - Fix bug in Conditional Formatting in the Xls Writer that resulted in a broken file when there were multiple conditional ranges in a worksheet.
 - Fix Conditional Formatting in the Xls Writer to work with rules that contain string literals, cell references and formulae.
 - Fix for setting Active Sheet to the first loaded worksheet when bookViews element isn't defined [Issue #2666](https://github.com/PHPOffice/PhpSpreadsheet/issues/2666) [PR #2669](https://github.com/PHPOffice/PhpSpreadsheet/pull/2669)

phpstan-baseline.neon

@@ -3165,31 +3165,11 @@ parameters:
 			count: 1
 			path: src/PhpSpreadsheet/ReferenceHelper.php
 
-		-
-			message: "#^Parameter \\#1 \\$index of method PhpOffice\\\\PhpSpreadsheet\\\\Worksheet\\\\RowDimension\\:\\:setRowIndex\\(\\) expects int, string given\\.$#"
-			count: 1
-			path: src/PhpSpreadsheet/ReferenceHelper.php
-
-		-
-			message: "#^Parameter \\#2 \\$callback of function uksort expects callable\\(\\(int\\|string\\), \\(int\\|string\\)\\)\\: int, array\\{'self', 'cellReverseSort'\\} given\\.$#"
-			count: 4
-			path: src/PhpSpreadsheet/ReferenceHelper.php
-
-		-
-			message: "#^Parameter \\#2 \\$callback of function uksort expects callable\\(\\(int\\|string\\), \\(int\\|string\\)\\)\\: int, array\\{'self', 'cellSort'\\} given\\.$#"
-			count: 4
-			path: src/PhpSpreadsheet/ReferenceHelper.php
-
 		-
 			message: "#^Parameter \\#3 \\$subject of function str_replace expects array\\|string, string\\|null given\\.$#"
 			count: 1
 			path: src/PhpSpreadsheet/ReferenceHelper.php
 
-		-
-			message: "#^Static property PhpOffice\\\\PhpSpreadsheet\\\\ReferenceHelper\\:\\:\\$instance \\(PhpOffice\\\\PhpSpreadsheet\\\\ReferenceHelper\\) in isset\\(\\) is not nullable\\.$#"
-			count: 1
-			path: src/PhpSpreadsheet/ReferenceHelper.php
-
 		-
 			message: "#^Property PhpOffice\\\\PhpSpreadsheet\\\\RichText\\\\Run\\:\\:\\$font \\(PhpOffice\\\\PhpSpreadsheet\\\\Style\\\\Font\\) does not accept PhpOffice\\\\PhpSpreadsheet\\\\Style\\\\Font\\|null\\.$#"
 			count: 1

src/PhpSpreadsheet/CellReferenceHelper.php

@@ -0,0 +1,103 @@
+<?php
+
+namespace PhpOffice\PhpSpreadsheet;
+
+use PhpOffice\PhpSpreadsheet\Cell\Coordinate;
+
+class CellReferenceHelper
+{
+    /**
+     * @var string
+     */
+    protected $beforeCellAddress;
+
+    /**
+     * @var int
+     */
+    protected $beforeColumn;
+
+    /**
+     * @var int
+     */
+    protected $beforeRow;
+
+    /**
+     * @var int
+     */
+    protected $numberOfColumns;
+
+    /**
+     * @var int
+     */
+    protected $numberOfRows;
+
+    public function __construct(string $beforeCellAddress = 'A1', int $numberOfColumns = 0, int $numberOfRows = 0)
+    {
+        $this->beforeCellAddress = str_replace('$', '', $beforeCellAddress);
+        $this->numberOfColumns = $numberOfColumns;
+        $this->numberOfRows = $numberOfRows;
+
+        // Get coordinate of $beforeCellAddress
+        [$beforeColumn, $beforeRow] = Coordinate::coordinateFromString($beforeCellAddress);
+        $this->beforeColumn = (int) Coordinate::columnIndexFromString($beforeColumn);
+        $this->beforeRow = (int) $beforeRow;
+    }
+
+    public function refreshRequired(string $beforeCellAddress, int $numberOfColumns, int $numberOfRows): bool
+    {
+        return $this->beforeCellAddress !== $beforeCellAddress ||
+            $this->numberOfColumns !== $numberOfColumns ||
+            $this->numberOfRows !== $numberOfRows;
+    }
+
+    public function updateCellReference(string $cellReference = 'A1'): string
+    {
+        if (Coordinate::coordinateIsRange($cellReference)) {
+            throw new Exception('Only single cell references may be passed to this method.');
+        }
+
+        // Get coordinate of $cellReference
+        [$newColumn, $newRow] = Coordinate::coordinateFromString($cellReference);
+        $newColumnIndex = (int) Coordinate::columnIndexFromString(str_replace('$', '', $newColumn));
+        $newRowIndex = (int) str_replace('$', '', $newRow);
+
+        // Verify which parts should be updated
+        $updateColumn = (($newColumn[0] !== '$') && $newColumnIndex >= $this->beforeColumn);
+        $updateRow = (($newRow[0] !== '$') && $newRow >= $this->beforeRow);
+
+        // Create new column reference
+        if ($updateColumn) {
+            $newColumn = Coordinate::stringFromColumnIndex($newColumnIndex + $this->numberOfColumns);
+        }
+
+        // Create new row reference
+        if ($updateRow) {
+            $newRow = $newRowIndex + $this->numberOfRows;
+        }
+
+        // Return new reference
+        return "{$newColumn}{$newRow}";
+    }
+
+    public function cellAddressInDeleteRange(string $cellAddress): bool
+    {
+        [$cellColumn, $cellRow] = Coordinate::coordinateFromString($cellAddress);
+        $cellColumnIndex = Coordinate::columnIndexFromString($cellColumn);
+        //    Is cell within the range of rows/columns if we're deleting
+        if (
+            $this->numberOfRows < 0 &&
+            ($cellRow >= ($this->beforeRow + $this->numberOfRows)) &&
+            ($cellRow < $this->beforeRow)
+        ) {
+            return true;
+        } elseif (
+            $this->numberOfColumns < 0 &&
+            ($cellColumnIndex >= ($this->beforeColumn + $this->numberOfColumns)) &&
+            ($cellColumnIndex < $this->beforeColumn)
+        ) {
+            return true;
+        }
+
+        return false;
+    }
+}