Merge pull request #4562 from oleibman/issue4557date

oleibman · web-flow · commit ea97afb754d0 · 2025-08-06T07:16:44.000Z
Shared/Date::isDateTime Handle Cells Which Calculate as Arrays
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -36,9 +36,8 @@ and this project adheres to [Semantic Versioning](https://semver.org). Thia is a
 
 ### Fixed
 
-- Xlsx Writer eliminate xml:space from non-text nodes. [Issue #4542](https://github.com/PHPOffice/PhpSpreadsheet/issues/4542) [PR #4556](https://github.com/PHPOffice/PhpSpreadsheet/pull/4556)
-
-## 2025-07-23 - 4.5.0
+- Shared/Date::isDateTime handle cells which calculate as arrays. [Issue #4557](https://github.com/PHPOffice/PhpSpreadsheet/issues/4557) [PR #4562](https://github.com/PHPOffice/PhpSpreadsheet/pull/4562)
+- Xlsx Writer eliminate xml:space from non-text nodes. [Issue #4542](https://github.com/PHPOffice/PhpSpreadsheet/issues/4542) [PR #4556](https://github.com/PHPOffice/PhpSpreadsheet/pull/4556)## 2025-07-23 - 4.5.0
 
 ### Added
 
diff --git a/src/PhpSpreadsheet/Calculation/Calculation.php b/src/PhpSpreadsheet/Calculation/Calculation.php
@@ -207,10 +207,7 @@ public function __construct(?Spreadsheet $spreadsheet = null)
     public static function getInstance(?Spreadsheet $spreadsheet = null): self
     {
         if ($spreadsheet !== null) {
-            $instance = $spreadsheet->getCalculationEngine();
-            if (isset($instance)) {
-                return $instance;
-            }
+            return $spreadsheet->getCalculationEngine();
         }
 
         if (!self::$instance) {
@@ -220,6 +217,20 @@ public static function getInstance(?Spreadsheet $spreadsheet = null): self
         return self::$instance;
     }
 
+    /**
+     * Intended for use only via a destructor.
+     *
+     * @internal
+     */
+    public static function getInstanceOrNull(?Spreadsheet $spreadsheet = null): ?self
+    {
+        if ($spreadsheet !== null) {
+            return $spreadsheet->getCalculationEngineOrNull();
+        }
+
+        return null;
+    }
+
     /**
      * Flush the calculation cache for any existing instance of this class
      *        but only if a Calculation instance exists.
diff --git a/src/PhpSpreadsheet/Reader/Xlsx.php b/src/PhpSpreadsheet/Reader/Xlsx.php
@@ -2,7 +2,6 @@
 
 namespace PhpOffice\PhpSpreadsheet\Reader;
 
-use PhpOffice\PhpSpreadsheet\Calculation\Calculation;
 use PhpOffice\PhpSpreadsheet\Calculation\Information\ExcelError;
 use PhpOffice\PhpSpreadsheet\Cell\Coordinate;
 use PhpOffice\PhpSpreadsheet\Cell\DataType;
@@ -452,10 +451,7 @@ protected function loadSpreadsheetFromFile(string $filename): Spreadsheet
             switch ($rel['Type']) {
                 case "$xmlNamespaceBase/sheetMetadata":
                     if ($this->fileExistsInArchive($zip, "xl/{$relTarget}")) {
-                        $excel->getCalculationEngine()
-                            ?->setInstanceArrayReturnType(
-                                Calculation::RETURN_ARRAY_AS_ARRAY
-                            );
+                        $excel->returnArrayAsArray();
                     }
 
                     break;
diff --git a/src/PhpSpreadsheet/Shared/Date.php b/src/PhpSpreadsheet/Shared/Date.php
@@ -172,10 +172,7 @@ public static function convertIsoDate(mixed $value): float|int
             throw new Exception("Invalid string $value supplied for datatype Date");
         }
 
-        $newValue = self::PHPToExcel($date);
-        if ($newValue === false) {
-            throw new Exception("Invalid string $value supplied for datatype Date");
-        }
+        $newValue = self::dateTimeToExcel($date);
 
         if (preg_match('/^\s*\d?\d:\d\d(:\d\d([.]\d+)?)?\s*(am|pm)?\s*$/i', $value) == 1) {
             $newValue = fmod($newValue, 1.0);
@@ -374,7 +371,12 @@ public static function isDateTime(Cell $cell, mixed $value = null, bool $dateWit
             $selected = $worksheet->getSelectedCells();
 
             try {
-                $result = is_numeric($value ?? $cell->getCalculatedValue())
+                if ($value === null) {
+                    $value = Functions::flattenSingleValue(
+                        $cell->getCalculatedValue()
+                    );
+                }
+                $result = is_numeric($value)
                     && self::isDateTimeFormat(
                         $worksheet->getStyle(
                             $cell->getCoordinate()
diff --git a/src/PhpSpreadsheet/Spreadsheet.php b/src/PhpSpreadsheet/Spreadsheet.php
@@ -58,7 +58,7 @@ class Spreadsheet implements JsonSerializable
     /**
      * Calculation Engine.
      */
-    private ?Calculation $calculationEngine;
+    private Calculation $calculationEngine;
 
     /**
      * Active sheet index.
@@ -477,7 +477,7 @@ public function __construct()
     public function __destruct()
     {
         $this->disconnectWorksheets();
-        $this->calculationEngine = null;
+        unset($this->calculationEngine);
         $this->cellXfCollection = [];
         $this->cellStyleXfCollection = [];
         $this->definedNames = [];
@@ -499,11 +499,25 @@ public function disconnectWorksheets(): void
     /**
      * Return the calculation engine for this worksheet.
      */
-    public function getCalculationEngine(): ?Calculation
+    public function getCalculationEngine(): Calculation
     {
         return $this->calculationEngine;
     }
 
+    /**
+     * Intended for use only via a destructor.
+     *
+     * @internal
+     */
+    public function getCalculationEngineOrNull(): ?Calculation
+    {
+        if (!isset($this->calculationEngine)) { //* @phpstan-ignore-line
+            return null;
+        }
+
+        return $this->calculationEngine;
+    }
+
     /**
      * Get properties.
      */
@@ -1120,21 +1134,19 @@ public function __clone()
 
         $oldCalc = $this->calculationEngine;
         $this->calculationEngine = new Calculation($this);
-        if ($oldCalc !== null) {
-            $this->calculationEngine
-                ->setSuppressFormulaErrors(
-                    $oldCalc->getSuppressFormulaErrors()
-                )
-                ->setCalculationCacheEnabled(
-                    $oldCalc->getCalculationCacheEnabled()
-                )
-                ->setBranchPruningEnabled(
-                    $oldCalc->getBranchPruningEnabled()
-                )
-                ->setInstanceArrayReturnType(
-                    $oldCalc->getInstanceArrayReturnType()
-                );
-        }
+        $this->calculationEngine
+            ->setSuppressFormulaErrors(
+                $oldCalc->getSuppressFormulaErrors()
+            )
+            ->setCalculationCacheEnabled(
+                $oldCalc->getCalculationCacheEnabled()
+            )
+            ->setBranchPruningEnabled(
+                $oldCalc->getBranchPruningEnabled()
+            )
+            ->setInstanceArrayReturnType(
+                $oldCalc->getInstanceArrayReturnType()
+            );
         $usedKeys['calculationEngine'] = true;
 
         $currentCollection = $this->cellStyleXfCollection;
@@ -1801,4 +1813,18 @@ public function replaceBuiltinNumberFormat(int $builtinFormatIndex, string $form
             }
         }
     }
+
+    public function returnArrayAsArray(): void
+    {
+        $this->calculationEngine->setInstanceArrayReturnType(
+            Calculation::RETURN_ARRAY_AS_ARRAY
+        );
+    }
+
+    public function returnArrayAsValue(): void
+    {
+        $this->calculationEngine->setInstanceArrayReturnType(
+            Calculation::RETURN_ARRAY_AS_VALUE
+        );
+    }
 }
diff --git a/src/PhpSpreadsheet/Worksheet/Worksheet.php b/src/PhpSpreadsheet/Worksheet/Worksheet.php
@@ -373,7 +373,8 @@ public function disconnectCells(): void
      */
     public function __destruct()
     {
-        Calculation::getInstance($this->parent)->clearCalculationCacheForWorksheet($this->title);
+        Calculation::getInstanceOrNull($this->parent)
+            ?->clearCalculationCacheForWorksheet($this->title);
 
         $this->disconnectCells();
         unset($this->rowDimensions, $this->columnDimensions, $this->tableCollection, $this->drawingCollection, $this->chartCollection, $this->autoFilter);
@@ -909,7 +910,7 @@ public function setTitle(string $title, bool $updateFormulaCellReferences = true
         // Set title
         $this->title = $title;
 
-        if ($this->parent && $this->parent->getIndex($this, true) >= 0 && $this->parent->getCalculationEngine()) {
+        if ($this->parent && $this->parent->getIndex($this, true) >= 0) {
             // New title
             $newTitle = $this->getTitle();
             $this->parent->getCalculationEngine()
diff --git a/tests/PhpSpreadsheetTests/Calculation/StructuredReferenceFormulaTest.php b/tests/PhpSpreadsheetTests/Calculation/StructuredReferenceFormulaTest.php
@@ -39,7 +39,7 @@ public function testStructuredReferenceHiddenHeaders(): void
         $result = $spreadsheet->getActiveSheet()->getCell($cellAddress)->getCalculatedValue();
         self::assertSame('Region', $result);
 
-        $spreadsheet->getCalculationEngine()?->flushInstance();
+        $spreadsheet->getCalculationEngine()->flushInstance();
         $table->setShowHeaderRow(false);
 
         $result = $spreadsheet->getActiveSheet()->getCell($cellAddress)->getCalculatedValue();
diff --git a/tests/PhpSpreadsheetTests/Reader/Ods/DefinedNamesTest.php b/tests/PhpSpreadsheetTests/Reader/Ods/DefinedNamesTest.php
@@ -4,7 +4,6 @@
 
 namespace PhpOffice\PhpSpreadsheetTests\Reader\Ods;
 
-use PhpOffice\PhpSpreadsheet\Calculation\Calculation;
 use PhpOffice\PhpSpreadsheet\Reader\Ods;
 use PHPUnit\Framework\TestCase;
 
@@ -15,10 +14,7 @@ public function testDefinedNamesValue(): void
         $filename = 'tests/data/Reader/Ods/DefinedNames.ods';
         $reader = new Ods();
         $spreadsheet = $reader->load($filename);
-        $calculation = Calculation::getInstance($spreadsheet);
-        $calculation->setInstanceArrayReturnType(
-            Calculation::RETURN_ARRAY_AS_VALUE
-        );
+        $spreadsheet->returnArrayAsValue();
         $worksheet = $spreadsheet->getActiveSheet();
 
         $firstDefinedNameValue = $worksheet->getCell('First')->getValue();
@@ -36,10 +32,7 @@ public function testDefinedNamesApostropheValue(): void
         $filename = 'tests/data/Reader/Ods/DefinedNames.apostrophe.ods';
         $reader = new Ods();
         $spreadsheet = $reader->load($filename);
-        $calculation = Calculation::getInstance($spreadsheet);
-        $calculation->setInstanceArrayReturnType(
-            Calculation::RETURN_ARRAY_AS_VALUE
-        );
+        $spreadsheet->returnArrayAsValue();
         $worksheet = $spreadsheet->getActiveSheet();
         self::assertSame("apo'strophe", $worksheet->getTitle());
 
@@ -58,10 +51,7 @@ public function testDefinedNamesArray(): void
         $filename = 'tests/data/Reader/Ods/DefinedNames.ods';
         $reader = new Ods();
         $spreadsheet = $reader->load($filename);
-        $calculation = Calculation::getInstance($spreadsheet);
-        $calculation->setInstanceArrayReturnType(
-            Calculation::RETURN_ARRAY_AS_ARRAY
-        );
+        $spreadsheet->returnArrayAsArray();
         $worksheet = $spreadsheet->getActiveSheet();
 
         $firstDefinedNameValue = $worksheet->getCell('First')->getValue();
diff --git a/tests/PhpSpreadsheetTests/Shared/DateTest.php b/tests/PhpSpreadsheetTests/Shared/DateTest.php
@@ -11,6 +11,7 @@
 use PhpOffice\PhpSpreadsheet\Shared\Date;
 use PhpOffice\PhpSpreadsheet\Spreadsheet;
 use PhpOffice\PhpSpreadsheet\Style\NumberFormat;
+use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\TestCase;
 
 class DateTest extends TestCase
@@ -38,10 +39,15 @@ public function testSetExcelCalendar(): void
             Date::CALENDAR_WINDOWS_1900,
         ];
 
+        $spreadsheet = new Spreadsheet();
         foreach ($calendarValues as $calendarValue) {
             $result = Date::setExcelCalendar($calendarValue);
             self::assertTrue($result);
+            $result = $spreadsheet->setExcelCalendar($calendarValue);
+            self::assertTrue($result);
         }
+        self::assertFalse($spreadsheet->setExcelCalendar(0));
+        $spreadsheet->disconnectWorksheets();
     }
 
     public function testSetExcelCalendarWithInvalidValue(): void
@@ -51,7 +57,7 @@ public function testSetExcelCalendarWithInvalidValue(): void
         self::assertFalse($result);
     }
 
-    #[\PHPUnit\Framework\Attributes\DataProvider('providerDateTimeExcelToTimestamp1900')]
+    #[DataProvider('providerDateTimeExcelToTimestamp1900')]
     public function testDateTimeExcelToTimestamp1900(float|int $expectedResult, float|int $excelDateTimeValue): void
     {
         if ($expectedResult > PHP_INT_MAX || $expectedResult < PHP_INT_MIN) {
@@ -68,7 +74,7 @@ public static function providerDateTimeExcelToTimestamp1900(): array
         return require 'tests/data/Shared/Date/ExcelToTimestamp1900.php';
     }
 
-    #[\PHPUnit\Framework\Attributes\DataProvider('providerDateTimeTimestampToExcel1900')]
+    #[DataProvider('providerDateTimeTimestampToExcel1900')]
     public function testDateTimeTimestampToExcel1900(float|int $expectedResult, float|int|string $unixTimestamp): void
     {
         Date::setExcelCalendar(Date::CALENDAR_WINDOWS_1900);
@@ -82,7 +88,7 @@ public static function providerDateTimeTimestampToExcel1900(): array
         return require 'tests/data/Shared/Date/TimestampToExcel1900.php';
     }
 
-    #[\PHPUnit\Framework\Attributes\DataProvider('providerDateTimeDateTimeToExcel')]
+    #[DataProvider('providerDateTimeDateTimeToExcel')]
     public function testDateTimeDateTimeToExcel(float|int $expectedResult, DateTimeInterface $dateTimeObject): void
     {
         Date::setExcelCalendar(Date::CALENDAR_WINDOWS_1900);
@@ -99,7 +105,7 @@ public static function providerDateTimeDateTimeToExcel(): array
     /**
      * @param array{0: int, 1: int, 2: int, 3: int, 4: int, 5: float|int} $args Array containing year/month/day/hours/minutes/seconds
      */
-    #[\PHPUnit\Framework\Attributes\DataProvider('providerDateTimeFormattedPHPToExcel1900')]
+    #[DataProvider('providerDateTimeFormattedPHPToExcel1900')]
     public function testDateTimeFormattedPHPToExcel1900(mixed $expectedResult, ...$args): void
     {
         Date::setExcelCalendar(Date::CALENDAR_WINDOWS_1900);
@@ -113,7 +119,7 @@ public static function providerDateTimeFormattedPHPToExcel1900(): array
         return require 'tests/data/Shared/Date/FormattedPHPToExcel1900.php';
     }
 
-    #[\PHPUnit\Framework\Attributes\DataProvider('providerDateTimeExcelToTimestamp1904')]
+    #[DataProvider('providerDateTimeExcelToTimestamp1904')]
     public function testDateTimeExcelToTimestamp1904(float|int $expectedResult, float|int $excelDateTimeValue): void
     {
         if ($expectedResult > PHP_INT_MAX || $expectedResult < PHP_INT_MIN) {
@@ -130,7 +136,7 @@ public static function providerDateTimeExcelToTimestamp1904(): array
         return require 'tests/data/Shared/Date/ExcelToTimestamp1904.php';
     }
 
-    #[\PHPUnit\Framework\Attributes\DataProvider('providerDateTimeTimestampToExcel1904')]
+    #[DataProvider('providerDateTimeTimestampToExcel1904')]
     public function testDateTimeTimestampToExcel1904(mixed $expectedResult, float|int|string $unixTimestamp): void
     {
         Date::setExcelCalendar(Date::CALENDAR_MAC_1904);
@@ -144,7 +150,7 @@ public static function providerDateTimeTimestampToExcel1904(): array
         return require 'tests/data/Shared/Date/TimestampToExcel1904.php';
     }
 
-    #[\PHPUnit\Framework\Attributes\DataProvider('providerIsDateTimeFormatCode')]
+    #[DataProvider('providerIsDateTimeFormatCode')]
     public function testIsDateTimeFormatCode(mixed $expectedResult, string $format): void
     {
         $result = Date::isDateTimeFormatCode($format);
@@ -156,7 +162,7 @@ public static function providerIsDateTimeFormatCode(): array
         return require 'tests/data/Shared/Date/FormatCodes.php';
     }
 
-    #[\PHPUnit\Framework\Attributes\DataProvider('providerDateTimeExcelToTimestamp1900Timezone')]
+    #[DataProvider('providerDateTimeExcelToTimestamp1900Timezone')]
     public function testDateTimeExcelToTimestamp1900Timezone(float|int $expectedResult, float|int $excelDateTimeValue, string $timezone): void
     {
         if ($expectedResult > PHP_INT_MAX || $expectedResult < PHP_INT_MIN) {
@@ -198,6 +204,9 @@ public function testVarious(): void
 
         $date = Date::PHPToExcel('2020-01-01');
         self::assertEquals(43831.0, $date);
+        $phpDate = new DateTime('2020-01-02T00:00Z');
+        $date = Date::PHPToExcel($phpDate);
+        self::assertEquals(43832.0, $date);
 
         $spreadsheet = new Spreadsheet();
         $sheet = $spreadsheet->getActiveSheet();
@@ -240,6 +249,27 @@ public function testVarious(): void
         $spreadsheet->disconnectWorksheets();
     }
 
+    public function testArray(): void
+    {
+        $spreadsheet = new Spreadsheet();
+        $spreadsheet->returnArrayAsArray();
+        $sheet = $spreadsheet->getActiveSheet();
+        $sheet->setCellValue('A1', 45000);
+        $sheet->setCellValue('A2', 44000);
+        $sheet->setCellValue('A3', 46000);
+        $sheet->setCellValue('C1', '=SORT(A1:A3)');
+        $sheet->setCellValue('D1', '=SORT(A1:A3)');
+        $sheet->getStyle('C1')
+            ->getNumberFormat()
+            ->setFormatCode('yyyy-mm-dd');
+        self::assertTrue(Date::isDateTime($sheet->getCell('C1')));
+        self::assertFalse(Date::isDateTime($sheet->getCell('D1')));
+        self::assertIsArray(
+            $sheet->getCell('C1')->getCalculatedValue()
+        );
+        $spreadsheet->disconnectWorksheets();
+    }
+
     public function testRoundMicroseconds(): void
     {
         $dti = new DateTime('2000-01-02 03:04:05.999999');
diff --git a/tests/PhpSpreadsheetTests/SpreadsheetCopyCloneTest.php b/tests/PhpSpreadsheetTests/SpreadsheetCopyCloneTest.php
