A ruleset object directly maps to a ruleset XML file.
[line 51]
A list of regular expressions used to ignore specific sniffs for files and folders.Is also used to set global exclude patterns. The key is the regular expression and the value is the type of ignore pattern (absolute or relative).
[line 62]
A list of regular expressions used to include specific sniffs for files and folders.The key is the sniff code and the value is an array with the key being a regular expression and the value is the type of ignore pattern (absolute or relative).
[line 33]
The name of the coding standard being used.If a top-level standard includes other standards, or sniffs from other standards, only the name of the top-level standard will be stored in here.
If multiple top-level standards are being loaded into a single ruleset object, this will store a comma separated list of the top-level standard names.
[line 40]
A list of file paths for the ruleset files being used.[line 102]
An array of rules from the ruleset.xml file.It may be empty, indicating that the ruleset does not override any of the default sniff settings.
[line 109]
The directories that the processed rulesets are in.[line 82]
A mapping of sniff codes to fully qualified class names.The key is the sniff code and the value is the fully qualified name of the sniff class.
[line 72]
An array of sniff objects that are being used to check files.The key is the fully qualified name of the sniff class and the value is the sniff object.
[line 92]
An array of token types and the sniffs that are listening for them.The key is the token name being listened for and the value is the sniff object.
void __construct(
Config
$config)
array getIgnorePatterns(
[string
$listener = null])
Optionally takes a listener to get ignore patterns specified for that sniff only.
array getIncludePatterns(
[string
$listener = null])
Optionally takes a listener to get include patterns specified for that sniff only.
void populateTokenListeners(
)
string[] processRuleset(
string
$rulesetPath, [int
$depth = 0])
Rules founds within the ruleset are processed immediately, but sniff classes are not registered by this method.
void registerSniffs(
array
$files, array
$restrictions, array
$exclusions)
void setSniffProperty(
string
$sniffClass, string
$name, string
$value)