[ class tree: PHP_CodeSniffer ] [ index: PHP_CodeSniffer ] [ all elements ]

Packages:
PHP_CodeSniffer
PHP_CodeSniffer_MySource

Classes:

Files:

Class: PHP_CodeSniffer

Source Location: /PHP_CodeSniffer-1.3.0/CodeSniffer.php

Class Overview

PHP_CodeSniffer tokenises PHP code and detects violations of a defined set of coding standards.

Author(s):

Marc McIntyre <mmcintyre at squiz.net>
Greg Sherwood <gsherwood at squiz.net>

Version:

Release: @package_version@

Copyright:

2006 Squiz Pty Ltd (ABN 77 084 670 600)

Inherited Variables

Inherited Methods

Class Details

[line 69]
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.

Author: Marc McIntyre <mmcintyre@squiz.net>
Author: Greg Sherwood <gsherwood@squiz.net>
Version: Release: @package_version@
Copyright: 2006 Squiz Pty Ltd (ABN 77 084 670 600)
Link: http://pear.php.net/package/PHP_CodeSniffer
License: BSD Licence

[ Top ]

Class Variables

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

[line 149]

An array of extensions for files we will check.

Access: public

Type: array

[ Top ]

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

[line 161]

An array of variable types for param/var we will check.

Access: public

Type: array(string)

[ Top ]

$cli = null

[line 98]

The CLI object controlling the run.

Access: public

Type: string

[ Top ]

$file = ''

[line 77]

The file or directory that is currently being processed.

Access: protected

Type: string

[ Top ]

$files = array()

[line 84]

The files that have been processed.

Access: protected

Type: array(PHP_CodeSniffer_File)

[ Top ]

$ignorePatterns = array()

[line 142]

An array of patterns to use for skipping files.

Access: protected

Type: array

[ Top ]

$listeners = array()

[line 105]

An array of sniffs that are being used to check files.

Access: protected

Type: array(PHP_CodeSniffer_Sniff)

[ Top ]

$ruleset = array()

[line 115]

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.

Access: protected

Type: array

[ Top ]

$standardDir = ''

[line 91]

The directory to search for sniffs in.

Access: protected

Type: string

[ Top ]

Method Detail

__construct (Constructor) [line 191]

PHP_CodeSniffer __construct(
[int
$verbosity = 0], [int
$tabWidth = 0], [string
$encoding = 'iso-8859-1'], [bool
$interactive = false])

Constructs a PHP_CodeSniffer object.

See: PHP_CodeSniffer::process()
Access: public

Parameters:

int $verbosity — The verbosity level. 1: Print progress information. 2: Print tokenizer debug information. 3: Print sniff 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.

string $encoding — The charset of the sniffed files. This is important for some reports that output with utf-8 encoding as you don't want it double encoding messages.

bool $interactive — If TRUE, will stop after each file with errors and wait for user input.

[ Top ]

__destruct (Destructor) [line 243]

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 373]

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 257]

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 1314]

void generateDocs(
string
$standard, [array
$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 1925]

string getAllConfigData(
)

Get all config data in an array.

See: PHP_CodeSniffer::getConfigData()
Access: public

[ Top ]

getConfigData [line 1841]

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 1331]

array(PHP_CodeSniffer_File) getFiles(
)

Returns the PHP_CodeSniffer file objects.

Access: public

[ Top ]

getFilesErrors [line 1287]

array getFilesErrors(
)

Gives collected violations for reports.

Access: public

[ Top ]

getFilesToProcess [line 1000]

array getFilesToProcess(
string
$paths, [boolean
$local = false])

Get a list of files that will be processed.

If passed directories, this method will find all files within them. The method will also perform file extension and ignore pattern filtering.

See: PHP_CodeSniffer::shouldProcessFile()
Throws: Exception If there was an error opening a directory.
Access: public

Parameters:

string $paths — A list of file or directory paths to process.

boolean $local — If true, only process 1 level of files in directories

[ Top ]

getIgnorePatterns [line 335]

array getIgnorePatterns(
[string
$listener = null])

Gets the array of ignore patterns.

Optionally takes a listener to get ignore patterns specified for that sniff only.

