Populate Rest of Array Cells, UNIQUE Changes

See issue #4062. When calculating an array formula, populate all the cells associated with the result. This is almost the same as Excel's behavior. As yet, there is no attempt to create a #SPILL error, so cells may be inappropriately overwritten. Also, if the array size shrinks (e.g. there are fewer unique values than before),  no attempt is made to unpopulate the cells which were in range but are now outside the new dimensions. Spill and unpopulation are somewhat related, and will probably be handled at the same time, but their time has not yet come.

UNIQUE, at least for rows, was treating all cell (calculated) values as strings. This is not the same behavior as Excel, which will preserve datatypes, and treat int 3 and string 3 as unique values. Excel will, however, treat int 3 and float 3.0 as non-unique. Within UNIQUE, private function uniqueByRow is changed to try to preserve the the datatype when executing (it will probably treat 3.0 as int - I don't know how I can, or even if I should attempt to, do better - but no int nor float should be treated as a string).

Author: oleibman

src/PhpSpreadsheet/Calculation/LookupRef/Unique.php

@@ -40,7 +40,17 @@ private static function uniqueByRow(array $lookupVector, bool $exactlyOnce): mix
         array_walk(
             $lookupVector,
             function (array &$value): void {
-                $value = implode(chr(0x00), $value);
+                $valuex = '';
+                $separator = '';
+                $numericIndicator = "\x01";
+                foreach ($value as $cellValue) {
+                    $valuex .= $separator . $cellValue;
+                    $separator = "\x00";
+                    if (is_int($cellValue) || is_float($cellValue)) {
+                        $valuex .= $numericIndicator;
+                    }
+                }
+                $value = $valuex;
             }
         );
 
@@ -60,7 +70,14 @@ function (array &$value): void {
         array_walk(
             $result,
             function (string &$value): void {
-                $value = explode(chr(0x00), $value);
+                $value = explode("\x00", $value);
+                foreach ($value as &$stringValue) {
+                    if (str_ends_with($stringValue, "\x01")) {
+                        // x01 should only end a string which is otherwise a float or int,
+                        // so phpstan is technically correct but what it fears should not happen.
+                        $stringValue = 0 + substr($stringValue, 0, -1); //@phpstan-ignore-line
+                    }
+                }
             }
         );
 

src/PhpSpreadsheet/Cell/Cell.php

@@ -390,6 +390,22 @@ public function getCalculatedValue(bool $resetLog = true): mixed
                         }
                     }
                 }
+                if (is_array($result)) {
+                    $newRow = $row = $this->getRow();
+                    $column = $this->getColumn();
+                    foreach ($result as $resultRow) {
+                        $newColumn = $column;
+                        $resultRowx = is_array($resultRow) ? $resultRow : [$resultRow];
+                        foreach ($resultRowx as $resultValue) {
+                            if ($row !== $newRow || $column !== $newColumn) {
+                                $this->getWorksheet()->getCell($newColumn . $newRow)->setValue($resultValue);
+                            }
+                            ++$newColumn;
+                        }
+                        ++$newRow;
+                    }
+                    $this->getWorksheet()->getCell($column . $row);
+                }
             } catch (SpreadsheetException $ex) {
                 if (($ex->getMessage() === 'Unable to access External Workbook') && ($this->calculatedValue !== null)) {
                     return $this->calculatedValue; // Fallback for calculations referencing external files.

tests/PhpSpreadsheetTests/Calculation/Functions/LookupRef/UniqueTest.php

@@ -16,7 +16,7 @@ class UniqueTest extends TestCase
     public function testUnique(array $expectedResult, array $lookupRef, bool $byColumn = false, bool $exactlyOnce = false): void
     {
         $result = LookupRef\Unique::unique($lookupRef, $byColumn, $exactlyOnce);
-        self::assertEquals($expectedResult, $result);
+        self::assertSame($expectedResult, $result);
     }
 
     public function testUniqueException(): void
@@ -36,10 +36,10 @@ public function testUniqueException(): void
         ];
 
         $result = LookupRef\Unique::unique($rowLookupData, false, true);
-        self::assertEquals(ExcelError::CALC(), $result);
+        self::assertSame(ExcelError::CALC(), $result);
 
         $result = LookupRef\Unique::unique($columnLookupData, true, true);
-        self::assertEquals(ExcelError::CALC(), $result);
+        self::assertSame(ExcelError::CALC(), $result);
     }
 
     public function testUniqueWithScalar(): void
@@ -145,13 +145,16 @@ public static function uniqueTestProvider(): array
                 ],
             ],
             [
-                [[1.2], [2.1], [2.2], [3.0]],
+                [[1.2], [2.1], [2.2], [3], ['3'], [8.7]],
                 [
                     [1.2],
                     [1.2],
                     [2.1],
                     [2.2],
                     [3.0],
+                    [3],
+                    ['3'],
+                    [8.7],
                 ],
             ],
         ];