summaryrefslogtreecommitdiffstats
path: root/vendor/symfony/finder/Symfony/Component/Finder/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/symfony/finder/Symfony/Component/Finder/README.md')
-rw-r--r--vendor/symfony/finder/Symfony/Component/Finder/README.md53
1 files changed, 0 insertions, 53 deletions
diff --git a/vendor/symfony/finder/Symfony/Component/Finder/README.md b/vendor/symfony/finder/Symfony/Component/Finder/README.md
deleted file mode 100644
index 413cdf5..0000000
--- a/vendor/symfony/finder/Symfony/Component/Finder/README.md
+++ /dev/null
@@ -1,53 +0,0 @@
-Finder Component
-================
-
-Finder finds files and directories via an intuitive fluent interface.
-
-```php
-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][1].
-Besides the build-in methods inherited from [\SplFileInfo][2] (`getPerms()`, `getSize()`, ...),
-you can also use `getRelativePath()` and `getRelativePathname()`. Read the
-[official documentation][3] 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:
-
-```php
-$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
-
-[1]: http://api.symfony.com/2.5/Symfony/Component/Finder/SplFileInfo.html
-[2]: http://php.net/splfileinfo
-[3]: http://symfony.com/doc/current/components/finder.html#usage