Merge branch 'master' into Xls-Reader-Conditional-Formatting

Author: MarkBaker

CHANGELOG.md

@@ -9,7 +9,8 @@ and this project adheres to [Semantic Versioning](https://semver.org).
 
 ### Added
 
-- Implementation of the ISREF() information function.
+- Implementation of the UNIQUE() Lookup/Reference (array) function
+- Implementation of the ISREF() Information function.
 - Added support for reading "formatted" numeric values from Csv files; although default behaviour of reading these values as strings is preserved.
 
   (i.e a value of "12,345.67" can be read as numeric `1235.67`, not simply as a string `"12,345.67"`, if the `castFormattedNumberToNumeric()` setting is enabled.
@@ -31,6 +32,7 @@ and this project adheres to [Semantic Versioning](https://semver.org).
   This is determined by the Calculation Engine locale setting.
 
   (i.e. `"Vrai"` wil be converted to a boolean `true` if the Locale is set to `fr`.)
+- Allow `psr/simple-cache` 2.x
 
 ### Deprecated
 

composer.json

@@ -75,7 +75,7 @@
         "markbaker/matrix": "^3.0",
         "psr/http-client": "^1.0",
         "psr/http-factory": "^1.0",
-        "psr/simple-cache": "^1.0"
+        "psr/simple-cache": "^1.0 || ^2.0"
     },
     "require-dev": {
         "dealerdirect/phpcodesniffer-composer-installer": "dev-master",

composer.lock

@@ -2300,16 +2300,6 @@ parameters:
 			count: 2
 			path: src/PhpSpreadsheet/Reader/Xls.php
 
-		-
-			message: "#^Parameter \\#1 \\$errorStyle of method PhpOffice\\\\PhpSpreadsheet\\\\Cell\\\\DataValidation\\:\\:setErrorStyle\\(\\) expects string, int\\|string given\\.$#"
-			count: 1
-			path: src/PhpSpreadsheet/Reader/Xls.php
-
-		-
-			message: "#^Parameter \\#1 \\$operator of method PhpOffice\\\\PhpSpreadsheet\\\\Cell\\\\DataValidation\\:\\:setOperator\\(\\) expects string, int\\|string given\\.$#"
-			count: 1
-			path: src/PhpSpreadsheet/Reader/Xls.php
-
 		-
 			message: "#^Parameter \\#1 \\$showSummaryBelow of method PhpOffice\\\\PhpSpreadsheet\\\\Worksheet\\\\Worksheet\\:\\:setShowSummaryBelow\\(\\) expects bool, int given\\.$#"
 			count: 1
@@ -2320,11 +2310,6 @@ parameters:
 			count: 1
 			path: src/PhpSpreadsheet/Reader/Xls.php
 
-		-
-			message: "#^Parameter \\#1 \\$type of method PhpOffice\\\\PhpSpreadsheet\\\\Cell\\\\DataValidation\\:\\:setType\\(\\) expects string, int\\|string given\\.$#"
-			count: 1
-			path: src/PhpSpreadsheet/Reader/Xls.php
-
 		-
 			message: "#^Parameter \\#2 \\$row of method PhpOffice\\\\PhpSpreadsheet\\\\Reader\\\\IReadFilter\\:\\:readCell\\(\\) expects int, string given\\.$#"
 			count: 1
@@ -5484,3 +5469,4 @@ parameters:
 			message: "#^Method PhpOffice\\\\PhpSpreadsheet\\\\Writer\\\\Xlsx\\\\Xlfn\\:\\:addXlfn\\(\\) should return string but returns string\\|null\\.$#"
 			count: 1
 			path: src/PhpSpreadsheet/Writer/Xlsx/Xlfn.php
+

phpstan-baseline.neon

@@ -2583,7 +2583,7 @@ class Calculation
         ],
         'UNIQUE' => [
             'category' => Category::CATEGORY_LOOKUP_AND_REFERENCE,
-            'functionCall' => [Functions::class, 'DUMMY'],
+            'functionCall' => [LookupRef\Unique::class, 'unique'],
             'argumentCount' => '1+',
         ],
         'UPPER' => [

src/PhpSpreadsheet/Calculation/Calculation.php

@@ -47,7 +47,7 @@ public static function isError($value = '')
             return false;
         }
 
-        return in_array($value, ExcelError::$errorCodes);
+        return in_array($value, ExcelError::$errorCodes) || $value === ExcelError::CALC();
     }
 
     /**

src/PhpSpreadsheet/Calculation/Information/ErrorValue.php

@@ -22,6 +22,7 @@ class ExcelError
         'num' => '#NUM!',
         'na' => '#N/A',
         'gettingdata' => '#GETTING_DATA',
+        'spill' => '#SPILL!',
     ];
 
     /**
@@ -45,6 +46,10 @@ public static function type($value = '')
             ++$i;
         }
 
+        if ($value === self::CALC()) {
+            return 14;
+        }
+
         return self::NA();
     }
 
@@ -127,10 +132,20 @@ public static function NAME()
     /**
      * DIV0.
      *
-     * @return string #Not Yet Implemented
+     * @return string #DIV/0!
      */
     public static function DIV0()
     {
         return self::$errorCodes['divisionbyzero'];
     }
+
+    /**
+     * CALC.
+     *
+     * @return string #Not Yet Implemented
+     */
+    public static function CALC()
+    {
+        return '#CALC!';
+    }
 }

