Class: VariableCommentSniff

Source Location: /PHP_CodeSniffer-3.1.1/src/Standards/Squiz/Sniffs/Commenting/VariableCommentSniff.php

AbstractScopeSniff
   |
   --AbstractVariableSniff
      |
      --VariableCommentSniff

Parses and verifies the variable doc comment.

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

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

[line 16]
Parses and verifies the variable doc comment.

[ Top ]

void processMemberVar(
File
$phpcsFile, int
$stackPtr)

Called to process class member vars.

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

\PHP_CodeSniffer\Files\File	`$phpcsFile`	—	The file being scanned.
int	`$stackPtr`	—	The position of the current token in the stack passed in $tokens.

[ Top ]

void processVariable(
File
$phpcsFile, int
$stackPtr)

Called to process a normal variable.

Not required for this sniff.

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

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

void processVariableInString(
File
$phpcsFile, int
$stackPtr)

Called to process variables found in double quoted strings.

Not required for this sniff.

Overrides AbstractVariableSniff::processVariableInString() (Called to process variables found in double quoted strings or heredocs.)

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