Xlsx Reader Use Dimensions from Functions With Array Results

Thinking about #3958 - user wondered if unsupported formulas with array results could be handled better. I said that the answer was "no", but I think Xlsx Reader can make use of the dimensions of the result after all, so the answer is actually "sometimes". This is an initial attempt to do that. Implementing it revealed a bug in how Xlsx Reader handles array formula attributes, and that is now corrected. Likewise, Xlsx Writer did not indicate a value for the first cell in the array, and does now.

Author: oleibman

src/PhpSpreadsheet/Reader/Xlsx.php

@@ -891,9 +891,16 @@ protected function loadSpreadsheetFromFile(string $filename): Spreadsheet
                                                 } else {
                                                     // Formula
                                                     $this->castToFormula($c, $r, $cellDataType, $value, $calculatedValue, 'castToString');
-                                                    if (isset($c->f['t'])) {
-                                                        $attributes = $c->f['t'];
-                                                        $docSheet->getCell($r)->setFormulaAttributes(['t' => (string) $attributes]);
+                                                    $formulaAttributes = [];
+                                                    $attributes = $c->f->attributes();
+                                                    if (isset($attributes['t'])) {
+                                                        $formulaAttributes['t'] = (string) $attributes['t'];
+                                                    }
+                                                    if (isset($attributes['ref'])) {
+                                                        $formulaAttributes['ref'] = (string) $attributes['ref'];
+                                                    }
+                                                    if (!empty($formulaAttributes)) {
+                                                        $docSheet->getCell($r)->setFormulaAttributes($formulaAttributes);
                                                     }
                                                 }
 

src/PhpSpreadsheet/Writer/Xlsx/Worksheet.php

@@ -1401,8 +1401,8 @@ private function writeCellFormula(XMLWriter $objWriter, string $cellValue, Cell
             $calculatedValue = (int) $calculatedValue;
         }
 
-        $attributes = $cell->getFormulaAttributes();
-        $ref = $cell->getCoordinate();
+        $attributes = $cell->getFormulaAttributes() ?? [];
+        $ref = array_key_exists('ref', $attributes) ? $attributes['ref'] : $cell->getCoordinate();
         if (is_array($calculatedValue)) {
             $attributes['t'] = 'array';
             $rows = max(1, count($calculatedValue));
@@ -1424,6 +1424,17 @@ private function writeCellFormula(XMLWriter $objWriter, string $cellValue, Cell
             $objWriter->writeAttribute('ca', '1');
             $objWriter->text(FunctionPrefix::addFunctionPrefixStripEquals($cellValue));
             $objWriter->endElement();
+            $result = $calculatedValue;
+            while (is_array($result)) {
+                $result = array_shift($result);
+            }
+            if (
+                is_scalar($result)
+                && $this->getParentWriter()->getOffice2003Compatibility() === false
+                && $this->getParentWriter()->getPreCalculateFormulas()
+            ) {
+                $objWriter->writeElement('v', (string) $result);
+            }
         } else {
             $objWriter->writeElement('f', FunctionPrefix::addFunctionPrefixStripEquals($cellValue));
             self::writeElementIf(

tests/PhpSpreadsheetTests/Writer/Xlsx/ArrayFunctionsTest.php

@@ -120,8 +120,44 @@ public function testArrayOutput(): void
         if ($data === false) {
             self::fail('Unable to read file');
         } else {
-            self::assertStringContainsString('<c r="C1"><f t="array" ref="C1:C15" aca="1" ca="1">_xlfn.UNIQUE(A1:A19)</f></c>', $data, '15 results for UNIQUE');
-            self::assertStringContainsString('<c r="D1"><f t="array" ref="D1:D19" aca="1" ca="1">_xlfn._xlws.SORT(A1:A19)</f></c>', $data, '19 results for SORT');
+            self::assertStringContainsString('<c r="C1"><f t="array" ref="C1:C15" aca="1" ca="1">_xlfn.UNIQUE(A1:A19)</f><v>41</v></c>', $data, '15 results for UNIQUE');
+            self::assertStringContainsString('<c r="D1"><f t="array" ref="D1:D19" aca="1" ca="1">_xlfn._xlws.SORT(A1:A19)</f><v>26</v></c>', $data, '19 results for SORT');
+        }
+    }
+
+    public function testUnimplementedArrayOutput(): void
+    {
+        //Calculation::setArrayReturnType(Calculation::RETURN_ARRAY_AS_ARRAY); // not required for this test
+        $reader = new XlsxReader();
+        $spreadsheet = $reader->load('tests/data/Reader/XLSX/atsign.choosecols.xlsx');
+        $writer = new XlsxWriter($spreadsheet);
+        $this->outputFile = File::temporaryFilename();
+        $writer->save($this->outputFile);
+        $spreadsheet->disconnectWorksheets();
+
+        $reader = new XlsxReader();
+        $spreadsheet2 = $reader->load($this->outputFile);
+        $sheet2 = $spreadsheet2->getActiveSheet();
+        self::assertSame('=_xlfn.CHOOSECOLS(A1:C5,3,1)', $sheet2->getCell('F1')->getValue());
+        $expectedFG = [
+            ['11', '1'],
+            ['12', '2'],
+            ['13', '3'],
+            ['14', '4'],
+            ['15', '5'],
+        ];
+        $actualFG = $sheet2->rangeToArray('F1:G5');
+        self::assertSame($expectedFG, $actualFG);
+        $spreadsheet2->disconnectWorksheets();
+
+        $file = 'zip://';
+        $file .= $this->outputFile;
+        $file .= '#xl/worksheets/sheet1.xml';
+        $data = file_get_contents($file);
+        if ($data === false) {
+            self::fail('Unable to read file');
+        } else {
+            self::assertStringContainsString('<f t="array" ref="F1:G5" aca="1" ca="1">_xlfn.CHOOSECOLS(A1:C5,3,1)</f><v>11</v>', $data);
         }
     }
 }