src/PhpSpreadsheet/Calculation/Information/ExcelError.php

@@ -0,0 +1,141 @@
+<?php
+
+namespace PhpOffice\PhpSpreadsheet\Calculation\LookupRef;
+
+use PhpOffice\PhpSpreadsheet\Calculation\Functions;
+use PhpOffice\PhpSpreadsheet\Calculation\Information\ExcelError;
+use PhpOffice\PhpSpreadsheet\Shared\StringHelper;
+
+class Unique
+{
+    /**
+     * UNIQUE
+     * The UNIQUE function searches for value either from a one-row or one-column range or from an array.
+     *
+     * @param mixed $lookupVector The range of cells being searched
+     * @param mixed $byColumn Whether the uniqueness should be determined by row (the default) or by column
+     * @param mixed $exactlyOnce Whether the function should return only entries that occur just once in the list
+     *
+     * @return mixed The unique values from the search range
+     */
+    public static function unique($lookupVector, $byColumn = false, $exactlyOnce = false)
+    {
+        if (!is_array($lookupVector)) {
+            // Scalars are always returned "as is"
+            return $lookupVector;
+        }
+
+        $byColumn = (bool) $byColumn;
+        $exactlyOnce = (bool) $exactlyOnce;
+
+        return ($byColumn === true)
+                ? self::uniqueByColumn($lookupVector, $exactlyOnce)
+                : self::uniqueByRow($lookupVector, $exactlyOnce);
+    }
+
+    /**
+     * @return mixed
+     */
+    private static function uniqueByRow(array $lookupVector, bool $exactlyOnce)
+    {
+        // When not $byColumn, we count whole rows or values, not individual values
+        //      so implode each row into a single string value
+        array_walk(
+            $lookupVector,
+            function (array &$value): void {
+                $value = implode(chr(0x00), $value);
+            }
+        );
+
+        $result = self::countValuesCaseInsensitive($lookupVector);
+
+        if ($exactlyOnce === true) {
+            $result = self::exactlyOnceFilter($result);
+        }
+
+        if (count($result) === 0) {
+            return ExcelError::CALC();
+        }
+
+        $result = array_keys($result);
+
+        // restore rows from their strings
+        array_walk(
+            $result,
+            function (string &$value): void {
+                $value = explode(chr(0x00), $value);
+            }
+        );
+
+        return (count($result) === 1) ? array_pop($result) : $result;
+    }
+
+    /**
+     * @return mixed
+     */
+    private static function uniqueByColumn(array $lookupVector, bool $exactlyOnce)
+    {
+        $flattenedLookupVector = Functions::flattenArray($lookupVector);
+
+        if (count($lookupVector, COUNT_RECURSIVE) > count($flattenedLookupVector, COUNT_RECURSIVE) + 1) {
+            // We're looking at a full column check (multiple rows)
+            $transpose = Matrix::transpose($lookupVector);
+            $result = self::uniqueByRow($transpose, $exactlyOnce);
+
+            return (is_array($result)) ? Matrix::transpose($result) : $result;
+        }
+
+        $result = self::countValuesCaseInsensitive($flattenedLookupVector);
+
+        if ($exactlyOnce === true) {
+            $result = self::exactlyOnceFilter($result);
+        }
+
+        if (count($result) === 0) {
+            return ExcelError::CALC();
+        }
+
+        $result = array_keys($result);
+
+        return $result;
+    }
+
+    private static function countValuesCaseInsensitive(array $caseSensitiveLookupValues): array
+    {
+        $caseInsensitiveCounts = array_count_values(
+            array_map(
+                function (string $value) {
+                    return StringHelper::strToUpper($value);
+                },
+                $caseSensitiveLookupValues
+            )
+        );
+
+        $caseSensitiveCounts = [];
+        foreach ($caseInsensitiveCounts as $caseInsensitiveKey => $count) {
+            if (is_numeric($caseInsensitiveKey)) {
+                $caseSensitiveCounts[$caseInsensitiveKey] = $count;
+            } else {
+                foreach ($caseSensitiveLookupValues as $caseSensitiveValue) {
+                    if ($caseInsensitiveKey === StringHelper::strToUpper($caseSensitiveValue)) {
+                        $caseSensitiveCounts[$caseSensitiveValue] = $count;
+
+                        break;
+                    }
+                }
+            }
+        }
+
+        return $caseSensitiveCounts;
+    }
+
+    private static function exactlyOnceFilter(array $values): array
+    {
+        return array_filter(
+            $values,
+            function ($value) {
+                return $value === 1;
+            }
+        );
+    }
+}

