Merge pull request #139 from Kharhamel/readdir

remove readdir() from safe since the doc is false

Author: moufmouf

generated/dir.php

@@ -97,34 +97,6 @@ function opendir(string $path, $context = null)
 }
 
 
-/**
- * Returns the name of the next entry in the directory. The
- * entries are returned in the order in which they are stored by
- * the filesystem.
- *
- * @param resource $dir_handle The directory handle resource previously opened
- * with opendir. If the directory handle is
- * not specified, the last link opened by opendir
- * is assumed.
- * @return string Returns the entry name on success.
- * @throws DirException
- *
- */
-function readdir($dir_handle = null): string
-{
-    error_clear_last();
-    if ($dir_handle !== null) {
-        $result = \readdir($dir_handle);
-    } else {
-        $result = \readdir();
-    }
-    if ($result === false) {
-        throw DirException::createFromPhpError();
-    }
-    return $result;
-}
-
-
 /**
  * Resets the directory stream indicated by
  * dir_handle to the beginning of the

generated/functionsList.php

@@ -85,7 +85,6 @@
     'chroot',
     'getcwd',
     'opendir',
-    'readdir',
     'rewinddir',
     'scandir',
     'eio_busy',

generator/config/ignoredFunctions.php

@@ -14,4 +14,5 @@
     'array_search',
     'forward_static_call',
     'forward_static_call_array',
+    'readdir', //the documentation is false: the function return false at the end of the iteration
 ];

generator/config/specialCasesFunctions.php

@@ -9,4 +9,5 @@
     'apcu_fetch',
     'preg_replace',
     'openssl_encrypt',
+    'readdir',
 ];

generator/src/FileCreator.php

@@ -86,7 +86,9 @@ private function getFunctionsNameList(array $functions): array
             return $function->getFunctionName();
         }, $functions);
         $specialCases = require __DIR__.'/../config/specialCasesFunctions.php';
-        return array_merge($functionNames, $specialCases);
+        $functionNames = array_merge($functionNames, $specialCases);
+        $excludeCases = require __DIR__.'/../config/ignoredFunctions.php';
+        return array_diff($functionNames, $excludeCases);
     }
 
 

lib/special_cases.php

@@ -161,6 +161,22 @@ function preg_replace($pattern, $replacement, $subject, int $limit = -1, int &$c
     return $result;
 }
 
+/**
+ * @param resource|null $dir_handle
+ * @return string|false
+ * @deprecated
+ * This function is only in safe because the php documentation is wrong
+ */
+function readdir($dir_handle = null)
+{
+    if ($dir_handle !== null) {
+        $result = \readdir($dir_handle);
+    } else {
+        $result = \readdir();
+    }
+    return $result;
+}
+
 /**
  * Encrypts given data with given method and key, returns a raw
  * or base64 encoded string

rector-migrate.yml

@@ -88,7 +88,6 @@ services:
       chroot: 'Safe\chroot'
       getcwd: 'Safe\getcwd'
       opendir: 'Safe\opendir'
-      readdir: 'Safe\readdir'
       rewinddir: 'Safe\rewinddir'
       scandir: 'Safe\scandir'
       eio_busy: 'Safe\eio_busy'