Docs For Class AbstractScopeSniff

Class: AbstractScopeSniff

Class Overview

Allows tests that extend this class to listen for tokens within a particular scope.

Author(s):

Greg Sherwood <gsherwood at squiz.net>

Copyright:

2006-2015 Squiz Pty Ltd (ABN 77 084 670 600)

Methods

Child classes:

CamelCapsFunctionNameSniff: Ensures method and functions are named correctly.

ConstructorNameSniff: Bans PHP 4 style constructors.

MethodDeclarationSniff: Checks that the method declaration is correct.

SelfMemberReferenceSniff: Tests self member references.

MethodScopeSniff: Verifies that class methods have scope modifiers.

StaticThisUsageSniff: Checks for usage of $this in static methods, which will cause runtime errors.

FunctionCommentThrowTagSniff: Verifies that a @throws tag exists for each exception type a function throws.

ValidFunctionNameSniff: Ensures method and function names are correct.

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

AbstractVariableSniff: A class to find T_VARIABLE tokens.

Inherited Variables

Inherited Methods

Class Details

[line 32]
Allows tests that extend this class to listen for tokens within a particular 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\Files\File $phpcsFile, $)
     {
         $className = $phpcsFile->getDeclarationName($currScope);
         echo 'encountered a method within class '.$className;
     }
 }

Author: Greg Sherwood <gsherwood@squiz.net>
Copyright: 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600)
Abstract:
License: BSD Licence

Method Detail

__construct (Constructor) [line 71]

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

Constructs a new AbstractScopeTest.

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

Overridden in child classes as:

CamelCapsFunctionNameSniff::__construct(): Constructs a Generic_Sniffs_NamingConventions_CamelCapsFunctionNameSniff.

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

MethodDeclarationSniff::__construct(): Constructs a Squiz_Sniffs_Scope_MethodScopeSniff.

SelfMemberReferenceSniff::__construct(): Constructs a Squiz_Sniffs_Classes_SelfMemberReferenceSniff.

MethodScopeSniff::__construct(): Constructs a Squiz_Sniffs_Scope_MethodScopeSniff.

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

FunctionCommentThrowTagSniff::__construct(): Constructs a Squiz_Sniffs_Commenting_FunctionCommentThrowTagSniff.

ValidFunctionNameSniff::__construct(): Constructs a PEAR_Sniffs_NamingConventions_ValidFunctionNameSniff.

IncludeSystemSniff::__construct(): Constructs a Squiz_Sniffs_Scope_MethodScopeSniff.

AbstractVariableSniff::__construct(): Constructs an AbstractVariableTest.

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 processTokenOutsideScope method.

[ Top ]

process [line 127]

void process(
File
$phpcsFile, int
$stackPtr)

Processes the tokens that this test is listening for.

See: processTokenWithinScope()
Access: public

Parameters:

\PHP_CodeSniffer\Files\File	`$phpcsFile`	—	The file where this token was found.
int	`$stackPtr`	—	The position in the stack where this token was found.

[ Top ]

processTokenOutsideScope [line 172]

void processTokenOutsideScope(
File
$phpcsFile, int
$stackPtr)

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

Abstract:
Access: protected

Overridden in child classes as:

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

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

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

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

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

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

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

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

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

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

Parameters:

\PHP_CodeSniffer\Files\File	`$phpcsFile`	—	The file where this token was found.
int	`$stackPtr`	—	The position in the stack where this token was found.

[ Top ]

processTokenWithinScope [line 159]

void processTokenWithinScope(
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:

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

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

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

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

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

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

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

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

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

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

Parameters:

\PHP_CodeSniffer\Files\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 110]

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 ]