Docs For Class AbstractVariableSniff

AbstractVariableSniff __construct(
)

Constructs an AbstractVariableTest.

Access: public

Overrides AbstractScopeSniff::__construct() (Constructs a new AbstractScopeTest.)

[ Top ]

void processMemberVar(
File
$phpcsFile, int
$stackPtr)

Called to process class member vars.

Abstract:
Access: protected

Overridden in child classes as:

PropertyDeclarationSniff::processMemberVar(): Processes the function tokens within the class.

MemberVarScopeSniff::processMemberVar(): Processes the function tokens within the class.

MemberVarSpacingSniff::processMemberVar(): Processes the function tokens within the class.

ValidVariableNameSniff::processMemberVar(): Processes class member variables.

VariableCommentSniff::processMemberVar(): Called to process class member vars.

Parameters:

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

[ Top ]

void processTokenOutsideScope(
File
$phpcsFile, int
$stackPtr)

Processes the token outside the scope in the file.

Access: protected

Overrides AbstractScopeSniff::processTokenOutsideScope() (Processes a token that is found outside the scope that this test is listening to.)

Parameters:

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

[ Top ]

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

Processes the token in the specified PHP_CodeSniffer_File.

Access: protected

Overrides AbstractScopeSniff::processTokenWithinScope() (Processes a token that is found within the scope that this test is listening to.)

Parameters:

\PHP_CodeSniffer\Files\File	`$phpcsFile`	—	The PHP_CodeSniffer file where this token was found.
int	`$stackPtr`	—	The position where the token was found.
int	`$currScope`	—	The current scope opener token.

[ Top ]

void processVariable(
File
$phpcsFile, int
$stackPtr)

Called to process normal member vars.

Abstract:
Access: protected

Overridden in child classes as:

PropertyDeclarationSniff::processVariable(): Processes normal variables.

MemberVarScopeSniff::processVariable(): Processes normal variables.

MemberVarSpacingSniff::processVariable(): Processes normal variables.

ValidVariableNameSniff::processVariable(): Processes normal variables.

VariableCommentSniff::processVariable(): Called to process a normal variable.

Parameters:

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

[ Top ]

void processVariableInString(
File
$phpcsFile, int
$stackPtr)

Called to process variables found in double quoted strings or heredocs.

Note that there may be more than one variable in the string, which will result only in one call for the string or one call per line for heredocs.

Abstract:
Access: protected

Overridden in child classes as:

PropertyDeclarationSniff::processVariableInString(): Processes variables in double quoted strings.

MemberVarScopeSniff::processVariableInString(): Processes variables in double quoted strings.

MemberVarSpacingSniff::processVariableInString(): Processes variables in double quoted strings.

ValidVariableNameSniff::processVariableInString(): Processes variables in double quoted strings.

VariableCommentSniff::processVariableInString(): Called to process variables found in double quoted strings.

Parameters:

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

[ Top ]

Class: AbstractVariableSniff

Class Overview

Author(s):

Copyright:

Variables

Methods

Child classes:

Inherited Variables

Inherited Methods

Class: AbstractScopeSniff

Class Details

Class Variables

$currentFile = null

Method Detail

__construct (Constructor) [line 50]

processMemberVar [line 177]

Parameters:

processTokenOutsideScope [line 149]

Parameters:

processTokenWithinScope [line 76]

Parameters:

processVariable [line 189]

Parameters:

processVariableInString [line 205]

Parameters: