Merge branch 'master' into issue4375

Author: oleibman

CHANGELOG.md

@@ -9,15 +9,17 @@ and this project adheres to [Semantic Versioning](https://semver.org).
 
 ### Added
 
-- Nothing yet.
+- Allow Spreadsheet clone. [PR #437-](https://github.com/PHPOffice/PhpSpreadsheet/pull/4370)
 
 ### Removed
 
 - Nothing yet.
 
 ### Changed
 
+- ListWorksheetInfo will now return sheetState (visible, hidden, veryHidden). [Issue #4345](https://github.com/PHPOffice/PhpSpreadsheet/issues/4345) [PR #4366](https://github.com/PHPOffice/PhpSpreadsheet/pull/4366)
 - Start migration to Phpstan 2. [PR #4359](https://github.com/PHPOffice/PhpSpreadsheet/pull/4359)
+- IOFactory identify can return, and createReader and CreateWriter can accept, a class name rather than a file type. [Issue #4357](https://github.com/PHPOffice/PhpSpreadsheet/issues/4357) [PR #4361](https://github.com/PHPOffice/PhpSpreadsheet/pull/4361)
 
 ### Moved
 
@@ -31,6 +33,7 @@ and this project adheres to [Semantic Versioning](https://semver.org).
 
 - Refactor Helper/Html. [PR #4359](https://github.com/PHPOffice/PhpSpreadsheet/pull/4359)
 - Ignore ignoredErrors when not applicable. [Issue #4375](https://github.com/PHPOffice/PhpSpreadsheet/issues/4375) [PR #4377](https://github.com/PHPOffice/PhpSpreadsheet/pull/4377)
+- Better handling of defined names on sheets whose titles include apostrophes. [Issue #4356](https://github.com/PHPOffice/PhpSpreadsheet/issues/4356) [Issue #4362](https://github.com/PHPOffice/PhpSpreadsheet/issues/4362) [Issue #4376](https://github.com/PHPOffice/PhpSpreadsheet/issues/4376) [PR #4360](https://github.com/PHPOffice/PhpSpreadsheet/pull/4360)
 
 ## 2025-02-08 - 4.0.0
 

docs/topics/reading-files.md

@@ -123,7 +123,10 @@ method to identify the reader that you need, before using the
 ```php
 $inputFileName = './sampleData/example1.xls';
 
-/**  Identify the type of $inputFileName  **/
+/**
+ * Identify the type of $inputFileName.
+ * See below for a possible improvement for release 4.1.0+.
+ */
 $inputFileType = \PhpOffice\PhpSpreadsheet\IOFactory::identify($inputFileName);
 /**  Create a new Reader of the type that has been identified  **/
 $reader = \PhpOffice\PhpSpreadsheet\IOFactory::createReader($inputFileType);
@@ -134,6 +137,13 @@ $spreadsheet = $reader->load($inputFileName);
 See `samples/Reader/04_Simple_file_reader_using_the_IOFactory_to_identify_a_reader_to_use.php`
 for a working example of this code.
 
+Prior to release 4.1.0, `identify` returns a file type.
+It may be more useful to return a fully-qualified class name,
+which can be accomplished using a parameter introduced in 4.1.0:
+```php
+$inputFileType = \PhpOffice\PhpSpreadsheet\IOFactory::identify($inputFileName, null, true);
+```
+
 As with the IOFactory `load()` method, you can also pass an array of formats
 for  the `identify()` method to check against if you know that it will only
 be in a subset of the possible formats that PhpSpreadsheet supports.

phpstan-baseline.neon

@@ -4408,7 +4408,9 @@ private function internalParseFormula(string $formula, ?Cell $cell = null): bool
                             if ($rangeWS1 !== '') {
                                 $rangeWS1 .= '!';
                             }
-                            $rangeSheetRef = trim($rangeSheetRef, "'");
+                            if (str_starts_with($rangeSheetRef, "'")) {
+                                $rangeSheetRef = Worksheet::unApostrophizeTitle($rangeSheetRef);
+                            }
                             [$rangeWS2, $val] = Worksheet::extractSheetTitle($val, true);
                             if ($rangeWS2 !== '') {
                                 $rangeWS2 .= '!';
@@ -4424,11 +4426,10 @@ private function internalParseFormula(string $formula, ?Cell $cell = null): bool
                             if (ctype_digit($val) && $val <= 1048576) {
                                 //    Row range
                                 $stackItemType = 'Row Reference';
-                                /** @var int $valx */
                                 $valx = $val;
                                 $endRowColRef = ($refSheet !== null) ? $refSheet->getHighestDataColumn($valx) : AddressRange::MAX_COLUMN; //    Max 16,384 columns for Excel2007
                                 $val = "{$rangeWS2}{$endRowColRef}{$val}";
-                            } elseif (ctype_alpha($val) && is_string($val) && strlen($val) <= 3) {
+                            } elseif (ctype_alpha($val) && strlen($val) <= 3) {
                                 //    Column range
                                 $stackItemType = 'Column Reference';
                                 $endRowColRef = ($refSheet !== null) ? $refSheet->getHighestDataRow($val) : AddressRange::MAX_ROW; //    Max 1,048,576 rows for Excel2007
@@ -4562,7 +4563,7 @@ private function internalParseFormula(string $formula, ?Cell $cell = null): bool
 
         while (($op = $stack->pop()) !== null) {
             // pop everything off the stack and push onto output
-            if ((is_array($op) && $op['value'] == '(')) {
+            if ($op['value'] == '(') {
                 return $this->raiseFormulaError("Formula Error: Expecting ')'"); // if there are any opening braces on the stack, then braces were unbalanced
             }
             $output[] = $op;
@@ -4766,18 +4767,18 @@ private function processTokenStack(mixed $tokens, ?string $cellID = null, ?Cell
                             }
                         }
                         if (str_contains($operand1Data['reference'] ?? '', '!')) {
-                            [$sheet1, $operand1Data['reference']] = Worksheet::extractSheetTitle($operand1Data['reference'], true);
+                            [$sheet1, $operand1Data['reference']] = Worksheet::extractSheetTitle($operand1Data['reference'], true, true);
                         } else {
                             $sheet1 = ($pCellWorksheet !== null) ? $pCellWorksheet->getTitle() : '';
                         }
                         $sheet1 ??= '';
 
-                        [$sheet2, $operand2Data['reference']] = Worksheet::extractSheetTitle($operand2Data['reference'], true);
+                        [$sheet2, $operand2Data['reference']] = Worksheet::extractSheetTitle($operand2Data['reference'], true, true);
                         if (empty($sheet2)) {
                             $sheet2 = $sheet1;
                         }
 
-                        if (trim($sheet1, "'") === trim($sheet2, "'")) {
+                        if ($sheet1 === $sheet2) {
                             if ($operand1Data['reference'] === null && $cell !== null) {
                                 if (is_array($operand1Data['value'])) {
                                     $operand1Data['reference'] = $cell->getCoordinate();
@@ -4819,7 +4820,7 @@ private function processTokenStack(mixed $tokens, ?string $cellID = null, ?Cell
                             if ($breakNeeded) {
                                 break;
                             }
-                            $cellRef = Coordinate::stringFromColumnIndex(min($oCol) + 1) . min($oRow) . ':' . Coordinate::stringFromColumnIndex(max($oCol) + 1) . max($oRow);
+                            $cellRef = Coordinate::stringFromColumnIndex(min($oCol) + 1) . min($oRow) . ':' . Coordinate::stringFromColumnIndex(max($oCol) + 1) . max($oRow); // @phpstan-ignore-line
                             if ($pCellParent !== null && $this->spreadsheet !== null) {
                                 $cellValue = $this->extractCellRange($cellRef, $this->spreadsheet->getSheetByName($sheet1), false);
                             } else {
@@ -4917,8 +4918,8 @@ private function processTokenStack(mixed $tokens, ?string $cellID = null, ?Cell
                             $this->debugLog->writeDebugLog('Evaluation Result is %s', $this->showTypeDetails($cellIntersect));
                             $stack->push('Error', ExcelError::null(), null);
                         } else {
-                            $cellRef = Coordinate::stringFromColumnIndex(min($oCol) + 1) . min($oRow) . ':'
-                                . Coordinate::stringFromColumnIndex(max($oCol) + 1) . max($oRow);
+                            $cellRef = Coordinate::stringFromColumnIndex(min($oCol) + 1) . min($oRow) . ':' // @phpstan-ignore-line
+                                . Coordinate::stringFromColumnIndex(max($oCol) + 1) . max($oRow); // @phpstan-ignore-line
                             $this->debugLog->writeDebugLog('Evaluation Result is %s', $this->showTypeDetails($cellIntersect));
                             $stack->push('Value', $cellIntersect, $cellRef);
                         }
@@ -5058,6 +5059,7 @@ private function processTokenStack(mixed $tokens, ?string $cellID = null, ?Cell
                 }
 
                 $functionName = $matches[1];
+                /** @var array $argCount */
                 $argCount = $stack->pop();
                 $argCount = $argCount['value'];
                 if ($functionName !== 'MKMATRIX') {
@@ -5088,9 +5090,10 @@ private function processTokenStack(mixed $tokens, ?string $cellID = null, ?Cell
                             && (isset(self::$phpSpreadsheetFunctions[$functionName]['passByReference'][$a]))
                             && (self::$phpSpreadsheetFunctions[$functionName]['passByReference'][$a])
                         ) {
+                            /** @var array $arg */
                             if ($arg['reference'] === null) {
                                 $nextArg = $cellID;
-                                if ($functionName === 'ISREF' && is_array($arg) && ($arg['type'] ?? '') === 'Value') {
+                                if ($functionName === 'ISREF' && ($arg['type'] ?? '') === 'Value') {
                                     if (array_key_exists('value', $arg)) {
                                         $argValue = $arg['value'];
                                         if (is_scalar($argValue)) {
@@ -5111,6 +5114,7 @@ private function processTokenStack(mixed $tokens, ?string $cellID = null, ?Cell
                                 }
                             }
                         } else {
+                            /** @var array $arg */
                             if ($arg['type'] === 'Empty Argument' && in_array($functionName, ['MIN', 'MINA', 'MAX', 'MAXA', 'IF'], true)) {
                                 $emptyArguments[] = false;
                                 $args[] = $arg['value'] = 0;
@@ -5233,6 +5237,7 @@ private function processTokenStack(mixed $tokens, ?string $cellID = null, ?Cell
         if ($stack->count() != 1) {
             return $this->raiseFormulaError('internal error');
         }
+        /** @var array $output */
         $output = $stack->pop();
         $output = $output['value'];
 
@@ -5285,6 +5290,7 @@ private function executeArrayComparison(mixed $operand1, mixed $operand2, string
             foreach ($operand1 as $x => $operandData) {
                 $this->debugLog->writeDebugLog('Evaluating Comparison %s %s %s', $this->showValue($operandData), $operation, $this->showValue($operand2));
                 $this->executeBinaryComparisonOperation($operandData, $operand2, $operation, $stack);
+                /** @var array $r */
                 $r = $stack->pop();
                 $result[$x] = $r['value'];
             }
@@ -5293,6 +5299,7 @@ private function executeArrayComparison(mixed $operand1, mixed $operand2, string
             foreach ($operand2 as $x => $operandData) {
                 $this->debugLog->writeDebugLog('Evaluating Comparison %s %s %s', $this->showValue($operand1), $operation, $this->showValue($operandData));
                 $this->executeBinaryComparisonOperation($operand1, $operandData, $operation, $stack);
+                /** @var array $r */
                 $r = $stack->pop();
                 $result[$x] = $r['value'];
             }
@@ -5304,6 +5311,7 @@ private function executeArrayComparison(mixed $operand1, mixed $operand2, string
             foreach ($operand1 as $x => $operandData) {
                 $this->debugLog->writeDebugLog('Evaluating Comparison %s %s %s', $this->showValue($operandData), $operation, $this->showValue($operand2[$x]));
                 $this->executeBinaryComparisonOperation($operandData, $operand2[$x], $operation, $stack, true);
+                /** @var array $r */
                 $r = $stack->pop();
                 $result[$x] = $r['value'];
             }
@@ -5495,7 +5503,7 @@ public function extractCellRange(string &$range = 'A1', ?Worksheet $worksheet =
             $worksheetName = $worksheet->getTitle();
 
             if (str_contains($range, '!')) {
-                [$worksheetName, $range] = Worksheet::extractSheetTitle($range, true);
+                [$worksheetName, $range] = Worksheet::extractSheetTitle($range, true, true);
                 $worksheet = ($this->spreadsheet === null) ? null : $this->spreadsheet->getSheetByName($worksheetName);
             }
 
@@ -5557,7 +5565,7 @@ public function extractNamedRange(string &$range = 'A1', ?Worksheet $worksheet =
 
         if ($worksheet !== null) {
             if (str_contains($range, '!')) {
-                [$worksheetName, $range] = Worksheet::extractSheetTitle($range, true);
+                [$worksheetName, $range] = Worksheet::extractSheetTitle($range, true, true);
                 $worksheet = ($this->spreadsheet === null) ? null : $this->spreadsheet->getSheetByName($worksheetName);
             }
 

src/PhpSpreadsheet/Calculation/Calculation.php

@@ -108,7 +108,7 @@ private static function buildQuery(array $criteriaNames, array $criteria): strin
         }
 
         $rowQuery = array_map(
-            fn ($rowValue): string => (count($rowValue) > 1) ? 'AND(' . implode(',', $rowValue) . ')' : ($rowValue[0] ?? ''),
+            fn ($rowValue): string => (count($rowValue) > 1) ? 'AND(' . implode(',', $rowValue) . ')' : ($rowValue[0] ?? ''), // @phpstan-ignore-line
             $baseQuery
         );
 

src/PhpSpreadsheet/Calculation/Database/DatabaseAbstract.php

@@ -151,11 +151,11 @@ private static function adjustYearMonth(int &$year, int &$month, int $baseYear):
         if ($month < 1) {
             //    Handle year/month adjustment if month < 1
             --$month;
-            $year += ceil($month / 12) - 1;
+            $year += (int) (ceil($month / 12) - 1);
             $month = 13 - abs($month % 12);
         } elseif ($month > 12) {
             //    Handle year/month adjustment if month > 12
-            $year += floor($month / 12);
+            $year += intdiv($month, 12);
             $month = ($month % 12);
         }
 

src/PhpSpreadsheet/Calculation/DateTimeExcel/Date.php

@@ -50,7 +50,7 @@ public static function between(array|DateTimeInterface|float|int|string $endDate
 
         $days = ExcelError::VALUE();
         $diff = $PHPStartDateObject->diff($PHPEndDateObject);
-        if ($diff !== false && !is_bool($diff->days)) {
+        if (!is_bool($diff->days)) {
             $days = $diff->days;
             if ($diff->invert) {
                 $days = -$days;

src/PhpSpreadsheet/Calculation/DateTimeExcel/Days.php

@@ -119,7 +119,7 @@ public static function adjustYear(string $testVal1, string $testVal2, string &$t
         if (!is_numeric($testVal1) || $testVal1 < 31) {
             if (!is_numeric($testVal2) || $testVal2 < 12) {
                 if (is_numeric($testVal3) && $testVal3 < 12) {
-                    $testVal3 += 2000;
+                    $testVal3 = (string) ($testVal3 + 2000);
                 }
             }
         }

src/PhpSpreadsheet/Calculation/DateTimeExcel/Helpers.php

@@ -87,27 +87,27 @@ public static function fromHMS(array|int|float|bool|null|string $hour, array|int
     private static function adjustSecond(int &$second, int &$minute): void
     {
         if ($second < 0) {
-            $minute += floor($second / 60);
+            $minute += (int) floor($second / 60);
             $second = 60 - abs($second % 60);
             if ($second == 60) {
                 $second = 0;
             }
         } elseif ($second >= 60) {
-            $minute += floor($second / 60);
+            $minute += intdiv($second, 60);
             $second = $second % 60;
         }
     }
 
     private static function adjustMinute(int &$minute, int &$hour): void
     {
         if ($minute < 0) {
-            $hour += floor($minute / 60);
+            $hour += (int) floor($minute / 60);
             $minute = 60 - abs($minute % 60);
             if ($minute == 60) {
                 $minute = 0;
             }
         } elseif ($minute >= 60) {
-            $hour += floor($minute / 60);
+            $hour += intdiv($minute, 60);
             $minute = $minute % 60;
         }
     }

src/PhpSpreadsheet/Calculation/DateTimeExcel/Time.php

@@ -44,12 +44,12 @@ public static function convertToNumberIfFormatted(string &$operand): bool
      * Identify whether a string contains a numeric value,
      * and convert it to a numeric if it is.
      *
-     * @param string $operand string value to test
+     * @param float|string $operand string value to test
      */
-    public static function convertToNumberIfNumeric(string &$operand): bool
+    public static function convertToNumberIfNumeric(float|string &$operand): bool
     {
         $thousandsSeparator = preg_quote(StringHelper::getThousandsSeparator(), '/');
-        $value = preg_replace(['/(\d)' . $thousandsSeparator . '(\d)/u', '/([+-])\s+(\d)/u'], ['$1$2', '$1$2'], trim($operand));
+        $value = preg_replace(['/(\d)' . $thousandsSeparator . '(\d)/u', '/([+-])\s+(\d)/u'], ['$1$2', '$1$2'], trim("$operand"));
         $decimalSeparator = preg_quote(StringHelper::getDecimalSeparator(), '/');
         $value = preg_replace(['/(\d)' . $decimalSeparator . '(\d)/u', '/([+-])\s+(\d)/u'], ['$1.$2', '$1$2'], $value ?? '');
 
@@ -86,12 +86,12 @@ public static function convertToNumberIfFraction(string &$operand): bool
      * Identify whether a string contains a percentage, and if so,
      * convert it to a numeric.
      *
-     * @param string $operand string value to test
+     * @param float|string $operand string value to test
      */
-    public static function convertToNumberIfPercent(string &$operand): bool
+    public static function convertToNumberIfPercent(float|string &$operand): bool
     {
         $thousandsSeparator = preg_quote(StringHelper::getThousandsSeparator(), '/');
-        $value = preg_replace('/(\d)' . $thousandsSeparator . '(\d)/u', '$1$2', trim($operand));
+        $value = preg_replace('/(\d)' . $thousandsSeparator . '(\d)/u', '$1$2', trim("$operand"));
         $decimalSeparator = preg_quote(StringHelper::getDecimalSeparator(), '/');
         $value = preg_replace(['/(\d)' . $decimalSeparator . '(\d)/u', '/([+-])\s+(\d)/u'], ['$1.$2', '$1$2'], $value ?? '');
 
@@ -111,13 +111,13 @@ public static function convertToNumberIfPercent(string &$operand): bool
      * Identify whether a string contains a currency value, and if so,
      * convert it to a numeric.
      *
-     * @param string $operand string value to test
+     * @param float|string $operand string value to test
      */
-    public static function convertToNumberIfCurrency(string &$operand): bool
+    public static function convertToNumberIfCurrency(float|string &$operand): bool
     {
         $currencyRegexp = self::currencyMatcherRegexp();
         $thousandsSeparator = preg_quote(StringHelper::getThousandsSeparator(), '/');
-        $value = preg_replace('/(\d)' . $thousandsSeparator . '(\d)/u', '$1$2', $operand);
+        $value = preg_replace('/(\d)' . $thousandsSeparator . '(\d)/u', '$1$2', "$operand");
 
         $match = [];
         if ($value !== null && preg_match($currencyRegexp, $value, $match, PREG_UNMATCHED_AS_NULL)) {