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

Packages:
PHP_CodeSniffer

Classes:

Files:

AbstractDocElement.php
AbstractParser.php
AbstractPatternSniff.php
AbstractScopeSniff.php
AbstractVariableSniff.php
ClassCommentParser.php
CodeSniffer.php
CommentElement.php
ControlSignatureSniff.php
DocElement.php
Exception.php
File.php
FunctionCallSignatureSniff.php
FunctionCommentParser.php
IncludingFileSniff.php
IncorrectPatternException.php
InlineCommentSniff.php
LineLengthSniff.php
LowerCaseConstantSniff.php
MemberCommentParser.php
MethodCallArgumentSpacingSniff.php
MultipleStatementSniff.php
OpeningMethodBraceSniff.php
PairElement.php
ParameterElement.php
ParserException.php
ScopeClosingBraceSniff.php
ScopeIndentSniff.php
ShortOpenTagSniff.php
SingleElement.php
Sniff.php
SniffException.php
Tokens.php
ValidClassNameSniff.php
ValidConstantNameSniff.php
ValidDefaultValueSniff.php
ValidFunctionNameSniff.php

Class: PHP_CodeSniffer_Standards_AbstractPatternSniff

Source Location: /PHP_CodeSniffer-0.1.0/CodeSniffer/Standards/AbstractPatternSniff.php

Class Overview

Processes pattern strings and checks that the code conforms to the pattern.

Author(s):

Squiz Pty Ltd

Methods

Child classes:

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

Inherited Variables

Inherited Methods

Class Details

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

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

Author: Squiz Pty Ltd
Abstract:

[ Top ]

Method Detail

__construct (Constructor) [line 85]

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

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.

[ Top ]

prepareError [line 432]

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

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

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

Processes the pattern and varifies the code at $stackPtr.

Access: protected

Parameters:

array $patternInfo — The info for the pattern to process.

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

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

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

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 ]