Ods defined names unit tests (#2054)

* Defined names/formulae in ODS are prefixed by $$ when used in a formula; so we need to strip this out to fully convert them to an Excel formula

* Test for ODS Writer for DefinedNames

phpstan-baseline.neon

@@ -2810,16 +2810,6 @@ parameters:
 			count: 1
 			path: src/PhpSpreadsheet/Reader/Ods.php
 
-		-
-			message: "#^Parameter \\#3 \\$subject of function preg_replace expects array\\|string, string\\|null given\\.$#"
-			count: 3
-			path: src/PhpSpreadsheet/Reader/Ods.php
-
-		-
-			message: "#^Parameter \\#3 \\$formula of static method PhpOffice\\\\PhpSpreadsheet\\\\Calculation\\\\Calculation\\:\\:translateSeparator\\(\\) expects string, string\\|null given\\.$#"
-			count: 1
-			path: src/PhpSpreadsheet/Reader/Ods.php
-
 		-
 			message: "#^Property PhpOffice\\\\PhpSpreadsheet\\\\Reader\\\\Ods\\\\PageSettings\\:\\:\\$officeNs has no typehint specified\\.$#"
 			count: 1

src/PhpSpreadsheet/Reader/Ods.php

@@ -783,11 +783,13 @@ private function convertToExcelFormulaValue(string $openOfficeFormula): string
                 // Cell range reference in another sheet
                 $value = preg_replace('/\[\$?([^\.]+)\.([^\.]+):\.([^\.]+)\]/miu', '$1!$2:$3', $value);
                 // Cell reference in another sheet
-                $value = preg_replace('/\[\$?([^\.]+)\.([^\.]+)\]/miu', '$1!$2', $value);
+                $value = preg_replace('/\[\$?([^\.]+)\.([^\.]+)\]/miu', '$1!$2', $value ?? '');
                 // Cell range reference
-                $value = preg_replace('/\[\.([^\.]+):\.([^\.]+)\]/miu', '$1:$2', $value);
+                $value = preg_replace('/\[\.([^\.]+):\.([^\.]+)\]/miu', '$1:$2', $value ?? '');
                 // Simple cell reference
-                $value = preg_replace('/\[\.([^\.]+)\]/miu', '$1', $value);
+                $value = preg_replace('/\[\.([^\.]+)\]/miu', '$1', $value ?? '');
+                // Convert references to defined names/formulae
+                $value = str_replace('$$', '', $value ?? '');
 
                 $value = Calculation::translateSeparator(';', ',', $value, $inBraces);
             }

src/PhpSpreadsheet/Reader/Ods/BaseReader.php

@@ -62,8 +62,10 @@ protected function convertToExcelFormulaValue(string $openOfficeFormula): string
                 $value = preg_replace('/\[\.([^\.]+):\.([^\.]+)\]/miu', '$1:$2', $value ?? '');
                 // Simple cell reference
                 $value = preg_replace('/\[\.([^\.]+)\]/miu', '$1', $value ?? '');
+                // Convert references to defined names/formulae
+                $value = str_replace('$$', '', $value ?? '');
 
-                $value = Calculation::translateSeparator(';', ',', $value ?? '', $inBraces);
+                $value = Calculation::translateSeparator(';', ',', $value, $inBraces);
             }
         }
 

src/PhpSpreadsheet/Reader/Ods/DefinedNames.php

@@ -44,6 +44,7 @@ protected function readDefinedExpressions(DOMElement $workbookData): void
             $expression = $definedNameElement->getAttributeNS($this->tableNs, 'expression');
 
             $baseAddress = $this->convertToExcelAddressValue($baseAddress);
+            $expression = substr($expression, strpos($expression, ':=') + 1);
             $expression = $this->convertToExcelFormulaValue($expression);
 
             $this->addDefinedName($baseAddress, $definedName, $expression);

tests/PhpSpreadsheetTests/Reader/Ods/DefinedNamesTest.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace PhpOffice\PhpSpreadsheetTests\Reader\Ods;
+
+use PhpOffice\PhpSpreadsheet\Reader\Ods;
+use PhpOffice\PhpSpreadsheet\Spreadsheet;
+use PHPUnit\Framework\TestCase;
+
+class DefinedNamesTest extends TestCase
+{
+    /**
+     * @var Spreadsheet
+     */
+    private $spreadsheet;
+
+    protected function setUp(): void
+    {
+        $filename = 'tests/data/Reader/Ods/DefinedNames.ods';
+        $reader = new Ods();
+        $this->spreadsheet = $reader->load($filename);
+    }
+
+    public function testDefinedNames(): void
+    {
+        $worksheet = $this->spreadsheet->getActiveSheet();
+
+        $firstDefinedNameValue = $worksheet->getCell('First')->getValue();
+        $secondDefinedNameValue = $worksheet->getCell('Second')->getValue();
+        $calculatedFormulaValue = $worksheet->getCell('B2')->getCalculatedValue();
+
+        self::assertSame(3, $firstDefinedNameValue);
+        self::assertSame(4, $secondDefinedNameValue);
+        self::assertSame(12, $calculatedFormulaValue);
+    }
+}

tests/PhpSpreadsheetTests/Writer/Ods/DefinedNamesTest.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace PhpOffice\PhpSpreadsheetTests\Writer\Ods;
+
+use PhpOffice\PhpSpreadsheet\NamedFormula;
+use PhpOffice\PhpSpreadsheet\NamedRange;
+use PhpOffice\PhpSpreadsheet\Spreadsheet;
+use PhpOffice\PhpSpreadsheetTests\Functional\AbstractFunctional;
+
+class DefinedNamesTest extends AbstractFunctional
+{
+    public function testDefinedNamesWriter(): void
+    {
+        $spreadsheet = new Spreadsheet();
+        $worksheet = $spreadsheet->getActiveSheet();
+
+        $dataSet = [
+            [7, 'x', 5],
+            ['=', '=FORMULA'],
+        ];
+        $worksheet->fromArray($dataSet, null, 'A1');
+
+        $spreadsheet->addDefinedName(new NamedRange('FIRST', $worksheet, '$A$1'));
+        $spreadsheet->addDefinedName(new NamedRange('SECOND', $worksheet, '$C$1'));
+        $spreadsheet->addDefinedName(new NamedFormula('FORMULA', $worksheet, '=FIRST*SECOND'));
+
+        $reloaded = $this->writeAndReload($spreadsheet, 'Ods');
+
+        self::assertSame(7, $reloaded->getActiveSheet()->getCell('FIRST')->getValue());
+        self::assertSame(5, $reloaded->getActiveSheet()->getCell('SECOND')->getValue());
+        self::assertSame(35, $reloaded->getActiveSheet()->getCell('B2')->getCalculatedValue());
+    }
+}