up: update some dir itertor methods

Author: inhere

src/Directory.php

@@ -9,7 +9,9 @@
 
 namespace Toolkit\FsUtil;
 
+use Closure;
 use InvalidArgumentException;
+use SplFileInfo;
 use Toolkit\FsUtil\Exception\FileNotFoundException;
 use Toolkit\FsUtil\Traits\DirOperateTrait;
 use function basename;

src/FileSystem.php

@@ -9,6 +9,7 @@
 
 namespace Toolkit\FsUtil;
 
+use FilesystemIterator;
 use InvalidArgumentException;
 use RecursiveCallbackFilterIterator;
 use RecursiveDirectoryIterator;
@@ -236,19 +237,34 @@ public static function check(string $file, array|string $ext = ''): void
     }
 
     /**
-     * @param string   $srcDir
+     * Usage:
+     *
+     * ```php
+     * $filter = Dir::getPhpFileFilter();
+     *
+     * // $info is instance of \SplFileInfo
+     * foreach(Dir::getIterator($srcDir, $filter) as $info) {
+     *    // $info->getFilename(); ...
+     * }
+     * ```
+     *
+     * @param string $srcDir
      * @param callable $filter
+     * @param int $flags
      *
      * @return RecursiveIteratorIterator
-     * @throws InvalidArgumentException
      */
-    public static function getIterator(string $srcDir, callable $filter): RecursiveIteratorIterator
+    public static function getIterator(
+        string $srcDir,
+        callable $filter,
+        int $flags = FilesystemIterator::KEY_AS_PATHNAME | FilesystemIterator::CURRENT_AS_FILEINFO
+    ): RecursiveIteratorIterator
     {
         if (!$srcDir || !file_exists($srcDir)) {
             throw new InvalidArgumentException('Please provide a exists source directory.');
         }
 
-        $directory      = new RecursiveDirectoryIterator($srcDir);
+        $directory      = new RecursiveDirectoryIterator($srcDir, $flags);
         $filterIterator = new RecursiveCallbackFilterIterator($directory, $filter);
 
         return new RecursiveIteratorIterator($filterIterator);

src/Traits/DirOperateTrait.php

@@ -2,12 +2,15 @@
 
 namespace Toolkit\FsUtil\Traits;
 
+use Closure;
 use DirectoryIterator;
 use LogicException;
 use RecursiveIteratorIterator;
+use SplFileInfo;
 use Throwable;
 use Toolkit\FsUtil\Exception\FileNotFoundException;
 use Toolkit\FsUtil\Exception\FileSystemException;
+use Toolkit\FsUtil\FileSystem;
 use function closedir;
 use function opendir;
 use function readdir;
@@ -20,23 +23,13 @@
 trait DirOperateTrait
 {
     /**
+     * Usage:
+     *
      * ```php
-     * $filter = function ($current, $key, $iterator) {
-     *  // \SplFileInfo $current
-     *  // Skip hidden files and directories.
-     *  if ($current->getFilename()[0] === '.') {
-     *      return false;
-     *  }
-     *  if ($current->isDir()) {
-     *      // Only recurse into intended subdirectories.
-     *      return $current->getFilename() !== '.git';
-     *  }
-     *      // Only consume files of interest.
-     *      return strpos($current->getFilename(), '.php') !== false;
-     * };
+     * $filter = Dir::getPhpFileFilter();
      *
      * // $info is instance of \SplFileInfo
-     * foreach(Directory::getRecursiveIterator($srcDir, $filter) as $info) {
+     * foreach(Dir::getRecursiveIterator($srcDir, $filter) as $info) {
      *    // $info->getFilename(); ...
      * }
      * ```
@@ -45,11 +38,33 @@ trait DirOperateTrait
      * @param callable $filter
      *
      * @return RecursiveIteratorIterator
-     * @throws LogicException
      */
     public static function getRecursiveIterator(string $srcDir, callable $filter): RecursiveIteratorIterator
     {
-        return self::getIterator($srcDir, $filter);
+        return FileSystem::getIterator($srcDir, $filter);
+    }
+
+    /**
+     * @return Closure
+     */
+    public static function getPhpFileFilter(): callable
+    {
+        return static function (SplFileInfo $f) {
+            $name = $f->getFilename();
+
+            // Skip hidden files and directories.
+            if (str_starts_with($name, '.')) {
+                return false;
+            }
+
+            // go on read sub-dir
+            if ($f->isDir()) {
+                return true;
+            }
+
+            // php file
+            return $f->isFile() && str_ends_with($name, '.php');
+        };
     }
 
     /**