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

Packages:
PHP_CodeSniffer
PHP_CodeSniffer_MySource

Classes:

Files:

AbstractDocElement.php
AbstractParser.php
AbstractPatternSniff.php
AbstractScopeSniff.php
AbstractVariableSniff.php
ArrayBracketSpacingSniff.php
ArrayDeclarationSniff.php
BlockCommentSniff.php
CastSpacingSniff.php
ClassCommentParser.php
ClassCommentSniff.php
ClassCommentSniff.php
ClassDeclarationSniff.php
ClassDeclarationSniff.php
ClassFileNameSniff.php
ClosingDeclarationCommentSniff.php
ClosingTagSniff.php
CodeAnalyzerSniff.php
CodeSniffer.php
CodingStandard.php
CommentedOutCodeSniff.php
CommentElement.php
ComparisonOperatorUsageSniff.php
ConcatenationSpacingSniff.php
ControlSignatureSniff.php
ControlSignatureSniff.php
ControlStructureSpacingSniff.php
CyclomaticComplexitySniff.php
DisallowMultipleAssignmentsSniff.php
DisallowObEndFlushSniff.php
DisallowShortOpenTagSniff.php
DisallowTabIndentSniff.php
DocCommentAlignmentSniff.php
DocElement.php
DoubleQuoteUsageSniff.php
EchoedStringsSniff.php
ElseIfDeclarationSniff.php
EmbeddedPhpSniff.php
EmptyCatchCommentSniff.php
EvalSniff.php
Exception.php
File.php
FileCommentSniff.php
FileCommentSniff.php
FileExtensionSniff.php
ForbiddenFunctionsSniff.php
ForbiddenFunctionsSniff.php
ForEachLoopDeclarationSniff.php
ForLoopDeclarationSniff.php
FunctionCallArgumentSpacingSniff.php
FunctionCallSignatureSniff.php
FunctionClosingBraceSpaceSniff.php
FunctionCommentParser.php
FunctionCommentSniff.php
FunctionCommentSniff.php
FunctionCommentThrowTagSniff.php
FunctionDeclarationArgumentSpacingSniff.php
FunctionDeclarationSniff.php
FunctionDuplicateArgumentSniff.php
FunctionOpeningBraceSpaceSniff.php
FunctionSpacingSniff.php
Generator.php
GenericCodingStandard.php
GlobalFunctionSniff.php
GlobalKeywordSniff.php
HeredocSniff.php
HTML.php
IncludingFileSniff.php
IncorrectPatternException.php
IncrementDecrementUsageSniff.php
InlineCommentSniff.php
InlineCommentSniff.php
InlineControlStructureSniff.php
InlineIfDeclarationSniff.php
InnerFunctionsSniff.php
LineEndingsSniff.php
LineEndingsSniff.php
LineEndingsSniff.php
LineLengthSniff.php
LineLengthSniff.php
LineLengthSniff.php
LineLengthSniff.php
LongConditionClosingCommentSniff.php
LowercaseClassKeywordsSniff.php
LowerCaseConstantSniff.php
LowercaseDeclarationSniff.php
LowercaseFunctionKeywordsSniff.php
LowercasePHPFunctionsSniff.php
MemberCommentParser.php
MemberVarScopeSniff.php
MemberVarSpacingSniff.php
MethodScopeSniff.php
MultipleStatementAlignmentSniff.php
MultipleStatementAlignmentSniff.php
NestingLevelSniff.php
NonExecutableCodeSniff.php
NoSpaceAfterCastSniff.php
ObjectInstantiationSniff.php
ObjectOperatorSpacingSniff.php
OpeningFunctionBraceBsdAllmanSniff.php
OpeningFunctionBraceKernighanRitchieSniff.php
OperatorBracketSniff.php
OperatorSpacingSniff.php
OutputBufferingIndentSniff.php
PairElement.php
ParameterElement.php
ParserException.php
PEARCodingStandard.php
PHPCSCodingStandard.php
PostStatementCommentSniff.php
ScopeClosingBraceSniff.php
ScopeClosingBraceSniff.php
ScopeIndentSniff.php
ScopeIndentSniff.php
ScopeIndentSniff.php
ScopeKeywordSpacingSniff.php
SelfMemberReferenceSniff.php
SemicolonSpacingSniff.php
SingleElement.php
Sniff.php
SpaceAfterCastSniff.php
SquizCodingStandard.php
StaticThisUsageSniff.php
SuperfluousWhitespaceSniff.php
SwitchDeclarationSniff.php
Text.php
Tokens.php
UpperCaseConstantNameSniff.php
UpperCaseConstantSniff.php
ValidClassNameSniff.php
ValidClassNameSniff.php
ValidDefaultValueSniff.php
ValidFunctionNameSniff.php
ValidFunctionNameSniff.php
ValidInterfaceNameSniff.php
ValidLogicalOperatorsSniff.php
ValidVariableNameSniff.php
ValidVariableNameSniff.php
VariableCommentSniff.php
ZendCodingStandard.php

