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

Packages:
PHP_CodeSniffer
PHP_CodeSniffer_MySource

Classes:

Files:

AbstractDocElement.php
AbstractParser.php
AbstractPatternSniff.php
AbstractScopeSniff.php
AbstractVariableSniff.php
ArrayBracketSpacingSniff.php
ArrayDeclarationSniff.php
BlockCommentSniff.php
CastSpacingSniff.php
ClassCommentParser.php
ClassCommentSniff.php
ClassCommentSniff.php
ClassDeclarationSniff.php
ClassDeclarationSniff.php
ClassFileNameSniff.php
ClosingDeclarationCommentSniff.php
ClosingTagSniff.php
CodeAnalyzerSniff.php
CodeSniffer.php
CodingStandard.php
CommentedOutCodeSniff.php
CommentElement.php
ComparisonOperatorUsageSniff.php
ConcatenationSpacingSniff.php
ControlSignatureSniff.php
ControlSignatureSniff.php
ControlStructureSpacingSniff.php
CyclomaticComplexitySniff.php
DisallowMultipleAssignmentsSniff.php
DisallowObEndFlushSniff.php
DisallowShortOpenTagSniff.php
DisallowTabIndentSniff.php
DocCommentAlignmentSniff.php
DocElement.php
DoubleQuoteUsageSniff.php
EchoedStringsSniff.php
ElseIfDeclarationSniff.php
EmbeddedPhpSniff.php
EmptyCatchCommentSniff.php
EvalSniff.php
Exception.php
File.php
FileCommentSniff.php
FileCommentSniff.php
FileExtensionSniff.php
ForbiddenFunctionsSniff.php
ForbiddenFunctionsSniff.php
ForEachLoopDeclarationSniff.php
ForLoopDeclarationSniff.php
FunctionCallArgumentSpacingSniff.php
FunctionCallSignatureSniff.php
FunctionClosingBraceSpaceSniff.php
FunctionCommentParser.php
FunctionCommentSniff.php
FunctionCommentSniff.php
FunctionCommentThrowTagSniff.php
FunctionDeclarationArgumentSpacingSniff.php
FunctionDeclarationSniff.php
FunctionDuplicateArgumentSniff.php
FunctionOpeningBraceSpaceSniff.php
FunctionSpacingSniff.php
Generator.php
GenericCodingStandard.php
GlobalFunctionSniff.php
GlobalKeywordSniff.php
HeredocSniff.php
HTML.php
IncludingFileSniff.php
IncorrectPatternException.php
IncrementDecrementUsageSniff.php
InlineCommentSniff.php
InlineCommentSniff.php
InlineControlStructureSniff.php
InlineIfDeclarationSniff.php
InnerFunctionsSniff.php
LineEndingsSniff.php
LineEndingsSniff.php
LineEndingsSniff.php
LineLengthSniff.php
LineLengthSniff.php
LineLengthSniff.php
LineLengthSniff.php
LongConditionClosingCommentSniff.php
LowercaseClassKeywordsSniff.php
LowerCaseConstantSniff.php
LowercaseDeclarationSniff.php
LowercaseFunctionKeywordsSniff.php
LowercasePHPFunctionsSniff.php
MemberCommentParser.php
MemberVarScopeSniff.php
MemberVarSpacingSniff.php
MethodScopeSniff.php
MultipleStatementAlignmentSniff.php
MultipleStatementAlignmentSniff.php
NestingLevelSniff.php
NonExecutableCodeSniff.php
NoSpaceAfterCastSniff.php
ObjectInstantiationSniff.php
ObjectOperatorSpacingSniff.php
OpeningFunctionBraceBsdAllmanSniff.php
OpeningFunctionBraceKernighanRitchieSniff.php
OperatorBracketSniff.php
OperatorSpacingSniff.php
OutputBufferingIndentSniff.php
PairElement.php
ParameterElement.php
ParserException.php
PEARCodingStandard.php
PHPCSCodingStandard.php
PostStatementCommentSniff.php
ScopeClosingBraceSniff.php
ScopeClosingBraceSniff.php
ScopeIndentSniff.php
ScopeIndentSniff.php
ScopeIndentSniff.php
ScopeKeywordSpacingSniff.php
SelfMemberReferenceSniff.php
SemicolonSpacingSniff.php
SingleElement.php
Sniff.php
SpaceAfterCastSniff.php
SquizCodingStandard.php
StaticThisUsageSniff.php
SuperfluousWhitespaceSniff.php
SwitchDeclarationSniff.php
Text.php
Tokens.php
UpperCaseConstantNameSniff.php
UpperCaseConstantSniff.php
ValidClassNameSniff.php
ValidClassNameSniff.php
ValidDefaultValueSniff.php
ValidFunctionNameSniff.php
ValidFunctionNameSniff.php
ValidInterfaceNameSniff.php
ValidLogicalOperatorsSniff.php
ValidVariableNameSniff.php
ValidVariableNameSniff.php
VariableCommentSniff.php
ZendCodingStandard.php

Class: PHP_CodeSniffer_Standards_AbstractPatternSniff

Source Location: /PHP_CodeSniffer-1.0.0RC1/CodeSniffer/Standards/AbstractPatternSniff.php

Class Overview

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

Author(s):

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

Version:

Release: 1.0.0RC1

Copyright:

2006 Squiz Pty Ltd (ABN 77 084 670 600)

Methods

Child classes:

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

Squiz_Sniffs_Functions_FunctionDeclarationSniff: Squiz_Sniffs_Functions_FunctionDeclarationSniff.

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

Inherited Variables

Inherited Methods

Class Details

[line 35]
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.0.0RC1
Copyright: 2006 Squiz Pty Ltd (ABN 77 084 670 600)
Link: http://pear.php.net/package/PHP_CodeSniffer
Abstract:
License: BSD Licence

[ Top ]

Method Detail

__construct (Constructor) [line 74]

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

array(string) getPatterns(
)

Returns the patterns that should be checked.

Abstract:
Access: protected

Overridden in child classes as:

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.

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

[ Top ]

prepareError [line 553]

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

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

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 — Information about the pattern used for checking, which includes are parsed otken 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 603]

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

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

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 ]