Weave Code
Flyfinder Laravel Package
phpdocumentor/flyfinder
FlyFinder is a utility for Flysystem that finds files by criteria such as hidden status, extension, or path, with wildcard path support. It returns files only, not directories, and integrates easily via Composer.
Flysystem plugin to add file finding capabilities to the Filesystem entity
Frequently asked questions about Flyfinder
- What is phpdocumentor/flyfinder used for in a Laravel app?
- FlyFinder searches a Flysystem filesystem for files matching criteria such as hidden status, file extension, or path with wildcard support, and it returns files only, not directories. In Laravel it fits CLI-heavy Artisan commands rather than web routes or Blade templates. Pair it with a Flysystem-backed disk, such as the local adapter, when building file navigation or setup utilities.
- How do I install phpdocumentor/flyfinder with Composer?
- Install it with composer require phpdocumentor/flyfinder:^2.0.1 so you get the Flysystem 3 Glob fix. Before adoption, inspect the now-public composer.json for Symfony Console, Flysystem, and PHP constraints against your Laravel version. The package uses Composer and has a clean API for initial integration.
- Does FlyFinder work with Laravel's Storage facade and Flysystem 3?
- FlyFinder operates on a League Flysystem Filesystem instance, so in Laravel you pair it with the Flysystem disk behind Storage where available. Current Laravel releases use Flysystem 3, and version 2.0.1 includes an explicit Flysystem 3 compatibility fix. Use it in CLI code paths, not in web features or Blade templates.
- Which Laravel versions is FlyFinder compatible with?
- FlyFinder has no Laravel-specific version constraints; compatibility depends on the Symfony Console version used by your Laravel release, the Flysystem major version, and the PHP floor. Laravel 10 aligns with Symfony Console 6.4+, while Laravel 11 and 12 use higher versions, so verify constraints in the public composer.json. Check transitive dependencies before adoption.
- How do I find files by extension or hidden status with FlyFinder?
- Create a Finder with the Flysystem filesystem, then pass specifications such as HasExtension, IsHidden, or InPath to describe what to match. FlyFinder returns matching files only, not directories. InPath paths are treated as relative to the filesystem root.
- Can FlyFinder search paths with wildcards?
- Yes, the InPath specification supports wildcards when matching file paths. Treat the path as relative to the root of the Flysystem filesystem you passed to Finder. This works with any Flysystem adapter, including the local adapter.
- Is FlyFinder safe to use in production Laravel commands?
- FlyFinder's production risk is moderate because the project is small, has low popularity, and has no published security response process. The 2.0.1 release fixes Glob behavior that could otherwise write into Flysystem 3 attributes, so pin to 2.0.1 or later. Pilot it in a low-risk dev-only Artisan command, wrap it in a service class, and validate terminal behavior across operating systems before broader adoption.
- How do I test FlyFinder in a Laravel Artisan command?
- Use a local Flysystem adapter pointed at a temporary directory, or a fake filesystem, and assert that Finder returns only the expected files. Cover extension matching, hidden files and hidden directories, and wildcard InPath cases. Because 2.0.1 patched Glob behavior for Flysystem 3, test that path specifically on a Flysystem 3 disk.
- What are alternatives to FlyFinder for finding files in Laravel?
- You can iterate a Flysystem filesystem with listContents and filter results yourself, use Symfony Finder for purely local files, or rely on Laravel Storage helpers where they fit. FlyFinder adds specification-based matching for hidden status, extension, and wildcard paths and returns files only. For simple CLI utilities, native Symfony Console and Symfony Finder may be enough.
- How is phpdocumentor/flyfinder maintained and what are the risks?
- The repository is public and the 2.0.x patch release plus merged community PR #89 show some maintenance activity. However, popularity is low, the contributor base is small, and there is no published security disclosure process. Review upgrades before merging and keep a fork-and-patch contingency for critical commands.
Weaver
How can I help you explore Laravel packages today?