Class: Squiz_Sniffs_Commenting_VariableCommentSniff

Source Location: /PHP_CodeSniffer-1.0.0RC1/CodeSniffer/Standards/Squiz/Sniffs/Commenting/VariableCommentSniff.php

Class Overview

PHP_CodeSniffer_Standards_AbstractScopeSniff
 |
 --PHP_CodeSniffer_Standards_AbstractVariableSniff
 |
 --Squiz_Sniffs_Commenting_VariableCommentSniff

Parses and verifies the variable doc comment.

Author(s):

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

Version:

Release: 1.0.0RC1

Copyright:

2006 Squiz Pty Ltd (ABN 77 084 670 600)

Variables

$commentParser

Methods

Inherited Variables

Class: PHP_CodeSniffer_Standards_AbstractVariableSniff

PHP_CodeSniffer_Standards_AbstractVariableSniff::$currentFile

Class: PHP_CodeSniffer_Standards_AbstractScopeSniff

PHP_CodeSniffer_Standards_AbstractScopeSniff::$currScope

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 47]
Parses and verifies the variable doc comment.

Verifies that :

A variable doc comment exists.
Short description ends with a full stop.
There is a blank line after the short description.
There is a blank line between the description and the tags.
Check the order, indentation and content of each tag.

Author: Marc McIntyre <mmcintyre@squiz.net>
Author: Greg Sherwood <gsherwood@squiz.net>
Version: Release: 1.0.0RC1
Copyright: 2006 Squiz Pty Ltd (ABN 77 084 670 600)
Link: http://pear.php.net/package/PHP_CodeSniffer
License: BSD Licence

[ Top ]

Class Variables

$commentParser = null

[line 55]

The header comment parser for the current file.

Access: protected

Type: PHP_CodeSniffer_Comment_Parser_ClassCommentParser

[ Top ]

Method Detail

processMemberVar [line 67]

void processMemberVar(
PHP_CodeSniffer_File
$phpcsFile, int
$stackPtr)

Called to process class member vars.

Access: public

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 ]

processSees [line 317]

void processSees(
int
$commentStart)

Process the see tags.

Access: protected

Parameters:

int $commentStart — The position in the stack where the comment started.

[ Top ]

processSince [line 263]

void processSince(
int
$commentStart, int
$commentEnd)

Process the since tag.

Access: protected

Parameters:

int $commentStart — The position in the stack where the comment started.

int $commentEnd — The position in the stack where the comment ended.

[ Top ]

processVar [line 209]

void processVar(
int
$commentStart, int
$commentEnd)

Process the var tag.

Access: protected

Parameters:

int $commentStart — The position in the stack where the comment started.

int $commentEnd — The position in the stack where the comment ended.

[ Top ]

processVariable [line 353]

void processVariable(
PHP_CodeSniffer_File
$phpcsFile, int
$stackPtr)

Called to process a normal variable.

Not required for this sniff.

Access: protected

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

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 ]

processVariableInString [line 371]

void processVariableInString(
PHP_CodeSniffer_File
$phpcsFile, int
$stackPtr)

Called to process variables found in duoble quoted strings.

Not required for this sniff.

Access: protected

Overrides PHP_CodeSniffer_Standards_AbstractVariableSniff::processVariableInString() (Called to process variables found in duoble 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 ]