summaryrefslogtreecommitdiffstats
path: root/vendor/symfony/finder/Symfony/Component/Finder/README.md
diff options
context:
space:
mode:
authorStefan Suhren <suhren.stefan@fh-swf.de>2015-05-05 19:34:39 +0200
committerStefan Suhren <suhren.stefan@fh-swf.de>2015-05-05 19:34:39 +0200
commit705c4cb50eea66585cc95c7314001fce9dd197cd (patch)
tree4a448f4e30b117e12306b643121f49da15e6376b /vendor/symfony/finder/Symfony/Component/Finder/README.md
downloadCatalog-705c4cb50eea66585cc95c7314001fce9dd197cd.tar.gz
Catalog-705c4cb50eea66585cc95c7314001fce9dd197cd.zip
Initial commit
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, 53 insertions, 0 deletions
diff --git a/vendor/symfony/finder/Symfony/Component/Finder/README.md b/vendor/symfony/finder/Symfony/Component/Finder/README.md
new file mode 100644
index 0000000..413cdf5
--- /dev/null
+++ b/vendor/symfony/finder/Symfony/Component/Finder/README.md
@@ -0,0 +1,53 @@
+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