Docs For Class PHP

__construct (Constructor) [line 163]

PHP_CodeSniffer __construct(
[int
$verbosity = 0], [int
$tabWidth = 0])

Constructs a PHP_CodeSniffer object.

See: PHP_CodeSniffer::process()
Access: public

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.

[ Top ]

__destruct (Destructor) [line 189]

void __destruct(
)

Destructs a PHP_CodeSniffer object.

Restores the current working directory to what it was before we started our run.

Access: public

[ Top ]

addFile [line 279]

void addFile(
PHP_CodeSniffer_File
$phpcsFile)

Adds a file to the list of checked files.

Checked files are used to generate error reports after the run.

Access: public

Parameters:

PHP_CodeSniffer_File $phpcsFile — The file to add.

[ Top ]

autoload [line 203]

void autoload(
string
$className)

Autoload static method for loading classes and interfaces.

Access: public

Parameters:

string $className — The name of the class or interface.

[ Top ]

generateDocs [line 1406]

void generateDocs(
string
$standard, [
$sniffs = array()], [string
$generator = 'Text'])

Generates documentation for a coding standard.

Access: public

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.

[ Top ]

getAllConfigData [line 2001]

string getAllConfigData(
)

Get all config data in an array.

See: PHP_CodeSniffer::getConfigData()
Access: public

[ Top ]

getConfigData [line 1917]

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.

See: PHP_CodeSniffer::setConfigData()
See: PHP_CodeSniffer::getAllConfigData()
Access: public

Parameters:

string $key — The name of the config value.

[ Top ]

getFiles [line 1423]

array(PHP_CodeSniffer_File) getFiles(
)

Returns the PHP_CodeSniffer file objects.

Access: public

[ Top ]

getInstalledStandards [line 1843]

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.

See: PHP_CodeSniffer::isInstalledStandard()
Access: public

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.

[ Top ]

getSniffFiles [line 515]

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.

[ Top ]

getSniffs [line 1435]

array(PHP_CodeSniffer_Sniff) getSniffs(
)

Gets the array of PHP_CodeSniffer_Sniff's.

Access: public

[ Top ]

getTokenListeners [line 381]

array getTokenListeners(
string
$standard, [
$sniffs = array()])

Gets 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.

Returns an array of sniff class names.

Throws: PHP_CodeSniffer_Exception If any of the tests failed in the registration process.
Access: public

Parameters:

string	`$standard`	—	The name of the coding standard we are checking.
array	`$sniffs`	—	The sniff names to restrict the allowed listeners to.

[ Top ]

getTokenSniffs [line 1447]

array() getTokenSniffs(
)

Gets the array of PHP_CodeSniffer_Sniff's indexed by token type.

Access: public

[ Top ]

isCamelCaps [line 1659]

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.

Access: public

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.

[ Top ]

isInstalledStandard [line 1889]

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.

See: PHP_CodeSniffer::getInstalledStandards()
Access: public

Parameters:

string $standard — The name of the coding standard.

[ Top ]

isUnderscoreName [line 1729]

boolean isUnderscoreName(
string
$string)

Returns true if the specified string is in the underscore caps format.

Access: public

Parameters:

string $string — The string to verify.

[ Top ]

makeFriendlyName [line 1349]

string makeFriendlyName(
string
$name)

Converts a camel caps name into a readable string.

Access: public

Parameters:

string $name — The camel caps name to convert.

[ Top ]

populateTokenListeners [line 471]

void populateTokenListeners(
)

Populates the array of PHP_CodeSniffer_Sniff's for this file.

Access: public

[ Top ]

prepareErrorReport [line 798]

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.

Access: public

Parameters:

boolean $showWarnings — Show warnings as well as errors.

[ Top ]

printCheckstyleErrorReport [line 951]

int printCheckstyleErrorReport(
[boolean
$showWarnings = true])

Prints all errors and warnings for processed files, in a Checkstyle 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.

[ Top ]

printCSVErrorReport [line 995]

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.

[ Top ]

printEmacsErrorReport [line 1029]

int printEmacsErrorReport(
[boolean
$showWarnings = true])

Prints all errors and warnings for each file processed, in a format for emacs.

Return: The number of error and warning messages shown.
Access: public

Parameters:

boolean $showWarnings — Show warnings as well as errors.

[ Top ]

printErrorReport [line 1062]

int printErrorReport(
[boolean
$showWarnings = true], [boolean
$showSources = false])

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.
boolean	`$showSources`	—	Show error sources in report.

[ Top ]

printErrorReportSummary [line 1167]

int printErrorReportSummary(
[boolean
$showWarnings = true], [boolean
$showSources = false])

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.
boolean	`$showSources`	—	Show error sources in report.

[ Top ]

printSourceReport [line 1261]