src/PhpSpreadsheet/Calculation/LookupRef/Unique.php

@@ -4788,57 +4788,11 @@ private function readDataValidation(): void
 
         // bit: 0-3; mask: 0x0000000F; type
         $type = (0x0000000F & $options) >> 0;
-        switch ($type) {
-            case 0x00:
-                $type = DataValidation::TYPE_NONE;
-
-                break;
-            case 0x01:
-                $type = DataValidation::TYPE_WHOLE;
-
-                break;
-            case 0x02:
-                $type = DataValidation::TYPE_DECIMAL;
-
-                break;
-            case 0x03:
-                $type = DataValidation::TYPE_LIST;
-
-                break;
-            case 0x04:
-                $type = DataValidation::TYPE_DATE;
-
-                break;
-            case 0x05:
-                $type = DataValidation::TYPE_TIME;
-
-                break;
-            case 0x06:
-                $type = DataValidation::TYPE_TEXTLENGTH;
-
-                break;
-            case 0x07:
-                $type = DataValidation::TYPE_CUSTOM;
-
-                break;
-        }
+        $type = Xls\DataValidationHelper::type($type);
 
         // bit: 4-6; mask: 0x00000070; error type
         $errorStyle = (0x00000070 & $options) >> 4;
-        switch ($errorStyle) {
-            case 0x00:
-                $errorStyle = DataValidation::STYLE_STOP;
-
-                break;
-            case 0x01:
-                $errorStyle = DataValidation::STYLE_WARNING;
-
-                break;
-            case 0x02:
-                $errorStyle = DataValidation::STYLE_INFORMATION;
-
-                break;
-        }
+        $errorStyle = Xls\DataValidationHelper::errorStyle($errorStyle);
 
         // bit: 7; mask: 0x00000080; 1= formula is explicit (only applies to list)
         // I have only seen cases where this is 1
@@ -4858,39 +4812,10 @@ private function readDataValidation(): void
 
         // bit: 20-23; mask: 0x00F00000; condition operator
         $operator = (0x00F00000 & $options) >> 20;
-        switch ($operator) {
-            case 0x00:
-                $operator = DataValidation::OPERATOR_BETWEEN;
-
-                break;
-            case 0x01:
-                $operator = DataValidation::OPERATOR_NOTBETWEEN;
-
-                break;
-            case 0x02:
-                $operator = DataValidation::OPERATOR_EQUAL;
-
-                break;
-            case 0x03:
-                $operator = DataValidation::OPERATOR_NOTEQUAL;
+        $operator = Xls\DataValidationHelper::operator($operator);
 
-                break;
-            case 0x04:
-                $operator = DataValidation::OPERATOR_GREATERTHAN;
-
-                break;
-            case 0x05:
-                $operator = DataValidation::OPERATOR_LESSTHAN;
-
-                break;
-            case 0x06:
-                $operator = DataValidation::OPERATOR_GREATERTHANOREQUAL;
-
-                break;
-            case 0x07:
-                $operator = DataValidation::OPERATOR_LESSTHANOREQUAL;
-
-                break;
+        if ($type === null || $errorStyle === null || $operator === null) {
+            return;
         }
 
         // offset: 4; size: var; title of the prompt box