[line 61]
PHP_CodeSniffer tokenises PHP code and detects violations of a defined set of coding standards.
Standards are specified by classes that implement the PHP_CodeSniffer_Sniff interface. A sniff registers what token types it wishes to listen for, then PHP_CodeSniffer encounters that token, the sniff is invoked and passed information about where the token was found in the stack, and the token stack itself.
Sniff files and their containing class must be prefixed with Sniff, and have an extension of .php.
Multiple PHP_CodeSniffer operations can be performed by re-calling the process function with different parameters.
$allowedFileExtensions = array(
'php',
'inc',
)
[line 104]
An array of extensions for files we will check.
$allowedTypes = array(
'array',
'boolean',
'float',
'integer',
'mixed',
'object',
'string',
)
[line 114]
An array of variable types for param/var we will check.
$file = array()
[line 69]
The file or directory that is currently being processed.
$files = array()
[line 83]
The files that have been processed.
Type:
array(PHP_CodeSniffer_File)
$ignorePatterns = array()
[line 97]
An array of patterns to use for skipping files.
$listeners = array()
[line 90]
The listeners array.
Type:
array(PHP_CodeSniffer_Sniff)
$standardDir = ''
[line 76]
The directory where to search for tests.
__construct (Constructor) [line 137]
PHP_CodeSniffer __construct(
[int
$verbosity = 0], [int
$tabWidth = 0])
Constructs a PHP_CodeSniffer object.
Parameters:
int
$verbosity
—
The verbosity level. 1: Print progress information. 2: Print developer debug information.
int
$tabWidth
—
The number of spaces each tab represents. If greater than zero, tabs will be replaced by spaces before testing each file.
autoload [line 156]
void autoload(
string
$className)
Autoload static method for loading classes and interfaces.
Parameters:
string
$className
—
The name of the class or interface.
generateDocs [line 1007]
void generateDocs(
string
$standard, [array
$sniffs = array()], [string
$generator = 'Text'])
Generates documentation for a coding standard.
Parameters:
string
$standard
—
The standard to generate docs for
array
$sniffs
—
A list of sniffs to limit the docs to.
string
$generator
—
The name of the generator class to use.
getAllConfigData [line 1572]
string getAllConfigData(
)
Get all config data in an array.
getConfigData [line 1490]
string getConfigData(
string
$key)
Get a single config value.
Config data is stored in the data dir, in a file called CodeSniffer.conf. It is a simple PHP array.
Parameters:
string
$key
—
The name of the config value.
getFiles [line 1024]
array(PHP_CodeSniffer_File) getFiles(
)
Returns the PHP_CodeSniffer file objects.
getInstalledStandards [line 1418]
array getInstalledStandards(
[boolean
$includeGeneric = false], [string
$standardsDir = ''])
Get a list of all coding standards installed.
Coding standards are directories located in the CodeSniffer/Standards directory. Valid coding standards include a Sniffs subdirectory.
Parameters:
boolean
$includeGeneric
—
If true, the special "Generic" coding standard will be included if installed.
string
$standardsDir
—
A specific directory to look for standards in. If not specified, PHP_CodeSniffer will look in its default location.
getSniffFiles [line 354]
array getSniffFiles(
string
$dir, [string
$standard = null])
Return a list of sniffs that a coding standard has defined.
Sniffs are found by recursing the standard directory and also by asking the standard for included sniffs.
- Throws: PHP_CodeSniffer_Exception If an included or excluded sniff does not exist.
- Access: public
Parameters:
string
$dir
—
The directory where to look for the files.
string
$standard
—
The name of the coding standard. If NULL, no included sniffs will be checked for.
getSniffs [line 1036]
array(PHP_CodeSniffer_Sniff) getSniffs(
)
Gets the array of PHP_CodeSniffer_Sniff's.
isCamelCaps [line 1237]
boolean isCamelCaps(
string
$string, [boolean
$classFormat = false], [boolean
$public = true], [boolean
$strict = true])
Returns true if the specified string is in the camel caps format.
Parameters:
string
$string
—
The string the verify.
boolean
$classFormat
—
If true, check to see if the string is in the class format. Class format strings must start with a capital letter and contain no underscores.
boolean
$public
—
If true, the first character in the string must be an a-z character. If false, the character must be an underscore. This argument is only applicable if $classFormat is false.
boolean
$strict
—
If true, the string must not have two captial letters next to each other. If false, a relaxed camel caps policy is used to allow for acronyms.
isInstalledStandard [line 1462]
boolean isInstalledStandard(
string
$standard)
Determine if a standard is installed.
Coding standards are directories located in the CodeSniffer/Standards directory. Valid coding standards include a Sniffs subdirectory.
Parameters:
string
$standard
—
The name of the coding standard.
isUnderscoreName [line 1303]
boolean isUnderscoreName(
string
$string)
Returns true if the specified string is in the underscore caps format.
Parameters:
string
$string
—
The string to verify.
prepareErrorReport [line 590]
array prepareErrorReport(
[boolean
$showWarnings = true])
Pre-process and package errors and warnings for all files.
Used by error reports to get a packaged list of all errors and warnings in each file.
Parameters:
boolean
$showWarnings
—
Show warnings as well as errors.
printCheckstyleErrorReport [line 741]
int printCheckstyleErrorReport(
[boolean
$showWarnings = true])
Prints all errors and warnings for each file processed, in a Checkstyle XML format.
Errors and warnings are displayed together, grouped by file.
- Return: The number of error and warning messages shown.
- Access: public
Parameters:
boolean
$showWarnings
—
Show warnings as well as errors.
printCSVErrorReport [line 786]
int printCSVErrorReport(
[boolean
$showWarnings = true])
Prints all errors and warnings for each file processed, in a CSV format.
- Return: The number of error and warning messages shown.
- Access: public
Parameters:
boolean
$showWarnings
—
Show warnings as well as errors.
printErrorReport [line 823]
int printErrorReport(
[boolean
$showWarnings = true])
Prints all errors and warnings for each file processed.
Errors and warnings are displayed together, grouped by file.
- Return: The number of error and warning messages shown.
- Access: public
Parameters:
boolean
$showWarnings
—
Show warnings as well as errors.
printErrorReportSummary [line 920]
int printErrorReportSummary(
[boolean
$showWarnings = true])
Prints a summary of errors and warnings for each file processed.
If verbose output is enabled, results are shown for all files, even if they have no errors or warnings. If verbose output is disabled, we only show files that have at least one warning or error.
- Return: The number of error and warning messages shown.
- Access: public
Parameters:
boolean
$showWarnings
—
Show warnings as well as errors.
printXMLErrorReport [line 694]
int printXMLErrorReport(
[boolean
$showWarnings = true])
Prints all errors and warnings for each file processed, in an XML format.
Errors and warnings are displayed together, grouped by file.
- Return: The number of error and warning messages shown.
- Access: public
Parameters:
boolean
$showWarnings
—
Show warnings as well as errors.
process [line 225]
void process(
string|array
$files, string
$standard, [array
$sniffs = array()], [boolean
$local = false])
Processes the files/directories that PHP_CodeSniffer was constructed with.
- Throws: PHP_CodeSniffer_Exception If files or standard are invalid.
- Access: public
Parameters:
string|array
$files
—
The files and directories to process. For directories, each sub directory will also be traversed for source files.
string
$standard
—
The set of code sniffs we are testing against.
array
$sniffs
—
The sniff names to restrict the allowed listeners to.
boolean
$local
—
If true, don't recurse into directories.
processFile [line 531]
void processFile(
string
$file)
Run the code sniffs over a single given file.
Processes the file and runs the PHP_CodeSniffer sniffs to verify that it conforms with the standard.
- Throws: PHP_CodeSniffer_Exception If the file could not be processed.
- Access: protected
Parameters:
string
$file
—
The file to process.
processFiles [line 485]
void processFiles(
string
$dir, [boolean
$local = false])
Run the code sniffs over each file in a given directory.
Recusively reads the specified directory and performs the PHP_CodeSniffer sniffs on each source file found within the directories.
- Throws: Exception If there was an error opening the directory.
- Access: protected
Parameters:
string
$dir
—
The directory to process.
boolean
$local
—
If true, only process files in this directory, not sub directories.
registerTokenListeners [line 291]
void registerTokenListeners(
string
$standard, [array
$sniffs = array()])
Registers installed sniffs in the coding standard being used.
Traverses the standard directory for classes that implement the PHP_CodeSniffer_Sniff interface asks them to register. Each of the sniff's class names must be exact as the basename of the sniff file.
- Throws: PHP_CodeSniffer_Exception If any of the tests failed in the registration process.
- Access: protected
Parameters:
string
$standard
—
The name of the coding standard we are checking.
array
$sniffs
—
The sniff names to restrict the allowed listeners to.
resolveSimpleToken [line 1129]
array resolveSimpleToken(
string
$token)
Converts simple tokens into a format that conforms to complex tokens produced by token_get_all().
Simple tokens are tokens that are not in array form when produced from token_get_all().
- Return: The new token in array format.
- Access: public
Parameters:
string
$token
—
The simple token to convert.
resolveTstringToken [line 1086]
array resolveTstringToken(
array
$token)
Converts T_STRING tokens into more usable token names.
The token should be produced using the token_get_all() function. Currently, not all T_STRING tokens are converted.
- Return: The new token.
- Access: public
Parameters:
string|array
$token
—
The T_STRING token to convert as constructed by token_get_all().
setAllowedFileExtensions [line 187]
void setAllowedFileExtensions(
array
$extensions)
Sets an array of file extensions that we will allow checking of.
Parameters:
array
$extensions
—
An array of file extensions.
setConfigData [line 1525]
boolean setConfigData(
string
$key, string|null
$value, [boolean
$temp = false])
Set a single config value.
Config data is stored in the data dir, in a file called CodeSniffer.conf. It is a simple PHP array.
Parameters:
string
$key
—
The name of the config value.
string|null
$value
—
The value to set. If null, the config entry is deleted, reverting it to the default value.
boolean
$temp
—
Set this config data temporarily for this script run. This will not write the config data to the config file.
setIgnorePatterns [line 203]
void setIgnorePatterns(
array
$patterns)
Sets an array of ignore patterns that we use to skip files and folders.
Patterns are not case sensitive.
Parameters:
array
$patterns
—
An array of ignore patterns.
standardiseToken [line 1054]
array standardiseToken(
string|array
$token)
Takes a token produced from
and produces a more uniform token.
Note that this method also resolves T_STRING tokens into more descrete types, therefore there is no need to call resolveTstringToken()
- Return: The new token.
- Access: public
Parameters:
string|array
$token
—
The token to convert.
suggestType [line 1340]
string suggestType(
string
$varType)
Returns a valid variable type for param/var tag.
If type is not one of the standard type, it must be a custom type. Returns the correct type name suggestion if type name is invalid.
Parameters:
string
$varType
—
The variable type to process.