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

Class: Squiz_Sniffs_NamingConventions_ValidVariableNameSniff

Source Location: /PHP_CodeSniffer-0.7.0/CodeSniffer/Standards/Squiz/Sniffs/NamingConventions/ValidVariableNameSniff.php

Class Overview

PHP_CodeSniffer_Standards_AbstractScopeSniff
   |
   --PHP_CodeSniffer_Standards_AbstractVariableSniff
      |
      --Squiz_Sniffs_NamingConventions_ValidVariableNameSniff

Squiz_Sniffs_NamingConventions_ValidVariableNameSniff.


Author(s):

Version:

  • Release: 0.7.0

Copyright:

  • 2006 Squiz Pty Ltd (ABN 77 084 670 600)

Methods


Inherited Variables

Inherited Methods

Class: PHP_CodeSniffer_Standards_AbstractVariableSniff

PHP_CodeSniffer_Standards_AbstractVariableSniff::__construct()
Constructs an AbstractVariableTest.
PHP_CodeSniffer_Standards_AbstractVariableSniff::processMemberVar()
Called to process class member vars.
PHP_CodeSniffer_Standards_AbstractVariableSniff::processTokenOutsideScope()
Processes the token outside the scope in the file.
PHP_CodeSniffer_Standards_AbstractVariableSniff::processTokenWithinScope()
Processes the token in the specified PHP_CodeSniffer_File.
PHP_CodeSniffer_Standards_AbstractVariableSniff::processVariable()
Called to process normal member vars.
PHP_CodeSniffer_Standards_AbstractVariableSniff::processVariableInString()
Called to process variables found in duoble quoted strings.

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 33]
Squiz_Sniffs_NamingConventions_ValidVariableNameSniff.

Checks the naming of variables and member variables.



[ Top ]


Method Detail

processMemberVar   [line 138]

void processMemberVar( PHP_CodeSniffer_File $phpcsFile, int $stackPtr)

Processes class member variables.
  • Access: protected

Overrides PHP_CodeSniffer_Standards_AbstractVariableSniff::processMemberVar() (Called to process class member vars.)

Parameters:

PHP_CodeSniffer_File   $phpcsFile   —  The file being scanned.
int   $stackPtr   —  The position of the current token in the stack passed in $tokens.

[ Top ]

processVariable   [line 56]

void processVariable( PHP_CodeSniffer_File $phpcsFile, int $stackPtr)

Processes this test, when one of its tokens is encountered.
  • Access: protected

Overrides PHP_CodeSniffer_Standards_AbstractVariableSniff::processVariable() (Called to process normal member vars.)

Parameters:

PHP_CodeSniffer_File   $phpcsFile   —  The file being scanned.
int   $stackPtr   —  The position of the current token in the stack passed in $tokens.

[ Top ]

processVariableInString   [line 178]

void processVariableInString( PHP_CodeSniffer_File $phpcsFile, int $stackPtr)

Processes the variable found within a double quoted string.
  • Access: protected

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

Parameters:

PHP_CodeSniffer_File   $phpcsFile   —  The file being scanned.
int   $stackPtr   —  The position of the double quoted string.

[ Top ]


Documentation generated on Mon, 11 Mar 2019 15:06:37 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.