Allow Replace of Dummy Function with Custom Function

Custom functions were introduced recently, with a restriction that non-custom functions could not be replaced. However, reviewing a recent issue has led me to the conclusion that it might sometimes be impractical to implement an Excel function in PhpSpreadsheet for all users, but it could still be helpful to some users to offer an implementation anyhow.

The Excel ASC function is currently unimplemented in PhpSpreadsheet, and is a candidate for replacement using the functionality added in this PR. This PR supersedes PR #4513, which I will now close, and its earlier incarnation PR #4511. For reasons discussed in 4513, I don't see a way forward for implementing the Excel ASC function in a way that would be generally usable. However, this PR would permit a user to implement ASC in a way which would satisfy the user's local requirements. See the new `testReplaceDummyFunction`; I think, or at least hope, that, despite the deficiencies of 4511 and 4513, this might satisfy the author's requirement.

Author: oleibman

src/PhpSpreadsheet/Calculation/CalculationBase.php

@@ -30,7 +30,10 @@ protected static function &getFunctionsAddress(): array
     public static function addFunction(string $key, array $value): bool
     {
         $key = strtoupper($key);
-        if (array_key_exists($key, FunctionArray::$phpSpreadsheetFunctions)) {
+        if (
+            array_key_exists($key, FunctionArray::$phpSpreadsheetFunctions)
+            && !self::isDummy($key)
+        ) {
             return false;
         }
         $value['custom'] = true;
@@ -39,6 +42,20 @@ public static function addFunction(string $key, array $value): bool
         return true;
     }
 
+    private static function isDummy(string $key): bool
+    {
+        // key is already known to exist
+        $functionCall = FunctionArray::$phpSpreadsheetFunctions[$key]['functionCall'] ?? null;
+        if (!is_array($functionCall)) {
+            return false;
+        }
+        if (($functionCall[1] ?? '') !== 'DUMMY') {
+            return false;
+        }
+
+        return true;
+    }
+
     public static function removeFunction(string $key): bool
     {
         $key = strtoupper($key);

tests/PhpSpreadsheetTests/Calculation/CustomFunction.php

@@ -6,6 +6,7 @@
 
 use PhpOffice\PhpSpreadsheet\Calculation\Exception as CalcException;
 use PhpOffice\PhpSpreadsheet\Calculation\MathTrig\Helpers;
+use PhpOffice\PhpSpreadsheet\Shared\StringHelper;
 
 class CustomFunction
 {
@@ -19,4 +20,25 @@ public static function fourthPower(mixed $number): float|int|string
 
         return $number ** 4;
     }
+
+    /**
+     * ASC.
+     * Converts full-width (double-byte) characters to half-width (single-byte) characters.
+     * There are many difficulties with implementing this into PhpSpreadsheet.
+     */
+    public static function ASC(mixed $stringValue): string
+    {
+        /*if (is_array($stringValue)) {
+            return self::evaluateSingleArgumentArray([self::class, __FUNCTION__], $stringValue);
+        }*/
+        $stringValue = StringHelper::convertToString($stringValue, convertBool: true);
+        if (function_exists('mb_convert_kana')) {
+            return mb_convert_kana($stringValue, 'a', 'UTF-8');
+        }
+        // Fallback if mb_convert_kana is not available.
+        // PhpSpreadsheet heavily relies on mbstring, so this is more of a theoretical fallback.
+        // A comprehensive manual conversion is extensive.
+
+        return $stringValue;
+    }
 }

tests/PhpSpreadsheetTests/Calculation/CustomFunctionTest.php

@@ -31,4 +31,19 @@ public static function testCustomFunction(): void
         self::assertSame('#NAME?', $calculation->calculateFormula('=FOURTHPOWER(3)'));
         self::assertFalse(Calculation::removeFunction('WHATEVER'));
     }
+
+    public static function testReplaceDummyFunction(): void
+    {
+        $functions = Calculation::getFunctions();
+        $key = 'ASC';
+        $oldValue = $functions[$key] ?? null;
+        self::assertIsArray($oldValue);
+        $calculation = Calculation::getInstance();
+        $value = $oldValue;
+        $value['functionCall'] = [CustomFunction::class, 'ASC'];
+        self::assertTrue(Calculation::addFunction($key, $value));
+        self::assertSame('ABC', $calculation->calculateFormula('=ASC("ＡＢＣ")'));
+        self::assertTrue(Calculation::removeFunction('ASC'));
+        self::assertTrue(Calculation::addFunction($key, $oldValue));
+    }
 }