Access: public

Parameters:

string $listener — The listener to get patterns for. If NULL, all patterns are returned.

[ Top ]

getInstalledStandards [line 1755]

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 695]

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 1343]

array(PHP_CodeSniffer_Sniff) getSniffs(
)

Gets the array of PHP_CodeSniffer_Sniff's.

Access: public

[ Top ]

getTokenSniffs [line 1355]

array() getTokenSniffs(
)

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

Access: public

[ Top ]

isCamelCaps [line 1572]

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 1801]

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 1637]

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 ]

populateCustomRules [line 847]

void populateCustomRules(
[string
$standard = null])

Sets installed sniffs in the coding standard being used.

Access: public

Parameters:

string $standard — The name of the coding standard we are checking. Can also be a path to a custom ruleset.xml file.

[ Top ]

populateTokenListeners [line 933]

void populateTokenListeners(
)

Populates the array of PHP_CodeSniffer_Sniff's for this file.

Throws: PHP_CodeSniffer_Exception If sniff registration fails.
Access: public

[ Top ]

process [line 395]

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.

[ Top ]

processFile [line 1101]

PHP_CodeSniffer_File 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. Returns the processed file object, or NULL if no file was processed due to error.

See: _processFile()
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 ]

processMulti [line 539]

void processMulti(
)

Processes multi-file sniffs.

Access: public

[ Top ]

resolveSimpleToken [line 1459]

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 1416]

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

[ Top ]

setAllowedFileExtensions [line 292]

void setAllowedFileExtensions(
array
$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 ]

setCli [line 357]

void setCli(
object
$cli)

Sets the internal CLI object.

Access: public

Parameters:

object $cli — The CLI object controlling the run.

[ Top ]

setConfigData [line 1876]

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 317]

void setIgnorePatterns(
array
$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 573]

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

Sets 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. If the standard is a file, will skip transversal and just load sniffs from the file.

Throws: PHP_CodeSniffer_Exception If the standard is not valid.
Access: public

Parameters:

string $standard — The name of the coding standard we are checking. Can also be a path to a custom standard dir containing a ruleset.xml file or can be a path to a custom ruleset file.

array $sniffs — The sniff names to restrict the allowed listeners to.

[ Top ]

shouldProcessFile [line 1048]

bool shouldProcessFile(
string
$path)

Checks filtering rules to see if a file should be checked.

Checks both file extension filters and path ignore filters.

Access: public

Parameters:

string $path — The path to the file being checked.

[ Top ]

standardiseToken [line 1373]

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 1678]

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', )

$cli = null

$file = ''

$files = array()

$ignorePatterns = array()

$listeners = array()

$ruleset = array()

$standardDir = ''

Method Detail

__construct (Constructor) [line 191]

Parameters:

__destruct (Destructor) [line 243]

addFile [line 373]

Parameters:

autoload [line 257]

Parameters:

generateDocs [line 1314]

Parameters:

getAllConfigData [line 1925]

getConfigData [line 1841]

Parameters:

getFiles [line 1331]

getFilesErrors [line 1287]

getFilesToProcess [line 1000]

Parameters:

getIgnorePatterns [line 335]

Parameters:

getInstalledStandards [line 1755]

Parameters:

getSniffFiles [line 695]

Parameters:

getSniffs [line 1343]

getTokenSniffs [line 1355]

isCamelCaps [line 1572]

Parameters:

isInstalledStandard [line 1801]

Parameters:

isUnderscoreName [line 1637]

Parameters:

populateCustomRules [line 847]

Parameters:

populateTokenListeners [line 933]

process [line 395]

Parameters:

processFile [line 1101]

Parameters:

processMulti [line 539]

resolveSimpleToken [line 1459]

Parameters:

resolveTstringToken [line 1416]

Parameters:

setAllowedFileExtensions [line 292]

Parameters:

setCli [line 357]

Parameters:

setConfigData [line 1876]

Parameters:

setIgnorePatterns [line 317]

Parameters:

setTokenListeners [line 573]

Parameters:

shouldProcessFile [line 1048]

Parameters:

standardiseToken [line 1373]

Parameters:

suggestType [line 1678]

Parameters:

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

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