Documentation

MultiplePcreFilterIterator extends FilterIterator
in package

MultiplePcreFilterIterator filters files using patterns (regexps, globs or strings).

Tags
author

Fabien Potencier fabien@symfony.com

template-covariant

TKey

template-covariant

TValue

extends

\FilterIterator<TKey, TValue>

Table of Contents

$matchRegexps  : mixed
$noMatchRegexps  : mixed
__construct()  : mixed
isAccepted()  : bool
Checks whether the string is accepted by the regex filters.
isRegex()  : bool
Checks whether the string is a regex.
toRegex()  : string
Converts string into regexp.

Properties

Methods

__construct()

public __construct(Iterator $iterator, array<string|int, string> $matchPatterns, array<string|int, string> $noMatchPatterns) : mixed
Parameters
$iterator : Iterator

The Iterator to filter

$matchPatterns : array<string|int, string>

An array of patterns that need to match

$noMatchPatterns : array<string|int, string>

An array of patterns that need to not match

Return values
mixed —

isAccepted()

Checks whether the string is accepted by the regex filters.

protected isAccepted(string $string) : bool

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
Return values
bool —

isRegex()

Checks whether the string is a regex.

protected isRegex(string $str) : bool
Parameters
$str : string
Return values
bool —

toRegex()

Converts string into regexp.

protected abstract toRegex(string $str) : string
Parameters
$str : string
Return values
string —

Search results