Class: FileList
Source Location: /PHP_CodeSniffer-3.0.0RC2/src/Files/FileList.php
Represents a list of files on the file system that are to be checked during the run.
Author(s):
Copyright:
- 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600)
Inherited Variables
Inherited Methods
Class Details
[line
18]
Represents a list of files on the file system that are to be checked during the run.
File objects are created as needed rather than all at once.
Class Variables
$config = null
[line 40]
The config data for the run.
Type:
\PHP_CodeSniffer\Config
$ignorePatterns = array()
[line 54]
An array of patterns to use for skipping files.
$ruleset = null
[line 47]
The ruleset used for the run.
Type:
\PHP_CodeSniffer\Ruleset
Method Detail
__construct (Constructor) [line 65]
void __construct(
Config
$config, Ruleset
$ruleset)
Constructs a file list and loads in an array of file paths to process.
Parameters:
\PHP_CodeSniffer\Config
$config
—
The config data for the run.
\PHP_CodeSniffer\Ruleset
$ruleset
—
The ruleset used for the run.
addFile [line 109]
void addFile(
string
$path, [\PHP_CodeSniffer\Files\File
$file = null])
Add a file to the list.
If a file object has already been created, it can be passed here. If it is left NULL, it will be created when accessed.
Parameters:
string
$path
—
The path to the file being added.
\PHP_CodeSniffer\Files\File
$file
—
The file being added.
count [line 236]
Return the number of files in the list.
current [line 179]
\PHP_CodeSniffer\Files\File current(
)
Get the file that is currently being processed.
key [line 196]
Return the file path of the current file being processed.
next [line 208]
Move forward to the next file.
rewind [line 167]
Rewind the iterator to the first file.
valid [line 220]
Checks if current position is valid.
Documentation generated on 2019年3月11日 14:49:40 -0400 by
phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.