Merge pull request #4544 from oleibman/replacedummy

Allow Replace of Dummy Function with Custom Function

Author: oleibman

CHANGELOG.md

@@ -35,6 +35,7 @@ and this project adheres to [Semantic Versioning](https://semver.org).
 - Recognize application/x-empty mimetype. [Issue #4521](https://github.com/PHPOffice/PhpSpreadsheet/issues/4521) [PR #4524](https://github.com/PHPOffice/PhpSpreadsheet/pull/4524)
 - Micro-optimization in getSheetByName. [PR #4499](https://github.com/PHPOffice/PhpSpreadsheet/pull/4499)
 - Bug in resizeMatricesExtend. [Issue #4451](https://github.com/PHPOffice/PhpSpreadsheet/issues/4451) [PR #4474](https://github.com/PHPOffice/PhpSpreadsheet/pull/4474)
+- Allow Replace of Dummy Function with Custom Function. [PR #4544](https://github.com/PHPOffice/PhpSpreadsheet/pull/4544)
 - Preserve 0x0a in Strings if Desired. [Issue #347](https://github.com/PHPOffice/PhpSpreadsheet/issues/347) [PR #4536](https://github.com/PHPOffice/PhpSpreadsheet/pull/4536)
 
 ## 2025-06-22 - 4.4.0

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));
+    }
 }