init

lib/PhpSpreadsheet/Reader/Ods/DefinedNames.php

@@ -0,0 +1,70 @@
+<?php
+
+namespace PhpOffice\PhpSpreadsheet\Reader\Ods;
+
+use DOMElement;
+use PhpOffice\PhpSpreadsheet\DefinedName;
+use PhpOffice\PhpSpreadsheet\Worksheet\Worksheet;
+
+class DefinedNames extends BaseLoader
+{
+    public function read(DOMElement $workbookData): void
+    {
+        $this->readDefinedRanges($workbookData);
+        $this->readDefinedExpressions($workbookData);
+    }
+
+    /**
+     * Read any Named Ranges that are defined in this spreadsheet.
+     */
+    protected function readDefinedRanges(DOMElement $workbookData): void
+    {
+        $namedRanges = $workbookData->getElementsByTagNameNS($this->tableNs, 'named-range');
+        foreach ($namedRanges as $definedNameElement) {
+            $definedName = $definedNameElement->getAttributeNS($this->tableNs, 'name');
+            $baseAddress = $definedNameElement->getAttributeNS($this->tableNs, 'base-cell-address');
+            $range = $definedNameElement->getAttributeNS($this->tableNs, 'cell-range-address');
+
+            /** @var non-empty-string $baseAddress */
+            $baseAddress = FormulaTranslator::convertToExcelAddressValue($baseAddress);
+            $range = FormulaTranslator::convertToExcelAddressValue($range);
+
+            $this->addDefinedName($baseAddress, $definedName, $range);
+        }
+    }
+
+    /**
+     * Read any Named Formulae that are defined in this spreadsheet.
+     */
+    protected function readDefinedExpressions(DOMElement $workbookData): void
+    {
+        $namedExpressions = $workbookData->getElementsByTagNameNS($this->tableNs, 'named-expression');
+        foreach ($namedExpressions as $definedNameElement) {
+            $definedName = $definedNameElement->getAttributeNS($this->tableNs, 'name');
+            $baseAddress = $definedNameElement->getAttributeNS($this->tableNs, 'base-cell-address');
+            $expression = $definedNameElement->getAttributeNS($this->tableNs, 'expression');
+
+            /** @var non-empty-string $baseAddress */
+            $baseAddress = FormulaTranslator::convertToExcelAddressValue($baseAddress);
+            $expression = substr($expression, strpos($expression, ':=') + 1);
+            $expression = FormulaTranslator::convertToExcelFormulaValue($expression);
+
+            $this->addDefinedName($baseAddress, $definedName, $expression);
+        }
+    }
+
+    /**
+     * Assess scope and store the Defined Name.
+     *
+     * @param non-empty-string $baseAddress
+     */
+    private function addDefinedName(string $baseAddress, string $definedName, string $value): void
+    {
+        [$sheetReference] = Worksheet::extractSheetTitle($baseAddress, 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) {
+            $this->spreadsheet->addDefinedName(DefinedName::createInstance((string) $definedName, $worksheet, $value));
+        }
+    }
+}