int printSourceReport(
[boolean
$showWarnings = true], [boolean
$showSources = false])

Prints the source of all errors and warnings.

Return: The number of error and warning messages shown.
Access: public

Parameters:

boolean	`$showWarnings`	—	Show warnings as well as errors.
boolean	`$showSources`	—	Show error sources in report.

[ Top ]

printXMLErrorReport [line 906]

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.

[ Top ]

process [line 301]

void process(
string|array
$files, string
$standard, [
$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.

[ Top ]

processFile [line 729]

void processFile(
string
$file, [string
$contents = null])

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: public

Parameters:

string	`$file`	—	The file to process.
string	`$contents`	—	The contents to parse. If NULL, the content is taken from the file system.

[ Top ]

processFiles [line 660]

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: public

Parameters:

string	`$dir`	—	The directory to process.
boolean	`$local`	—	If true, only process files in this directory, not sub directories.

[ Top ]

resolveSimpleToken [line 1549]

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.

[ Top ]

resolveTstringToken [line 1506]

array resolveTstringToken(

$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().

[ Top ]

setAllowedFileExtensions [line 238]

void setAllowedFileExtensions(

$extensions)

Sets an array of file extensions that we will allow checking of.

If the extension is one of the defaults, a specific tokenizer will be used. Otherwise, the PHP tokenizer will be used for all extensions passed.

Access: public

Parameters:

array $extensions — An array of file extensions.

[ Top ]

setConfigData [line 1952]

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.

See: PHP_CodeSniffer::getConfigData()
Throws: PHP_CodeSniffer_Exception If the config file can not be written.
Access: public

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.

[ Top ]

setIgnorePatterns [line 263]

void setIgnorePatterns(

$patterns)

Sets an array of ignore patterns that we use to skip files and folders.

Patterns are not case sensitive.

Access: public

Parameters:

array $patterns — An array of ignore patterns.

[ Top ]

setTokenListeners [line 459]

null setTokenListeners(
string
$standard, [
$sniffs = array()])

Sets installed sniffs in the coding standard being used.

Access: public

Parameters:

string	`$standard`	—	The name of the coding standard we are checking.
array	`$sniffs`	—	The sniff names to restrict the allowed listeners to.

[ Top ]

standardiseToken [line 1465]

array standardiseToken(
string|array
$token)

Takes a token produced from

token_get_all()

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.

[ Top ]

suggestType [line 1766]

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.

Access: public

Parameters:

string $varType — The variable type to process.

[ Top ]

Class: PHP_CodeSniffer

Class Overview

Author(s):

Version:

Copyright:

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

Class Variables

$allowedFileExtensions = array( 'php' => 'PHP', 'inc' => 'PHP', 'js' => 'JS', 'css' => 'CSS', )

$allowedTypes = array( 'array', 'boolean', 'float', 'integer', 'mixed', 'object', 'string', )

$file = array()

$files = array()

$ignorePatterns = array()

$listeners = array()

$standardDir = ''

Method Detail

__construct (Constructor) [line 163]

Parameters:

__destruct (Destructor) [line 189]

addFile [line 279]

Parameters:

autoload [line 203]

Parameters:

generateDocs [line 1406]

Parameters:

getAllConfigData [line 2001]

getConfigData [line 1917]

Parameters:

getFiles [line 1423]

getInstalledStandards [line 1843]

Parameters:

getSniffFiles [line 515]

Parameters:

getSniffs [line 1435]

getTokenListeners [line 381]

Parameters:

getTokenSniffs [line 1447]

isCamelCaps [line 1659]

Parameters:

isInstalledStandard [line 1889]

Parameters:

isUnderscoreName [line 1729]

Parameters:

makeFriendlyName [line 1349]

Parameters:

populateTokenListeners [line 471]

prepareErrorReport [line 798]

Parameters:

printCheckstyleErrorReport [line 951]

Parameters:

printCSVErrorReport [line 995]

Parameters:

printEmacsErrorReport [line 1029]

Parameters:

printErrorReport [line 1062]

Parameters:

printErrorReportSummary [line 1167]

Parameters:

printSourceReport [line 1261]

Parameters:

printXMLErrorReport [line 906]

Parameters:

process [line 301]

Parameters:

processFile [line 729]

Parameters:

processFiles [line 660]

Parameters:

resolveSimpleToken [line 1549]

Parameters:

resolveTstringToken [line 1506]

Parameters:

setAllowedFileExtensions [line 238]

Parameters:

setConfigData [line 1952]

Parameters:

setIgnorePatterns [line 263]

$allowedFileExtensions = array(
'php' => 'PHP',
'inc' => 'PHP',
'js' => 'JS',
'css' => 'CSS',
)

$allowedTypes = array(
'array',
'boolean',
'float',
'integer',
'mixed',
'object',
'string',
)