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

Packages:
PHP_CodeSniffer
PHP_CodeSniffer_MySource

Classes:

Files:

Class: PHP_CodeSniffer_Standards_AbstractVariableSniff

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

Class Overview

PHP_CodeSniffer_Standards_AbstractScopeSniff
 |
 --PHP_CodeSniffer_Standards_AbstractVariableSniff

A class to find T_VARIABLE tokens.

Author(s):

Marc McIntyre <mmcintyre at squiz.net>
Greg Sherwood <gsherwood at squiz.net>

Version:

Release: 2.6.0

Copyright:

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

Child classes:

PSR2_Sniffs_Classes_PropertyDeclarationSniff: Verifies that properties are declared correctly.

Squiz_Sniffs_Scope_MemberVarScopeSniff: Verifies that class members have scope modifiers.

Squiz_Sniffs_WhiteSpace_MemberVarSpacingSniff: Verifies that class members are spaced correctly.

Squiz_Sniffs_NamingConventions_ValidVariableNameSniff: Squiz_Sniffs_NamingConventions_ValidVariableNameSniff.

Squiz_Sniffs_Commenting_VariableCommentSniff: Parses and verifies the variable doc comment.

Zend_Sniffs_NamingConventions_ValidVariableNameSniff: Squiz_Sniffs_NamingConventions_ValidVariableNameSniff.

PEAR_Sniffs_NamingConventions_ValidVariableNameSniff: PEAR_Sniffs_NamingConventions_ValidVariableNameSniff.

Inherited Variables

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 39]
A class to find T_VARIABLE tokens.

This class can distinguish 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: Marc McIntyre <mmcintyre@squiz.net>
Author: Greg Sherwood <gsherwood@squiz.net>
Version: Release: 2.6.0
Copyright: 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600)
Link: http://pear.php.net/package/PHP_CodeSniffer
Abstract:
License: BSD Licence

[ Top ]

Class Variables

$currentFile = null

[line 61]

The current PHP_CodeSniffer file that we are processing.

Access: protected

Type: PHP_CodeSniffer_File

[ Top ]

Method Detail

__construct (Constructor) [line 67]

PHP_CodeSniffer_Standards_AbstractVariableSniff __construct(
)

Constructs an AbstractVariableTest.

Access: public

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

[ Top ]

processMemberVar [line 203]

void processMemberVar(
PHP_CodeSniffer_File
$phpcsFile, int
$stackPtr)

Called to process class member vars.

Abstract:
Access: protected

Overridden in child classes as:

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

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

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

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

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

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

PEAR_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 ]

processTokenOutsideScope [line 173]

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 97]

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 218]

void processVariable(
PHP_CodeSniffer_File
$phpcsFile, int
$stackPtr)

Called to process normal member vars.

Abstract:
Access: protected

Overridden in child classes as:

PSR2_Sniffs_Classes_PropertyDeclarationSniff::processVariable(): Processes normal variables.

Squiz_Sniffs_Scope_MemberVarScopeSniff::processVariable(): Processes normal variables.

Squiz_Sniffs_WhiteSpace_MemberVarSpacingSniff::processVariable(): Processes normal variables.

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.

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

PEAR_Sniffs_NamingConventions_ValidVariableNameSniff::processVariable(): Processes normal 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 ]

processVariableInString [line 237]

void processVariableInString(
PHP_CodeSniffer_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:

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

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

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

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 double quoted strings.

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

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

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 ]