Docs For Class PHP_CodeSniffer_Standards

Class: PHP_CodeSniffer_Standards_AbstractPatternSniff

Child classes:

PEAR_Sniffs_ControlStructures_ControlSignatureSniff: Verifies that control statements conform to their coding standards.

Squiz_Sniffs_ControlStructures_ControlSignatureSniff: Verifies that control statements conform to their coding standards.

Squiz_Sniffs_Functions_FunctionDeclarationSniff: Squiz_Sniffs_Functions_FunctionDeclarationSniff.

Inherited Variables

Inherited Methods

Class Details

[line 36]
Processes pattern strings and checks that the code conforms to the pattern.

This test essentially checks that code is correctly formatted with whitespace.

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

Method Detail

__construct (Constructor) [line 75]

PHP_CodeSniffer_Standards_AbstractPatternSniff __construct(
[boolean
$ignoreComments = false])

Constructs a PHP_CodeSniffer_Standards_AbstractPatternSniff.

Access: public

Overridden in child classes as:

PEAR_Sniffs_ControlStructures_ControlSignatureSniff::__construct(): Constructs a PEAR_Sniffs_ControlStructures_ControlSignatureSniff.

Parameters:

boolean $ignoreComments — If true, comments will be ignored.

[ Top ]

getPatterns [line 583]

array(string) getPatterns(
)

Returns the patterns that should be checked.

Abstract:
Access: protected

Overridden in child classes as:

PEAR_Sniffs_ControlStructures_ControlSignatureSniff::getPatterns(): Returns the patterns that this test wishes to verify.

Squiz_Sniffs_ControlStructures_ControlSignatureSniff::getPatterns(): Returns the patterns that this test wishes to verify.

Squiz_Sniffs_Functions_FunctionDeclarationSniff::getPatterns(): Returns an array of patterns to check are correct.

[ Top ]

prepareError [line 564]

string prepareError(
string
$found, string
$patternCode)

Prepares an error for the specified patternCode.

Return: The error message.
Access: protected

Parameters:

string	`$found`	—	The actual found string in the code.
string	`$patternCode`	—	The expected pattern code.

[ Top ]

process [line 198]

void process(
PHP_CodeSniffer_File
$phpcsFile, int
$stackPtr)

Processes the test.

See: PHP_CodeSniffer_Standards_AbstractPatternSniff::register()
Access: public

Parameters:

PHP_CodeSniffer_File	`$phpcsFile`	—	The PHP_CodeSniffer file where the token occured.
int	`$stackPtr`	—	The postion in the tokens stack where the listening token type was found.

[ Top ]

processPattern [line 260]

array(errors) processPattern(
array
$patternInfo, PHP_CodeSniffer_File
$phpcsFile, int
$stackPtr)

Processes the pattern and verifies the code at $stackPtr.

Access: protected

Parameters:

array	`$patternInfo`	—	Information about the pattern used for checking, which includes are parsed token representation of the pattern.
PHP_CodeSniffer_File	`$phpcsFile`	—	The PHP_CodeSniffer file where the token occured.
int	`$stackPtr`	—	The postion in the tokens stack where the listening token type was found.

[ Top ]

processSupplementary [line 614]

void processSupplementary(
PHP_CodeSniffer_File
$phpcsFile, int
$stackPtr)

Processes any tokens registered with registerSupplementary().

See: PHP_CodeSniffer_Standards_AbstractPatternSniff::registerSupplementary()
Access: protected

Parameters:

PHP_CodeSniffer_File	`$phpcsFile`	—	The PHP_CodeSniffer file where to process the skip.
int	`$stackPtr`	—	The position in the tokens stack to process.

[ Top ]

register [line 92]

array(int) register(
)

Registers the tokens to listen to.

Classes extending AbstractPatternTest should implement the getPatterns() method to register the patterns they wish to test.

See: PHP_CodeSniffer_Standards_AbstractPatternSniff::process()
Access: public

[ Top ]

registerSupplementary [line 596]

array(int) registerSupplementary(
)

Registers any supplementary tokens that this test might wish to process.

A sniff may wish to register supplementary tests when it wishes to group an arbitary validation that cannot be performed using a pattern, with other pattern tests.

See: PHP_CodeSniffer_Standards_AbstractPatternSniff::processSupplementary()
Access: protected

[ Top ]

Class: PHP_CodeSniffer_Standards_AbstractPatternSniff

Class Overview

Author(s):

Version:

Copyright:

Methods

Child classes:

Inherited Variables

Inherited Methods

Class Details

Method Detail

__construct (Constructor) [line 75]

Parameters:

getPatterns [line 583]

prepareError [line 564]

Parameters:

process [line 198]

Parameters:

processPattern [line 260]

Parameters:

processSupplementary [line 614]

Parameters:

register [line 92]

registerSupplementary [line 596]