Docs For Class PHP_CodeSniffer_Standards

PHP_CodeSniffer_Standards_AbstractVariableSniff __construct(
)

Constructs an AbstractVariableTest.

Access: public

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

[ Top ]

void processMemberVar(
PHP_CodeSniffer_File
$phpcsFile, int
$stackPtr)

Called to process class member vars.

Abstract:
Access: protected

Overridden in child classes as:

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

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

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

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

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

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

Parameters:

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

[ Top ]

void processTokenOutsideScope(
PHP_CodeSniffer_File
$phpcsFile, int
$stackPtr)

Processes the token outside the scope in the file.

Access: protected

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

Parameters:

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

[ Top ]

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

Processes the token in the specified PHP_CodeSniffer_File.

Access: protected

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

Parameters:

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

[ Top ]

void processVariable(
PHP_CodeSniffer_File
$phpcsFile, int
$stackPtr)

Called to process normal member vars.

Abstract:
Access: protected

Overridden in child classes as:

Squiz_Sniffs_NamingConventions_ValidVariableNameSniff::processVariable(): Processes this test, when one of its tokens is encountered.

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

Squiz_Sniffs_Scope_MemberVarScopeSniff::processVariable(): Processes normal variables.

Squiz_Sniffs_WhiteSpace_MemberVarSpacingSniff::processVariable(): Processes normal variables.

PEAR_Sniffs_NamingConventions_ValidVariableNameSniff::processVariable(): Processes normal variables.

Zend_Sniffs_NamingConventions_ValidVariableNameSniff::processVariable(): Processes this test, when one of its tokens is encountered.

Parameters:

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

[ Top ]

void processVariableInString(
PHP_CodeSniffer_File
$phpcsFile, int
$stackPtr)

Called to process variables found in duoble 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:

Squiz_Sniffs_NamingConventions_ValidVariableNameSniff::processVariableInString(): Processes the variable found within a double quoted string.

Squiz_Sniffs_Commenting_VariableCommentSniff::processVariableInString(): Called to process variables found in duoble quoted strings.

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

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

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

Zend_Sniffs_NamingConventions_ValidVariableNameSniff::processVariableInString(): Processes the variable found within a double quoted string.

Parameters:

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

[ Top ]

Class: PHP_CodeSniffer_Standards_AbstractVariableSniff

Class Overview

Author(s):

Version:

Copyright:

Variables

Methods

Child classes:

Inherited Variables

Class: PHP_CodeSniffer_Standards_AbstractScopeSniff

Inherited Methods

Class: PHP_CodeSniffer_Standards_AbstractScopeSniff

Class Details

Class Variables

$currentFile = null

Method Detail

__construct (Constructor) [line 67]

processMemberVar [line 202]

Parameters:

processTokenOutsideScope [line 172]

Parameters:

processTokenWithinScope [line 96]

Parameters:

processVariable [line 217]

Parameters:

processVariableInString [line 236]

Parameters: