GitModified
extends ExactMatch
in package
Table of Contents
Properties
- $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.
- $isBasedirDir : bool
- Whether the basedir is a file or a directory.
- $ruleset : Ruleset
- The ruleset used for the run.
Methods
- __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.
- exec() : array<string|int, mixed>
- Execute an external command.
- getAllowedFiles() : array<string|int, mixed>
- Get a list of file paths to include.
- getDisallowedFiles() : array<string|int, mixed>
- Get a list of file paths to exclude.
- 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
$isBasedirDir
Whether the basedir is a file or a directory.
protected
bool
$isBasedirDir
= false
TRUE if the basedir is actually a directory.
$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
accept()
Check whether the current element of the iterator is acceptable.
public
accept() : bool
If a file is both disallowed and allowed, it will be deemed unacceptable.
Return values
boolgetChildren()
Returns an iterator for the current entry.
public
getChildren() : RecursiveIterator
Ensures that the disallowed files list and the allowed files list are preserved so they don't have to be generated each time.
Return values
RecursiveIteratorexec()
Execute an external command.
protected
exec(string $cmd) : array<string|int, mixed>
Parameters
- $cmd : string
-
Command.
Return values
array<string|int, mixed>getAllowedFiles()
Get a list of file paths to include.
protected
getAllowedFiles() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>getDisallowedFiles()
Get a list of file paths to exclude.
protected
getDisallowedFiles() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>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
boolshouldProcessFile()
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.