Merge pull request #4419 from oleibman/clonetweak

Tweak to Spreadsheet Clone

Author: oleibman

CHANGELOG.md

@@ -37,6 +37,7 @@ and this project adheres to [Semantic Versioning](https://semver.org).
 - Ignore fractional part of Drawing Shadow Alpha. [Issue #4415](https://github.com/PHPOffice/PhpSpreadsheet/issues/4415) [PR #4417](https://github.com/PHPOffice/PhpSpreadsheet/pull/4417)
 - BIN2DEC, OCT2DEC, and HEX2DEC return numbers rather than strings. [Issue #4383](https://github.com/PHPOffice/PhpSpreadsheet/issues/4383) [PR #4389](https://github.com/PHPOffice/PhpSpreadsheet/pull/4389)
 - Fix TREND_BEST_FIT_NO_POLY. [Issue #4400](https://github.com/PHPOffice/PhpSpreadsheet/issues/4400) [PR #4339](https://github.com/PHPOffice/PhpSpreadsheet/pull/4339)
+- Tweak Spreadsheet clone. [PR #4419](https://github.com/PHPOffice/PhpSpreadsheet/pull/4419)
 - Better handling of Chart DisplayBlanksAs. [Issue #4411](https://github.com/PHPOffice/PhpSpreadsheet/issues/4411) [PR #4414](https://github.com/PHPOffice/PhpSpreadsheet/pull/4414)
 
 ## 2025-03-02 - 4.1.0

src/PhpSpreadsheet/Calculation/Calculation.php

@@ -315,10 +315,12 @@ public function getCalculationCacheEnabled(): bool
     /**
      * Enable/disable calculation cache.
      */
-    public function setCalculationCacheEnabled(bool $calculationCacheEnabled): void
+    public function setCalculationCacheEnabled(bool $calculationCacheEnabled): self
     {
         $this->calculationCacheEnabled = $calculationCacheEnabled;
         $this->clearCalculationCache();
+
+        return $this;
     }
 
     /**
@@ -366,13 +368,17 @@ public function renameCalculationCacheForWorksheet(string $fromWorksheetName, st
         }
     }
 
-    /**
-     * Enable/disable calculation cache.
-     */
-    public function setBranchPruningEnabled(mixed $enabled): void
+    public function getBranchPruningEnabled(): bool
+    {
+        return $this->branchPruningEnabled;
+    }
+
+    public function setBranchPruningEnabled(mixed $enabled): self
     {
         $this->branchPruningEnabled = (bool) $enabled;
         $this->branchPruner = new BranchPruner($this->branchPruningEnabled);
+
+        return $this;
     }
 
     public function enableBranchPruning(): void
@@ -2712,9 +2718,11 @@ private function evaluateDefinedName(Cell $cell, DefinedName $namedRange, Worksh
         return $result;
     }
 
-    public function setSuppressFormulaErrors(bool $suppressFormulaErrors): void
+    public function setSuppressFormulaErrors(bool $suppressFormulaErrors): self
     {
         $this->suppressFormulaErrors = $suppressFormulaErrors;
+
+        return $this;
     }
 
     public function getSuppressFormulaErrors(): bool
@@ -2757,4 +2765,9 @@ private static function swapOperands(Stack $stack, string $opCharacter): bool
 
         return $retVal;
     }
+
+    public function getSpreadsheet(): ?Spreadsheet
+    {
+        return $this->spreadsheet;
+    }
 }

src/PhpSpreadsheet/Spreadsheet.php

@@ -1079,6 +1079,15 @@ public function __clone()
         $this->calculationEngine = new Calculation($this);
         if ($oldCalc !== null) {
             $this->calculationEngine
+                ->setSuppressFormulaErrors(
+                    $oldCalc->getSuppressFormulaErrors()
+                )
+                ->setCalculationCacheEnabled(
+                    $oldCalc->getCalculationCacheEnabled()
+                )
+                ->setBranchPruningEnabled(
+                    $oldCalc->getBranchPruningEnabled()
+                )
                 ->setInstanceArrayReturnType(
                     $oldCalc->getInstanceArrayReturnType()
                 );

tests/PhpSpreadsheetTests/SpreadsheetCopyCloneTest.php

@@ -49,6 +49,8 @@ public function testCopyClone(string $type): void
         } else {
             $this->spreadsheet2 = clone $this->spreadsheet;
         }
+        self::assertSame($this->spreadsheet, $this->spreadsheet->getCalculationEngine()?->getSpreadsheet());
+        self::assertSame($this->spreadsheet2, $this->spreadsheet2->getCalculationEngine()?->getSpreadsheet());
         self::assertSame('A3', $sheet->getSelectedCells());
         $copysheet = $this->spreadsheet2->getActiveSheet();
         self::assertSame('A3', $copysheet->getSelectedCells());
@@ -112,4 +114,39 @@ public static function providerCopyClone(): array
             ['clone'],
         ];
     }
+
+    public static function providerCopyClone2(): array
+    {
+        return [
+            ['copy', true, false, true, 'array'],
+            ['clone', true, false, true, 'array'],
+            ['copy', false, true, false, 'value'],
+            ['clone', false, true, false, 'value'],
+            ['copy', false, true, true, 'error'],
+            ['clone', false, true, true, 'error'],
+        ];
+    }
+
+    #[DataProvider('providerCopyClone2')]
+    public function testCopyClone2(string $type, bool $suppress, bool $cache, bool $pruning, string $return): void
+    {
+        $this->spreadsheet = new Spreadsheet();
+        $calc = $this->spreadsheet->getCalculationEngine();
+        self::assertNotNull($calc);
+        $calc->setSuppressFormulaErrors($suppress);
+        $calc->setCalculationCacheEnabled($cache);
+        $calc->setBranchPruningEnabled($pruning);
+        $calc->setInstanceArrayReturnType($return);
+        if ($type === 'copy') {
+            $this->spreadsheet2 = $this->spreadsheet->copy();
+        } else {
+            $this->spreadsheet2 = clone $this->spreadsheet;
+        }
+        $calc2 = $this->spreadsheet2->getCalculationEngine();
+        self::assertNotNull($calc2);
+        self::assertSame($suppress, $calc2->getSuppressFormulaErrors());
+        self::assertSame($cache, $calc2->getCalculationCacheEnabled());
+        self::assertSame($pruning, $calc2->getBranchPruningEnabled());
+        self::assertSame($return, $calc2->getInstanceArrayReturnType());
+    }
 }