FilecontentFilterIterator
class FilecontentFilterIterator extends MultiplePcreFilterIterator
FilecontentFilterIterator filters files by their contents using patterns (regexps or strings).
Properties
| protected | $matchRegexps | from MultiplePcreFilterIterator | |
| protected | $noMatchRegexps | from MultiplePcreFilterIterator |
Methods
| __construct(Iterator $iterator, array $matchPatterns, array $noMatchPatterns) | from MultiplePcreFilterIterator | |
| bool | isAccepted(string $string) Checks whether the string is accepted by the regex filters. | from MultiplePcreFilterIterator |
| bool | isRegex(string $str) Checks whether the string is a regex. | from MultiplePcreFilterIterator |
| string | toRegex(string $str) Converts string to regexp if necessary. | |
| bool | accept() Filters the iterator values. |
Details
__construct(Iterator $iterator, array $matchPatterns, array $noMatchPatterns)
Parameters
| Iterator | $iterator | The Iterator to filter |
| array | $matchPatterns | An array of patterns that need to match |
| array | $noMatchPatterns | An array of patterns that need to not match |
protected bool isAccepted(string $string)
Checks whether the string is accepted by the regex filters.
If there is no regexps defined in the class, this method will accept the string. Such case can be handled by child classes before calling the method if they want to apply a different behavior.
Parameters
| string | $string | The string to be matched against filters |
Return Value
| bool |
protected bool isRegex(string $str)
Checks whether the string is a regex.
Parameters
| string | $str |
Return Value
| bool | Whether the given string is a regex |
protected string toRegex(string $str)
Converts string to regexp if necessary.
Parameters
| string | $str | Pattern |
Return Value
| string | regexp corresponding to a given string |
bool accept()
Filters the iterator values.
Return Value
| bool | true if the value should be kept, false otherwise |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Component/Finder/Iterator/FilecontentFilterIterator.html