Filter
extends RecursiveFilterIterator
in package
Table of Contents
- $acceptedPaths : array<string|int, mixed>
- A list of file paths we've already accepted.
- $basedir : string
- The top-level path we are filtering.
- $config : Config
- The config data for the run.
- $ignoreDirPatterns : array<string|int, mixed>
- A list of ignore patterns that apply to directories only.
- $ignoreFilePatterns : array<string|int, mixed>
- A list of ignore patterns that apply to files only.
- $ruleset : Ruleset
- The ruleset used for the run.
- __construct() : void
- Constructs a filter.
- accept() : bool
- Check whether the current element of the iterator is acceptable.
- getChildren() : RecursiveIterator
- Returns an iterator for the current entry.
- shouldIgnorePath() : bool
- Checks filtering rules to see if a path should be ignored.
- shouldProcessFile() : bool
- Checks filtering rules to see if a file should be checked.
Properties
$acceptedPaths
A list of file paths we've already accepted.
protected
array<string|int, mixed>
$acceptedPaths
= []
Used to ensure we aren't following circular symlinks.
$basedir
The top-level path we are filtering.
protected
string
$basedir
= null
$config
The config data for the run.
protected
Config
$config
= null
$ignoreDirPatterns
A list of ignore patterns that apply to directories only.
protected
array<string|int, mixed>
$ignoreDirPatterns
= null
$ignoreFilePatterns
A list of ignore patterns that apply to files only.
protected
array<string|int, mixed>
$ignoreFilePatterns
= null
$ruleset
The ruleset used for the run.
protected
Ruleset
$ruleset
= null
Methods
__construct()
Constructs a filter.
public
__construct(RecursiveIterator $iterator, string $basedir, Config $config, Ruleset $ruleset) : void
Parameters
- $iterator : RecursiveIterator
-
The iterator we are using to get file paths.
- $basedir : string
-
The top-level path we are filtering.
- $config : Config
-
The config data for the run.
- $ruleset : Ruleset
-
The ruleset used for the run.
Return values
void —accept()
Check whether the current element of the iterator is acceptable.
public
accept() : bool
Files are checked for allowed extensions and ignore patterns. Directories are checked for ignore patterns only.
Return values
bool —getChildren()
Returns an iterator for the current entry.
public
getChildren() : RecursiveIterator
Ensures that the ignore patterns are preserved so they don't have to be generated each time.
Return values
RecursiveIterator —shouldIgnorePath()
Checks filtering rules to see if a path should be ignored.
protected
shouldIgnorePath(string $path) : bool
Parameters
- $path : string
-
The path to the file or directory being checked.
Return values
bool —shouldProcessFile()
Checks filtering rules to see if a file should be checked.
protected
shouldProcessFile(string $path) : bool
Checks both file extension filters and path ignore filters.
Parameters
- $path : string
-
The path to the file being checked.