diogo/symfony
Archived
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add SplFileInfo array doc on Finder iterator methods so that IDE will know what it returns

Browse Source
This commit is contained in:
Daniel Espendiller 2016-05-06 13:34:38 +02:00 committed by Fabien Potencier
parent f8f624b0d5
commit 94b9e44993
1 changed files with 25 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
src/Symfony/Component/Finder/Finder.php
View File

@ -171,7 +171,7 @@ class Finder implements \IteratorAggregate, \Countable
/** /**
* Restricts the matching to directories only. * Restricts the matching to directories only.
* *
* @return Finder The current Finder instance * @return Finder|SplFileInfo[] The current Finder instance
*/ */
public function directories() public function directories()
{ {
@ -183,7 +183,7 @@ class Finder implements \IteratorAggregate, \Countable
/** /**
* Restricts the matching to files only. * Restricts the matching to files only.
* *
* @return Finder The current Finder instance * @return Finder|SplFileInfo[] The current Finder instance
*/ */
public function files() public function files()
{ {
@ -202,7 +202,7 @@ class Finder implements \IteratorAggregate, \Countable
* *
* @param int $level The depth level expression * @param int $level The depth level expression
* *
* @return Finder The current Finder instance * @return Finder|SplFileInfo[] The current Finder instance
* *
* @see DepthRangeFilterIterator * @see DepthRangeFilterIterator
* @see NumberComparator * @see NumberComparator
@ -226,7 +226,7 @@ class Finder implements \IteratorAggregate, \Countable
* *
* @param string $date A date range string * @param string $date A date range string
* *
* @return Finder The current Finder instance * @return Finder|SplFileInfo[] The current Finder instance
* *
* @see strtotime * @see strtotime
* @see DateRangeFilterIterator * @see DateRangeFilterIterator
@ -250,7 +250,7 @@ class Finder implements \IteratorAggregate, \Countable
* *
* @param string $pattern A pattern (a regexp, a glob, or a string) * @param string $pattern A pattern (a regexp, a glob, or a string)
* *
* @return Finder The current Finder instance * @return Finder|SplFileInfo[] The current Finder instance
* *
* @see FilenameFilterIterator * @see FilenameFilterIterator
*/ */
@ -266,7 +266,7 @@ class Finder implements \IteratorAggregate, \Countable
* *
* @param string $pattern A pattern (a regexp, a glob, or a string) * @param string $pattern A pattern (a regexp, a glob, or a string)
* *
* @return Finder The current Finder instance * @return Finder|SplFileInfo[] The current Finder instance
* *
* @see FilenameFilterIterator * @see FilenameFilterIterator
*/ */
@ -287,7 +287,7 @@ class Finder implements \IteratorAggregate, \Countable
* *
* @param string $pattern A pattern (string or regexp) * @param string $pattern A pattern (string or regexp)
* *
* @return Finder The current Finder instance * @return Finder|SplFileInfo[] The current Finder instance
* *
* @see FilecontentFilterIterator * @see FilecontentFilterIterator
*/ */
@ -308,7 +308,7 @@ class Finder implements \IteratorAggregate, \Countable
* *
* @param string $pattern A pattern (string or regexp) * @param string $pattern A pattern (string or regexp)
* *
* @return Finder The current Finder instance * @return Finder|SplFileInfo[] The current Finder instance
* *
* @see FilecontentFilterIterator * @see FilecontentFilterIterator
*/ */
@ -331,7 +331,7 @@ class Finder implements \IteratorAggregate, \Countable
* *
* @param string $pattern A pattern (a regexp or a string) * @param string $pattern A pattern (a regexp or a string)
* *
* @return Finder The current Finder instance * @return Finder|SplFileInfo[] The current Finder instance
* *
* @see FilenameFilterIterator * @see FilenameFilterIterator
*/ */
@ -354,7 +354,7 @@ class Finder implements \IteratorAggregate, \Countable
* *
* @param string $pattern A pattern (a regexp or a string) * @param string $pattern A pattern (a regexp or a string)
* *
* @return Finder The current Finder instance * @return Finder|SplFileInfo[] The current Finder instance
* *
* @see FilenameFilterIterator * @see FilenameFilterIterator
*/ */
@ -374,7 +374,7 @@ class Finder implements \IteratorAggregate, \Countable
* *
* @param string $size A size range string * @param string $size A size range string
* *
* @return Finder The current Finder instance * @return Finder|SplFileInfo[] The current Finder instance
* *
* @see SizeRangeFilterIterator * @see SizeRangeFilterIterator
* @see NumberComparator * @see NumberComparator
@ -391,7 +391,7 @@ class Finder implements \IteratorAggregate, \Countable
* *
* @param string|array $dirs A directory path or an array of directories * @param string|array $dirs A directory path or an array of directories
* *
* @return Finder The current Finder instance * @return Finder|SplFileInfo[] The current Finder instance
* *
* @see ExcludeDirectoryFilterIterator * @see ExcludeDirectoryFilterIterator
*/ */
@ -407,7 +407,7 @@ class Finder implements \IteratorAggregate, \Countable
* *
* @param bool $ignoreDotFiles Whether to exclude "hidden" files or not * @param bool $ignoreDotFiles Whether to exclude "hidden" files or not
* *
* @return Finder The current Finder instance * @return Finder|SplFileInfo[] The current Finder instance
* *
* @see ExcludeDirectoryFilterIterator * @see ExcludeDirectoryFilterIterator
*/ */
@ -427,7 +427,7 @@ class Finder implements \IteratorAggregate, \Countable
* *
* @param bool $ignoreVCS Whether to exclude VCS files or not * @param bool $ignoreVCS Whether to exclude VCS files or not
* *
* @return Finder The current Finder instance * @return Finder|SplFileInfo[] The current Finder instance
* *
* @see ExcludeDirectoryFilterIterator * @see ExcludeDirectoryFilterIterator
*/ */
@ -467,7 +467,7 @@ class Finder implements \IteratorAggregate, \Countable
* *
* @param \Closure $closure An anonymous function * @param \Closure $closure An anonymous function
* *
* @return Finder The current Finder instance * @return Finder|SplFileInfo[] The current Finder instance
* *
* @see SortableIterator * @see SortableIterator
*/ */
@ -483,7 +483,7 @@ class Finder implements \IteratorAggregate, \Countable
* *
* This can be slow as all the matching files and directories must be retrieved for comparison. * This can be slow as all the matching files and directories must be retrieved for comparison.
* *
* @return Finder The current Finder instance * @return Finder|SplFileInfo[] The current Finder instance
* *
* @see SortableIterator * @see SortableIterator
*/ */
@ -499,7 +499,7 @@ class Finder implements \IteratorAggregate, \Countable
* *
* This can be slow as all the matching files and directories must be retrieved for comparison. * This can be slow as all the matching files and directories must be retrieved for comparison.
* *
* @return Finder The current Finder instance * @return Finder|SplFileInfo[] The current Finder instance
* *
* @see SortableIterator * @see SortableIterator
*/ */
@ -517,7 +517,7 @@ class Finder implements \IteratorAggregate, \Countable
* *
* This can be slow as all the matching files and directories must be retrieved for comparison. * This can be slow as all the matching files and directories must be retrieved for comparison.
* *
* @return Finder The current Finder instance * @return Finder|SplFileInfo[] The current Finder instance
* *
* @see SortableIterator * @see SortableIterator
*/ */
@ -537,7 +537,7 @@ class Finder implements \IteratorAggregate, \Countable
* *
* This can be slow as all the matching files and directories must be retrieved for comparison. * This can be slow as all the matching files and directories must be retrieved for comparison.
* *
* @return Finder The current Finder instance * @return Finder|SplFileInfo[] The current Finder instance
* *
* @see SortableIterator * @see SortableIterator
*/ */
@ -555,7 +555,7 @@ class Finder implements \IteratorAggregate, \Countable
* *
* This can be slow as all the matching files and directories must be retrieved for comparison. * This can be slow as all the matching files and directories must be retrieved for comparison.
* *
* @return Finder The current Finder instance * @return Finder|SplFileInfo[] The current Finder instance
* *
* @see SortableIterator * @see SortableIterator
*/ */
@ -574,7 +574,7 @@ class Finder implements \IteratorAggregate, \Countable
* *
* @param \Closure $closure An anonymous function * @param \Closure $closure An anonymous function
* *
* @return Finder The current Finder instance * @return Finder|SplFileInfo[] The current Finder instance
* *
* @see CustomFilterIterator * @see CustomFilterIterator
*/ */
@ -588,7 +588,7 @@ class Finder implements \IteratorAggregate, \Countable
/** /**
* Forces the following of symlinks. * Forces the following of symlinks.
* *
* @return Finder The current Finder instance * @return Finder|SplFileInfo[] The current Finder instance
*/ */
public function followLinks() public function followLinks()
{ {
@ -604,7 +604,7 @@ class Finder implements \IteratorAggregate, \Countable
* *
* @param bool $ignore * @param bool $ignore
* *
* @return Finder The current Finder instance * @return Finder|SplFileInfo[] The current Finder instance
*/ */
public function ignoreUnreadableDirs($ignore = true) public function ignoreUnreadableDirs($ignore = true)
{ {
@ -618,7 +618,7 @@ class Finder implements \IteratorAggregate, \Countable
* *
* @param string|array $dirs A directory path or an array of directories * @param string|array $dirs A directory path or an array of directories
* *
* @return Finder The current Finder instance * @return Finder|SplFileInfo[] The current Finder instance
* *
* @throws \InvalidArgumentException if one of the directories does not exist * @throws \InvalidArgumentException if one of the directories does not exist
*/ */
@ -679,7 +679,7 @@ class Finder implements \IteratorAggregate, \Countable
* *
* @param mixed $iterator * @param mixed $iterator
* *
* @return Finder The finder * @return Finder|SplFileInfo[] The finder
* *
* @throws \InvalidArgumentException When the given argument is not iterable. * @throws \InvalidArgumentException When the given argument is not iterable.
*/ */