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

Packages:
PHP_CodeSniffer

Classes:

Files:

AbstractDocElement.php
AbstractParser.php
AbstractPatternSniff.php
AbstractScopeSniff.php
AbstractVariableSniff.php
ClassCommentParser.php
CodeSniffer.php
CommentElement.php
ControlSignatureSniff.php
DocElement.php
Exception.php
File.php
FunctionCallSignatureSniff.php
FunctionCommentParser.php
IncludingFileSniff.php
IncorrectPatternException.php
InlineCommentSniff.php
LineLengthSniff.php
LowerCaseConstantSniff.php
MemberCommentParser.php
MethodCallArgumentSpacingSniff.php
MultipleStatementSniff.php
OpeningMethodBraceSniff.php
PairElement.php
ParameterElement.php
ParserException.php
ScopeClosingBraceSniff.php
ScopeIndentSniff.php
ShortOpenTagSniff.php
SingleElement.php
Sniff.php
SniffException.php
Tokens.php
ValidClassNameSniff.php
ValidConstantNameSniff.php
ValidDefaultValueSniff.php
ValidFunctionNameSniff.php

Class: PHP_CodeSniffer_Standards_AbstractVariableSniff

Source Location: /PHP_CodeSniffer-0.1.1/CodeSniffer/Standards/AbstractVariableSniff.php

Class Overview

PHP_CodeSniffer_Standards_AbstractScopeSniff
 |
 --PHP_CodeSniffer_Standards_AbstractVariableSniff

A class to find T_VARIABLE tokens.

Author(s):

Squiz Pty Ltd

Inherited Variables

Class: PHP_CodeSniffer_Standards_AbstractScopeSniff

PHP_CodeSniffer_Standards_AbstractScopeSniff::$currScope

Inherited Methods

Class: PHP_CodeSniffer_Standards_AbstractScopeSniff

PHP_CodeSniffer_Standards_AbstractScopeSniff::__construct(): Constructs a new AbstractScopeTest.
PHP_CodeSniffer_Standards_AbstractScopeSniff::process(): Processes the tokens that this test is listening for.
PHP_CodeSniffer_Standards_AbstractScopeSniff::processTokenOutsideScope(): Processes a token that is found within the scope that this test is listening to.
PHP_CodeSniffer_Standards_AbstractScopeSniff::processTokenWithinScope(): Processes a token that is found within the scope that this test is listening to.
PHP_CodeSniffer_Standards_AbstractScopeSniff::register(): The method that is called to register the tokens this test wishes to listen to.

Class Details

[line 46]
A class to find T_VARIABLE tokens.

This class can distingush between normal T_VARIABLE tokens, and those tokens that represent class members. If a class member is encountered, then then processMemberVar method is called so the extending class can process it. If the token is found to be a normal T_VARIABLE token, then processVariable is called.

Author: Squiz Pty Ltd
Abstract:

[ Top ]

Method Detail

__construct (Constructor) [line 74]

PHP_CodeSniffer_Standards_AbstractVariableSniff __construct(
)

Constructs an AbstractVariableTest.

Access: public

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

[ Top ]

processMemberVar [line 168]

void processMemberVar(
PHP_CodeSniffer_File
$phpcsFile, int
$stackPtr)

Called to process class member vars.

Abstract:
Access: protected

Parameters:

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

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

[ Top ]

processTokenOutsideScope [line 147]

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 ]

processTokenWithinScope [line 90]

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 ]

processVariable [line 179]

void processVariable(
PHP_CodeSniffer_File
$phpcsFile, int
$stackPtr)

Called to process normal member vars.

Abstract:
Access: protected

Parameters:

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

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

[ Top ]

processVariableInString [line 194]

void processVariableInString(
PHP_CodeSniffer_File
$phpcsFile, int
$stackPtr)

Called to process variables found in duoble quoted strings.

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

Abstract:
Access: protected

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 ]