This repository has been archived on 2023-08-20. You can view files and clone it, but cannot push or open issues or pull requests.
symfony/src/Symfony/Component/Finder
Fabien Potencier e6cc4918bf Merge branch '2.3' into 2.6
* 2.3:
  Added 'default' color
  [HttpFoundation] Reload the session after regenerating its id
  [HttpFoundation] Add a test case to confirm a bug in session migration
  [Finder] Command::addAtIndex() fails with Command instance argument
  [DependencyInjection] Freeze also FrozenParameterBag::remove
  fix CS
  fixed CS
  Add a way to reset the singleton
  [Security] allow to use `method` in XML configs
  Remove var not used due to returning early (introduced in 8982c32)
  Enhance hhvm test skip message
2015-07-09 18:02:48 +02:00
..
Adapter CS: Binary operators should be arounded by at least one space 2015-03-27 23:05:05 +01:00
Comparator CS: Binary operators should be arounded by at least one space 2015-03-27 23:05:05 +01:00
Exception Merge branch '2.2' 2013-04-22 06:30:07 +02:00
Expression CS: Pre incrementation/decrementation should be used if possible 2015-04-07 19:54:22 +02:00
Iterator Merge branch '2.3' into 2.5 2014-12-30 14:32:44 +01:00
Shell Merge branch '2.3' into 2.6 2015-07-09 18:02:48 +02:00
Tests Merge branch '2.3' into 2.6 2015-07-09 18:02:48 +02:00
.gitignore Added missing files .gitignore 2013-07-21 14:12:18 +02:00
CHANGELOG.md [Finder] Included GLOB_BRACE support in the CHANGELOG. 2014-01-01 15:45:37 +00:00
composer.json Merge branch '2.3' into 2.6 2015-05-02 17:18:45 +02:00
Finder.php [Finder] Only use GLOB_BRACE when available 2015-05-01 15:39:14 +02:00
Glob.php CS: Pre incrementation/decrementation should be used if possible 2015-04-07 19:54:22 +02:00
LICENSE Updated copyright to 2015 2015-01-01 13:56:52 +01:00
phpunit.xml.dist [2.3] require-dev PHPUnit bridge 2015-02-24 11:24:26 +01:00
README.md link to https://symfony.com where possible 2015-05-01 16:06:45 +02:00
SplFileInfo.php [2.3] CS And DocBlock Fixes 2014-12-22 16:58:09 +01:00

Finder Component

Finder finds files and directories via an intuitive fluent interface.

use Symfony\Component\Finder\Finder;

$finder = new Finder();

$iterator = $finder
  ->files()
  ->name('*.php')
  ->depth(0)
  ->size('>= 1K')
  ->in(__DIR__);

foreach ($iterator as $file) {
    print $file->getRealpath()."\n";
}

The iterator returns instances of Symfony\Component\Finder\SplFileInfo\SplFileInfo. Besides the build-in methods inherited from \SplFileInfo (getPerms(), getSize(), ...), you can also use getRelativePath() and getRelativePathname(). Read the official documentation for more information.

But you can also use it to find files stored remotely like in this example where we are looking for files on Amazon S3:

$s3 = new \Zend_Service_Amazon_S3($key, $secret);
$s3->registerStreamWrapper("s3");

$finder = new Finder();
$finder->name('photos*')->size('< 100K')->date('since 1 hour ago');
foreach ($finder->in('s3://bucket-name') as $file) {
    print $file->getFilename()."\n";
}

Resources

You can run the unit tests with the following command:

$ cd path/to/Symfony/Component/Finder/
$ composer install
$ phpunit