[line 48]
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.
__construct (Constructor) [line 115]
PHP_CodeSniffer __construct(
[int
$verbosity = 0])
Constructs a PHP_CodeSniffer object.
Parameters:
int
$verbosity
—
The verbosity level. 1: Print progress information. 2: Print developer debug information.
getFiles [line 615]
array(PHP_CodeSniffer_File) getFiles(
)
Returns the PHP_CodeSniffer file objects.
getInstalledStandards [line 967]
array getInstalledStandards(
[boolean
$includeGeneric = false])
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.
isCamelCaps [line 816]
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 1007]
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 871]
boolean isUnderscoreName(
string
$string)
Returns true if the specified string is in the underscore caps format.
Parameters:
string
$string
—
The string to verify.
printErrorReport [line 401]
void printErrorReport(
[boolean
$showWarnings = true])
Prints all errors and warnings for each file processed.
Errors and warnings are displayed together, grouped by file.
Parameters:
boolean
$showWarnings
—
Show warnings as well as errors.
printErrorReportSummary [line 534]
void 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.
Parameters:
boolean
$showWarnings
—
Show warnings as well as errors.
process [line 150]
void process(
string|array
$files, string
$standard, [array
$sniffs = array()])
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.
resolveSimpleToken [line 708]
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 665]
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 129]
void setAllowedFileExtensions(
array
$extensions)
Sets an array of file extensions that we will allow checking of.
Parameters:
array
$extensions
—
An array of file extensions.
standardiseToken [line 633]
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 903]
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.