Throw an exception if we have three or more array arguments (after flattening) until we identify how Excel handles building, using and presenting those n-dimensional result arrays

Author: MarkBaker

src/PhpSpreadsheet/Calculation/ArrayEnabled.php

@@ -41,7 +41,7 @@ protected static function evaluateArrayArguments(callable $method, ...$arguments
             return [$method(...$arguments)];
         }
 
-        if (self::$arrayArgumentHelper->arrayArgumentCount() === 1) {
+        if (self::$arrayArgumentHelper->arrayArguments() === 1) {
             $nthArgument = self::$arrayArgumentHelper->getFirstArrayArgumentNumber();
 
             return self::evaluateNthArgumentAsArray($method, $nthArgument, ...$arguments);
@@ -70,6 +70,7 @@ protected static function evaluateArrayArguments(callable $method, ...$arguments
         }
 
         // Still need to work out the logic for more than two array arguments,
+        // For the moment, we're throwing an Exception when we initialise the ArrayArgumentHelper
         return ['#VALUE!'];
     }
 

src/PhpSpreadsheet/Calculation/Engine/ArrayArgumentHelper.php

@@ -2,6 +2,8 @@
 
 namespace PhpOffice\PhpSpreadsheet\Calculation\Engine;
 
+use PhpOffice\PhpSpreadsheet\Calculation\Exception;
+
 class ArrayArgumentHelper
 {
     /**
@@ -34,6 +36,10 @@ public function initialise(array $arguments): void
 
         $this->rows = $this->rows($arguments);
         $this->columns = $this->columns($arguments);
+
+        if ($this->arrayArguments() > 2) {
+            throw new Exception('Formulae with more than two array arguments are not supported');
+        }
     }
 
     public function arguments(): array
@@ -43,22 +49,7 @@ public function arguments(): array
 
     public function hasArrayArgument(): bool
     {
-        return $this->arrayArgumentCount() > 0;
-    }
-
-    public function arrayArgumentCount(): int
-    {
-        $rowArrays = $this->filterArray($this->rows);
-        $columnArrays = $this->filterArray($this->columns);
-
-        $count = 0;
-        for ($index = 0; $index < $this->argumentCount; ++$index) {
-            if (isset($rowArrays[$index]) || isset($columnArrays[$index])) {
-                ++$count;
-            }
-        }
-
-        return $count;
+        return $this->arrayArguments() > 0;
     }
 
     public function getFirstArrayArgumentNumber(): int
@@ -173,6 +164,18 @@ function ($argument) {
         );
     }
 
+    public function arrayArguments(): int
+    {
+        $count = 0;
+        foreach (array_keys($this->arguments) as $argument) {
+            if ($this->rows[$argument] > 1 || $this->columns[$argument] > 1) {
+                ++$count;
+            }
+        }
+
+        return $count;
+    }
+
     private function flattenSingleCellArrays(array $arguments, array $rows, array $columns): array
     {
         foreach ($arguments as $index => $argument) {

tests/PhpSpreadsheetTests/Calculation/Functions/DateTime/DateTest.php

@@ -4,6 +4,7 @@
 
 use PhpOffice\PhpSpreadsheet\Calculation\Calculation;
 use PhpOffice\PhpSpreadsheet\Calculation\DateTimeExcel\Date;
+use PhpOffice\PhpSpreadsheet\Calculation\Exception;
 
 class DateTest extends AllSetupTeardown
 {
@@ -112,6 +113,44 @@ public function providerDateArray(): array
                 '{1; 4; 7; 10}',
                 '{0,1}',
             ],
+            'matrices year and month' => [
+                [
+                    [43831, 44287],
+                    [44743, 45200],
+                ],
+                '{2020, 2021; 2022, 2023}',
+                '{1, 4; 7, 10}',
+                '1',
+            ],
+        ];
+    }
+
+    /**
+     * @dataProvider providerDateArrayException
+     */
+    public function testDateArrayException(array $expectedResult, string $year, string $month, string $day): void
+    {
+        $calculation = Calculation::getInstance();
+
+        $this->expectException(Exception::class);
+        $this->expectExceptionMessage('Formulae with more than two array arguments are not supported');
+
+        $formula = "=DATE({$year}, {$month}, {$day})";
+        $calculation->_calculateFormulaValue($formula);
+    }
+
+    public function providerDateArrayException(): array
+    {
+        return [
+            'matrix arguments with 3 array values' => [
+                [
+                    [43830, 44287],
+                    [44742, 45200],
+                ],
+                '{2020, 2021; 2022, 2023}',
+                '{1, 4; 7, 10}',
+                '{0,1}',
+            ],
         ];
     }
 }