Tighten Up getStyle(definedName) Processing

Author: oleibman

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 ?? ''
@@ -109,16 +110,19 @@ public static function validateCellRange(AddressRange|string|array $cellRange):
         return (string) $cellRange;
     }
 
-    public static function definedNameToCoordinate(string $coordinate, Worksheet $worksheet): string
+    public static function definedNameToCoordinate(string $coordinate, Worksheet $worksheet, bool $replaceDollar = false): string
     {
         // 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());
+                if ($replaceDollar) {
+                    $coordinate = str_replace('$', '', $coordinate);
+                }
             }
         }
 

src/PhpSpreadsheet/Worksheet/Worksheet.php

@@ -1395,6 +1395,9 @@ public function getColumnStyle(string $column): ?Style
      */
     public function getStyle(AddressRange|CellAddress|int|string|array $cellCoordinate): Style
     {
+        if (is_string($cellCoordinate)) {
+            $cellCoordinate = Validations::definedNameToCoordinate($cellCoordinate, $this, true);
+        }
         $cellCoordinate = Validations::validateCellOrCellRange($cellCoordinate);
 
         // set this sheet as active

tests/PhpSpreadsheetTests/Reader/Xls/Issue4356Test.php

@@ -14,26 +14,28 @@ public function testIssue4356(): void
     {
         // Reader couldn't handle sheet title with apostrophe for defined name.
         // Issue was reported against Xlsx - see how Xls does.
+        $nameDefined = 'CELLNAME';
         $originalSpreadsheet = new Spreadsheet();
         $originalSheet = $originalSpreadsheet->getActiveSheet();
         $originalSheet->setTitle("Goodn't sheet name");
         $originalSpreadsheet->addNamedRange(
-            new NamedRange('CELLNAME', $originalSheet, '$A$1')
+            new NamedRange($nameDefined, $originalSheet, '$A$1')
         );
         $originalSheet->setCellValue('A1', 'This is a named cell.');
-        $originalSheet->getStyle('A1')->getFont()->setItalic(true);
+        $originalSheet->getStyle($nameDefined)
+            ->getFont()
+            ->setItalic(true);
         $spreadsheet = $this->writeAndReload($originalSpreadsheet, 'Xls');
         $originalSpreadsheet->disconnectWorksheets();
 
         $sheet = $spreadsheet->getActiveSheet();
-        $sheet->setCellValue('C1', '=CELLNAME');
+        $sheet->setCellValue('C1', "=$nameDefined");
         self::assertSame('This is a named cell.', $sheet->getCell('C1')->getCalculatedValue());
-        $namedRange2 = $spreadsheet->getNamedRange('CELLNAME');
+        $namedRange2 = $spreadsheet->getNamedRange($nameDefined);
         self::assertNotNull($namedRange2);
         $sheetx = $namedRange2->getWorksheet();
         self::assertNotNull($sheetx);
-        $style = $sheetx->getStyle($namedRange2->getRange());
-        //$style = $sheetx->getStyle('CELLNAME'); // no exception but doesn't work
+        $style = $sheetx->getStyle($nameDefined);
         self::assertTrue($style->getFont()->getItalic());
         $style->getFont()->setItalic(false);
 

tests/PhpSpreadsheetTests/Reader/Xlsx/Issue4356Test.php

@@ -13,25 +13,28 @@ class Issue4356Test extends AbstractFunctional
     public function testIssue4356(): void
     {
         // Reader couldn't handle sheet title with apostrophe for defined name
+        $nameDefined = 'CELLNAME';
         $originalSpreadsheet = new Spreadsheet();
         $originalSheet = $originalSpreadsheet->getActiveSheet();
         $originalSheet->setTitle("Goodn't sheet name");
         $originalSpreadsheet->addNamedRange(
-            new NamedRange('CELLNAME', $originalSheet, '$A$1')
+            new NamedRange($nameDefined, $originalSheet, '$A$1')
         );
         $originalSheet->setCellValue('A1', 'This is a named cell.');
-        $originalSheet->getStyle('A1')->getFont()->setItalic(true);
+        $originalSheet->getStyle($nameDefined)
+            ->getFont()
+            ->setItalic(true);
         $spreadsheet = $this->writeAndReload($originalSpreadsheet, 'Xlsx');
         $originalSpreadsheet->disconnectWorksheets();
 
         $sheet = $spreadsheet->getActiveSheet();
-        $sheet->setCellValue('C1', '=CELLNAME');
+        $sheet->setCellValue('C1', "=$nameDefined");
         self::assertSame('This is a named cell.', $sheet->getCell('C1')->getCalculatedValue());
-        $namedRange2 = $spreadsheet->getNamedRange('CELLNAME');
+        $namedRange2 = $spreadsheet->getNamedRange($nameDefined);
         self::assertNotNull($namedRange2);
         $sheetx = $namedRange2->getWorksheet();
         self::assertNotNull($sheetx);
-        $style = $sheetx->getStyle($namedRange2->getRange());
+        $style = $sheetx->getStyle($nameDefined);
         self::assertTrue($style->getFont()->getItalic());
         $style->getFont()->setItalic(false);