Xlsx Reader Defined Name on Sheet with Apostrophe in Title

CHANGELOG.md

@@ -30,6 +30,7 @@ and this project adheres to [Semantic Versioning](https://semver.org).
 ### Fixed
 
 - Refactor Helper/Html. [PR #4359](https://github.com/PHPOffice/PhpSpreadsheet/pull/4359)
+- 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
 

src/PhpSpreadsheet/Calculation/Calculation.php

@@ -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 .= '!';
@@ -4766,18 +4768,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();
@@ -5495,7 +5497,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 +5559,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/Information/Value.php

@@ -45,7 +45,7 @@ public static function isRef(mixed $value, ?Cell $cell = null): bool
 
         $cellValue = Functions::trimTrailingRange($value);
         if (preg_match('/^' . Calculation::CALCULATION_REGEXP_CELLREF . '$/ui', $cellValue) === 1) {
-            [$worksheet, $cellValue] = Worksheet::extractSheetTitle($cellValue, true);
+            [$worksheet, $cellValue] = Worksheet::extractSheetTitle($cellValue, true, true);
             if (!empty($worksheet) && $cell->getWorksheet()->getParentOrThrow()->getSheetByName($worksheet) === null) {
                 return false;
             }

src/PhpSpreadsheet/Calculation/Internal/ExcelArrayPseudoFunctions.php

@@ -15,7 +15,7 @@ public static function single(string $cellReference, Cell $cell): mixed
     {
         $worksheet = $cell->getWorksheet();
 
-        [$referenceWorksheetName, $referenceCellCoordinate] = Worksheet::extractSheetTitle($cellReference, true);
+        [$referenceWorksheetName, $referenceCellCoordinate] = Worksheet::extractSheetTitle($cellReference, true, true);
         if (preg_match('/^([$]?[a-z]{1,3})([$]?([0-9]{1,7})):([$]?[a-z]{1,3})([$]?([0-9]{1,7}))$/i', "$referenceCellCoordinate", $matches) === 1) {
             $ourRow = $cell->getRow();
             $firstRow = (int) $matches[3];
@@ -44,7 +44,7 @@ public static function anchorArray(string $cellReference, Cell $cell): array|str
         //$coordinate = $cell->getCoordinate();
         $worksheet = $cell->getWorksheet();
 
-        [$referenceWorksheetName, $referenceCellCoordinate] = Worksheet::extractSheetTitle($cellReference, true);
+        [$referenceWorksheetName, $referenceCellCoordinate] = Worksheet::extractSheetTitle($cellReference, true, true);
         $referenceCell = ($referenceWorksheetName === '')
             ? $worksheet->getCell((string) $referenceCellCoordinate)
             : $worksheet->getParentOrThrow()

src/PhpSpreadsheet/Calculation/LookupRef/Helpers.php

@@ -61,8 +61,7 @@ public static function extractWorksheet(string $cellAddress, Cell $cell): array
     {
         $sheetName = '';
         if (str_contains($cellAddress, '!')) {
-            [$sheetName, $cellAddress] = Worksheet::extractSheetTitle($cellAddress, true);
-            $sheetName = trim($sheetName, "'");
+            [$sheetName, $cellAddress] = Worksheet::extractSheetTitle($cellAddress, true, true);
         }
 
         $worksheet = ($sheetName !== '')

src/PhpSpreadsheet/Calculation/LookupRef/Offset.php

@@ -7,6 +7,7 @@
 use PhpOffice\PhpSpreadsheet\Calculation\Information\ExcelError;
 use PhpOffice\PhpSpreadsheet\Cell\Cell;
 use PhpOffice\PhpSpreadsheet\Cell\Coordinate;
+use PhpOffice\PhpSpreadsheet\Worksheet\Validations;
 use PhpOffice\PhpSpreadsheet\Worksheet\Worksheet;
 
 class Offset
@@ -55,19 +56,22 @@ public static function OFFSET(?string $cellAddress = null, mixed $rows = 0, mixe
         if (!is_object($cell)) {
             return ExcelError::REF();
         }
+        $sheet = $cell->getParent()?->getParent(); // worksheet
+        if ($sheet !== null) {
+            $cellAddress = Validations::definedNameToCoordinate($cellAddress, $sheet);
+        }
 
         [$cellAddress, $worksheet] = self::extractWorksheet($cellAddress, $cell);
 
         $startCell = $endCell = $cellAddress;
         if (strpos($cellAddress, ':')) {
             [$startCell, $endCell] = explode(':', $cellAddress);
         }
-        [$startCellColumn, $startCellRow] = Coordinate::coordinateFromString($startCell);
-        [$endCellColumn, $endCellRow] = Coordinate::coordinateFromString($endCell);
+        [$startCellColumn, $startCellRow] = Coordinate::indexesFromString($startCell);
+        [, $endCellRow, $endCellColumn] = Coordinate::indexesFromString($endCell);
 
         $startCellRow += $rows;
-        $startCellColumn = Coordinate::columnIndexFromString($startCellColumn) - 1;
-        $startCellColumn += $columns;
+        $startCellColumn += $columns - 1;
 
         if (($startCellRow <= 0) || ($startCellColumn < 0)) {
             return ExcelError::REF();
@@ -103,8 +107,7 @@ private static function extractWorksheet(?string $cellAddress, Cell $cell): arra
 
         $sheetName = '';
         if (str_contains($cellAddress, '!')) {
-            [$sheetName, $cellAddress] = Worksheet::extractSheetTitle($cellAddress, true);
-            $sheetName = trim($sheetName, "'");
+            [$sheetName, $cellAddress] = Worksheet::extractSheetTitle($cellAddress, true, true);
         }
 
         $worksheet = ($sheetName !== '')

src/PhpSpreadsheet/Chart/DataSeriesValues.php

@@ -446,7 +446,7 @@ public function refresh(Worksheet $worksheet, bool $flatten = true): void
                 }
                 unset($dataValue);
             } else {
-                [$worksheet, $cellRange] = Worksheet::extractSheetTitle($this->dataSource, true);
+                [, $cellRange] = Worksheet::extractSheetTitle($this->dataSource, true);
                 $dimensions = Coordinate::rangeDimension(str_replace('$', '', $cellRange ?? ''));
                 if (($dimensions[0] == 1) || ($dimensions[1] == 1)) {
                     $this->dataValues = Functions::flattenArray($newDataValues);

src/PhpSpreadsheet/Reader/Gnumeric.php

@@ -517,8 +517,8 @@ private function processDefinedNames(?SimpleXMLElement $gnmXML): void
                     continue;
                 }
 
-                [$worksheetName] = Worksheet::extractSheetTitle($value, true);
-                $worksheetName = trim($worksheetName, "'");
+                $value = str_replace("\\'", "''", $value);
+                [$worksheetName] = Worksheet::extractSheetTitle($value, true, true);
                 $worksheet = $this->spreadsheet->getSheetByName($worksheetName);
                 // Worksheet might still be null if we're only loading selected sheets rather than the full spreadsheet
                 if ($worksheet !== null) {

src/PhpSpreadsheet/Reader/Ods/DefinedNames.php

@@ -60,7 +60,7 @@ protected function readDefinedExpressions(DOMElement $workbookData): void
      */
     private function addDefinedName(string $baseAddress, string $definedName, string $value): void
     {
-        [$sheetReference] = Worksheet::extractSheetTitle($baseAddress, true);
+        [$sheetReference] = Worksheet::extractSheetTitle($baseAddress, true, true);
         $worksheet = $this->spreadsheet->getSheetByName($sheetReference);
         // Worksheet might still be null if we're only loading selected sheets rather than the full spreadsheet
         if ($worksheet !== null) {

src/PhpSpreadsheet/Reader/Xls/LoadSpreadsheet.php

@@ -588,8 +588,8 @@ protected function loadSpreadsheetFromFile2(string $filename, Xls $xls): Spreads
                             // $range should look like one of these
                             //        Foo!$C$7:$J$66
                             //        Bar!$A$1:$IV$2
-                            $explodes = Worksheet::extractSheetTitle($range, true);
-                            $sheetName = trim($explodes[0], "'");
+                            $explodes = Worksheet::extractSheetTitle($range, true, true);
+                            $sheetName = (string) $explodes[0];
                             if (!str_contains($explodes[1], ':')) {
                                 $explodes[1] = $explodes[1] . ':' . $explodes[1];
                             }
@@ -617,8 +617,9 @@ protected function loadSpreadsheetFromFile2(string $filename, Xls $xls): Spreads
                             //        Sheet!$A$1:$B$65536
                             //        Sheet!$A$1:$IV$2
                             if (str_contains($range, '!')) {
-                                $explodes = Worksheet::extractSheetTitle($range, true);
-                                if ($docSheet = $xls->spreadsheet->getSheetByName($explodes[0])) {
+                                $explodes = Worksheet::extractSheetTitle($range, true, true);
+                                $docSheet = $xls->spreadsheet->getSheetByName($explodes[0]);
+                                if ($docSheet) {
                                     $extractedRange = $explodes[1];
                                     $extractedRange = str_replace('$', '', $extractedRange);
 
@@ -646,11 +647,9 @@ protected function loadSpreadsheetFromFile2(string $filename, Xls $xls): Spreads
                 /** @var non-empty-string $formula */
                 $formula = $definedName['formula'];
                 if (str_contains($formula, '!')) {
-                    $explodes = Worksheet::extractSheetTitle($formula, true);
-                    if (
-                        ($docSheet = $xls->spreadsheet->getSheetByName($explodes[0]))
-                        || ($docSheet = $xls->spreadsheet->getSheetByName(trim($explodes[0], "'")))
-                    ) {
+                    $explodes = Worksheet::extractSheetTitle($formula, true, true);
+                    $docSheet = $xls->spreadsheet->getSheetByName($explodes[0]);
+                    if ($docSheet) {
                         $extractedRange = $explodes[1];
 
                         $localOnly = ($definedName['scope'] === 0) ? false : true;

src/PhpSpreadsheet/Reader/Xlsx.php

@@ -1819,11 +1819,10 @@ protected function loadSpreadsheetFromFile(string $filename): Spreadsheet
                                         $definedNameValueParts = preg_split("/[ ,](?=([^']*'[^']*')*[^']*$)/miuU", $extractedRange);
                                         if (is_array($definedNameValueParts)) {
                                             // Extract sheet name
-                                            [$extractedSheetName] = Worksheet::extractSheetTitle((string) $definedNameValueParts[0], true);
-                                            $extractedSheetName = trim((string) $extractedSheetName, "'");
+                                            [$extractedSheetName] = Worksheet::extractSheetTitle((string) $definedNameValueParts[0], true, true);
 
                                             // Locate sheet
-                                            $locatedSheet = $excel->getSheetByName($extractedSheetName);
+                                            $locatedSheet = $excel->getSheetByName("$extractedSheetName");
                                         }
                                     }
 

src/PhpSpreadsheet/Style/Style.php

@@ -7,6 +7,7 @@
 use PhpOffice\PhpSpreadsheet\Exception;
 use PhpOffice\PhpSpreadsheet\Shared\StringHelper;
 use PhpOffice\PhpSpreadsheet\Spreadsheet;
+use PhpOffice\PhpSpreadsheet\Worksheet\Worksheet;
 
 class Style extends Supervisor
 {
@@ -189,7 +190,8 @@ public function applyFromArray(array $styleArray, bool $advancedBorders = true):
             // Uppercase coordinate and strip any Worksheet reference from the selected range
             $pRange = strtoupper($pRange);
             if (str_contains($pRange, '!')) {
-                $pRangeWorksheet = StringHelper::strToUpper(trim(substr($pRange, 0, (int) strrpos($pRange, '!')), "'"));
+                $pRangeWorksheet = StringHelper::strToUpper(substr($pRange, 0, (int) strrpos($pRange, '!')));
+                $pRangeWorksheet = Worksheet::unApostrophizeTitle($pRangeWorksheet);
                 if ($pRangeWorksheet !== '' && StringHelper::strToUpper($this->getActiveSheet()->getTitle()) !== $pRangeWorksheet) {
                     throw new Exception('Invalid Worksheet for specified Range');
                 }

src/PhpSpreadsheet/Worksheet/Validations.php

@@ -2,6 +2,7 @@
 
 namespace PhpOffice\PhpSpreadsheet\Worksheet;
 
+use Composer\Pcre\Preg;
 use PhpOffice\PhpSpreadsheet\Cell\AddressRange;
 use PhpOffice\PhpSpreadsheet\Cell\CellAddress;
 use PhpOffice\PhpSpreadsheet\Cell\CellRange;
@@ -45,7 +46,7 @@ public static function validateCellOrCellRange(AddressRange|CellAddress|int|stri
         if (is_string($cellRange) || is_numeric($cellRange)) {
             // Convert a single column reference like 'A' to 'A:A',
             //    a single row reference like '1' to '1:1'
-            $cellRange = (string) preg_replace('/^([A-Z]+|\d+)$/', '${1}:${1}', (string) $cellRange);
+            $cellRange = Preg::replace('/^([A-Z]+|\d+)$/', '${1}:${1}', (string) $cellRange);
         } elseif (is_object($cellRange) && $cellRange instanceof CellAddress) {
             $cellRange = new CellRange($cellRange, $cellRange);
         }
@@ -62,7 +63,7 @@ public static function validateCellOrCellRange(AddressRange|CellAddress|int|stri
      */
     public static function convertWholeRowColumn(?string $addressRange): string
     {
-        return (string) preg_replace(
+        return Preg::replace(
             ['/^([A-Z]+):([A-Z]+)$/i', '/^(\d+):(\d+)$/'],
             [self::SETMAXROW, self::SETMAXCOL],
             $addressRange ?? ''
@@ -114,11 +115,11 @@ public static function definedNameToCoordinate(string $coordinate, Worksheet $wo
         // Uppercase coordinate
         $coordinate = strtoupper($coordinate);
         // Eliminate leading equal sign
-        $testCoordinate = (string) preg_replace('/^=/', '', $coordinate);
+        $testCoordinate = Preg::replace('/^=/', '', $coordinate);
         $defined = $worksheet->getParentOrThrow()->getDefinedName($testCoordinate, $worksheet);
         if ($defined !== null) {
             if ($defined->getWorksheet() === $worksheet && !$defined->isFormula()) {
-                $coordinate = (string) preg_replace('/^=/', '', $defined->getValue());
+                $coordinate = Preg::replace('/^=/', '', $defined->getValue());
             }
         }