[ 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_AbstractScopeSniff

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

Class Overview

An AbstractScopeTest allows for tests that extend from this class to listen for tokens within a particluar scope.

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)

Variables

$currScope

Methods

Child classes:

Squiz_Sniffs_Classes_SelfMemberReferenceSniff: Tests self member references.

Squiz_Sniffs_Scope_MethodScopeSniff: Verifies that class members have scope modifiers.

Squiz_Sniffs_Scope_StaticThisUsageSniff: Squiz_Sniffs_Scope_StaticThisUsageSniff.

Squiz_Sniffs_Commenting_FunctionCommentThrowTagSniff: Verifies that a @throws tag exists for a function that throws exceptions.

PEAR_Sniffs_NamingConventions_ValidFunctionNameSniff: PEAR_Sniffs_NamingConventions_ValidFunctionNameSniff.

PHP_CodeSniffer_Standards_AbstractVariableSniff: A class to find T_VARIABLE tokens.

MySource_Sniffs_Channels_IncludeSystemSniff: Ensures that systems, asset types and libs are included before they are used.

Inherited Variables

Inherited Methods

Class Details

[line 48]
An AbstractScopeTest allows for tests that extend from this class to listen for tokens within a particluar scope.

Below is a test that listens to methods that exist only within classes:

  class ClassScopeTest extends PHP_CodeSniffer_Standards_AbstractScopeSniff 

  {
    public function __construct()
    {
      parent::__construct(array(T_CLASS), array(T_FUNCTION));
    }

    protected function processTokenWithinScope(PHP_CodeSniffer_File $phpcsFile, $)
    {
      $className = $phpcsFile->getDeclarationName($currScope);
      echo 'encountered a method within class '.$className;
    }
  }

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 ]

Class Variables

$currScope = null

[line 70]

The position in the tokens array that opened the current scope.

Access: protected

Type: array()

[ Top ]

Method Detail

__construct (Constructor) [line 94]

PHP_CodeSniffer_Standards_AbstractScopeSniff __construct(
array
$scopeTokens, array
$tokens, [boolean
$listenOutside = false])

Constructs a new AbstractScopeTest.

See: PHP_CodeSniffer.getValidScopeTokeners()
Throws: PHP_CodeSniffer_Test_Exception If the specified tokens array is empty.
Access: public

Overridden in child classes as:

Squiz_Sniffs_Classes_SelfMemberReferenceSniff::__construct(): Constructs a Squiz_Sniffs_Classes_SelfMemberReferenceSniff.

Squiz_Sniffs_Scope_MethodScopeSniff::__construct(): Constructs a Squiz_Sniffs_Scope_MethodScopeSniff.

Squiz_Sniffs_Scope_StaticThisUsageSniff::__construct(): Constructs the test with the tokens it wishes to listen for.

Squiz_Sniffs_Commenting_FunctionCommentThrowTagSniff::__construct(): Constructs a Squiz_Sniffs_Commenting_FunctionCommentThrowTagSniff.

PEAR_Sniffs_NamingConventions_ValidFunctionNameSniff::__construct(): Constructs a PEAR_Sniffs_NamingConventions_ValidFunctionNameSniff.

PHP_CodeSniffer_Standards_AbstractVariableSniff::__construct(): Constructs an AbstractVariableTest.

MySource_Sniffs_Channels_IncludeSystemSniff::__construct(): Constructs a Squiz_Sniffs_Scope_MethodScopeSniff.

Parameters:

array $scopeTokens — The type of scope the test wishes to listen to.

array $tokens — The tokens that the test wishes to listen to within the scope.

boolean $listenOutside — If true this test will also alert the extending class when a token is found outside the scope, by calling the processTokenOutideScope.

[ Top ]

process [line 154]

void process(
PHP_CodeSniffer_File
$phpcsFile, int
$stackPtr)

Processes the tokens that this test is listening for.

See: PHP_CodeSniffer_Standards_AbstractScopeSniff::processTokenWithinScope()
Access: public

Parameters:

PHP_CodeSniffer_File $phpcsFile — The file where this token was found.

int $stackPtr — The position in the stack where this token was found.

[ Top ]

processTokenOutsideScope [line 207]

void processTokenOutsideScope(
PHP_CodeSniffer_File
$phpcsFile, int
$stackPtr)

Processes a token that is found within the scope that this test is listening to.

Access: protected

Overridden in child classes as:

PEAR_Sniffs_NamingConventions_ValidFunctionNameSniff::processTokenOutsideScope(): Processes the tokens outside the scope.

Squiz_Sniffs_NamingConventions_ValidFunctionNameSniff::processTokenOutsideScope(): Processes the tokens outside the scope.

PHP_CodeSniffer_Standards_AbstractVariableSniff::processTokenOutsideScope(): Processes the token outside the scope in the file.

MySource_Sniffs_Channels_IncludeSystemSniff::processTokenOutsideScope(): Processes a token that is found within the scope that this test is listening to.

Parameters:

PHP_CodeSniffer_File $phpcsFile — The file where this token was found.

int $stackPtr — The position in the stack where this token was found.

[ Top ]

processTokenWithinScope [line 194]

void processTokenWithinScope(
PHP_CodeSniffer_File
$phpcsFile, int
$stackPtr, int
$currScope)

Processes a token that is found within the scope that this test is listening to.

Abstract:
Access: protected

Overridden in child classes as:

Squiz_Sniffs_Classes_SelfMemberReferenceSniff::processTokenWithinScope(): Processes the function tokens within the class.

Squiz_Sniffs_Scope_MethodScopeSniff::processTokenWithinScope(): Processes the function tokens within the class.

Squiz_Sniffs_Scope_StaticThisUsageSniff::processTokenWithinScope(): Processes this test, when one of its tokens is encountered.

Squiz_Sniffs_Commenting_FunctionCommentThrowTagSniff::processTokenWithinScope(): Processes the function tokens within the class.

PEAR_Sniffs_NamingConventions_ValidFunctionNameSniff::processTokenWithinScope(): Processes the tokens within the scope.

PHP_CodeSniffer_Standards_AbstractVariableSniff::processTokenWithinScope(): Processes the token in the specified PHP_CodeSniffer_File.

MySource_Sniffs_Channels_IncludeSystemSniff::processTokenWithinScope(): Processes the function tokens within the class.

Parameters:

PHP_CodeSniffer_File $phpcsFile — The file where this token was found.

int $stackPtr — The position in the stack where this token was found.

int $currScope — The position in the tokens array that opened the scope that this test is listening for.

[ Top ]

register [line 133]

array(int) register(
)

The method that is called to register the tokens this test wishes to listen to.

DO NOT OVERRIDE THIS METHOD. Use the constructor of this class to register for the desired tokens and scope.

See: __constructor()
Access: public

[ Top ]