Add a hidden functions list, fixes #618

thecodingmachine · Feb 17, 2025 · 5f1338b · 5f1338b
1 parent 288a30a
commit 5f1338b
Show file tree

Hide file tree

Showing 7 changed files with 26 additions and 7 deletions.
diff --git a/generated/8.4/functionsList.php b/generated/8.4/functionsList.php
diff --git a/generated/8.4/rector-migrate.php b/generated/8.4/rector-migrate.php
diff --git a/generated/8.5/functionsList.php b/generated/8.5/functionsList.php
diff --git a/generated/8.5/rector-migrate.php b/generated/8.5/rector-migrate.php
diff --git a/generator/config/hiddenFunctions.php b/generator/config/hiddenFunctions.php
@@ -0,0 +1,11 @@
+<?php
+/*
+ * A list of functions which don't really belong in Safe, but our
+ * unsafe-function-detector detected them by accident, and now we
+ * don't want to delete them (because that would break the backwards
+ * compatibility promise implied by Semver), but we also don't want
+ * to suggest that users should be using them.
+ */
+return [
+    'array_all', // false is not an error
+];
diff --git a/generator/src/Generator/FileCreator.php b/generator/src/Generator/FileCreator.php
@@ -101,8 +101,8 @@ private function getFunctionsNameList(array $functions): array
         $functionNames = array_map(function (Method $function) {
             return $function->getFunctionName();
         }, $functions);
-        $specialCases = Scanner::getSpecialCases();
-        $functionNames = array_merge($functionNames, $specialCases);
+        $functionNames = array_merge($functionNames, Scanner::getSpecialCases());
+        $functionNames = array_diff($functionNames, Scanner::getHiddenFunctions());
         natcasesort($functionNames);
         return $functionNames;
     }

diff --git a/generator/src/XmlDocParser/Scanner.php b/generator/src/XmlDocParser/Scanner.php
@@ -23,7 +23,7 @@ class Scanner
     /**
      * @var string[]
      */
-    private $ignoredModules;
+    private ?array $ignoredModules = null;
 
     public function __construct(private readonly string $path)
     {
@@ -74,6 +74,7 @@ private function getIgnoredModules(): array
     {
         if ($this->ignoredModules === null) {
             $this->ignoredModules = require FileCreator::getSafeRootDir() . '/generator/config/ignoredModules.php';
+            assert(!is_null($this->ignoredModules));
         }
         return $this->ignoredModules;
     }
@@ -95,6 +96,17 @@ public static function getSpecialCases(): array
         return $matches[1];
     }
 
+    /**
+     * Get a list of functions defined in special_cases.php so that we
+     * can ignore them in the main list.
+     *
+     * @return string[]
+     */
+    public static function getHiddenFunctions(): array
+    {
+        return require FileCreator::getSafeRootDir() . '/generator/config/hiddenFunctions.php';
+    }
+
     /**
      * @param SplFileInfo[] $paths
      */