Merge pull request symfony#1539 from gajdaw/finder_contents

weaverryan · weaverryan · commit 05a858d3756c · 2012-07-14T17:18:39.000-07:00
[Component][Finder]: info about getContents()
diff --git a/components/finder.rst b/components/finder.rst
@@ -242,6 +242,25 @@ it is called with the file as a :class:`Symfony\\Component\\Finder\\SplFileInfo`
 instance. The file is excluded from the result set if the Closure returns
 ``false``.
 
+Reading contents of returned files
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. versionadded:: 2.1
+   Method ``getContents()`` have been introduced in version 2.1.
+
+The contents of returned files can be read with
+:method:`Symfony\\Component\\Finder\\SplFileInfo::getContents`::
+
+    use Symfony\Component\Finder\Finder;
+
+    $finder = new Finder();
+    $finder->files()->in(__DIR__);
+
+    foreach ($finder as $file) {
+        $contents = $file->getContents();
+        ...
+    }
+
 .. _strtotime:   http://www.php.net/manual/en/datetime.formats.php
 .. _Iterator:     http://www.php.net/manual/en/spl.iterators.php
 .. _protocol:     http://www.php.net/manual/en/wrappers.php
