acadea/dir-iterator

A simple PHP library to recursively find all files in a directory.

v1.0.1 2021-06-17 06:28 UTC

Requires

• php: ^7.4
• symfony/finder: ^5.3

Requires (Dev)

• friendsofphp/php-cs-fixer: ^2.17
• phpunit/phpunit: ^9.5
• spatie/phpunit-watcher: ^1.23
• spatie/ray: ^1.10
• vimeo/psalm: ^4.3

MIT

• sam-ngu

• acadea
• php directory iterator
• recursive directory iterator

README

A lightweight PHP package to recursively iterate through a folder with ease. Based on Symfony's Finder and PHP's Recursive Iterator

Support us

We invest a lot of resources into creating open source packages. You can support us by subscribing to our Youtube channel (we have a lot of tutorials on web development!) or by joining our Learning Portal.

Installation

You can install the package via composer:

composer require acadea/dir-iterator

Usage

// get all the files in a folder
// $file is an array of SplFileInfo object
$files = \Acadea\DirIterator\DirIterator::getFiles('path/to/folder');

// recursively iterate through a folder
\Acadea\DirIterator\DirIterator::iterate('path/to/folder', function (SplFileInfo $fileInfo, string $filePath){
    // ....
}); 

// map all the files in a folder
$results = \Acadea\DirIterator\DirIterator::map('path/to/folder', function (SplFileInfo $fileInfo, string $filePath){
    // ... 
    return 'something';
});

print_r($results); // $results should be an array of 'something'

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• sam-ngu
• All Contributors

License

The MIT License (MIT). Please see License File for more information.