[ 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: PEAR_Sniffs_Commenting_FileCommentSniff

Source Location: /PHP_CodeSniffer-1.0.0RC1/CodeSniffer/Standards/PEAR/Sniffs/Commenting/FileCommentSniff.php

Class Overview

Parses and verifies the doc comments for files.

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

Methods

Child classes:

PEAR_Sniffs_Commenting_ClassCommentSniff: Parses and verifies the doc comments for classes.

Inherited Variables

Inherited Methods

Class Details

[line 46]
Parses and verifies the doc comments for files.

Verifies that :

A doc comment exists.
There is a blank newline after the short description.
There is a blank newline between the long and short description.
There is a blank newline between the long description and tags.
A PHP version is specified.
Check the order of the tags.
Check the indentation of each tag.
Check required and optional tags and the format of their content.

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

The header comment parser for the current file.

Access: protected

Type: PHP_CodeSniffer_Comment_Parser_ClassCommentParser

[ Top ]

$currentFile = null

[line 61]

The current PHP_CodeSniffer_File object we are processing.

Access: protected

Type: PHP_CodeSniffer_File

[ Top ]

Method Detail

getIndentation [line 415]

void getIndentation(
string
$tagName, PHP_CodeSniffer_CommentParser_DocElement
$tagElement)

Get the indentation information of each tag.

Access: protected

Parameters:

string $tagName — The name of the doc comment element.

PHP_CodeSniffer_CommentParser_DocElement $tagElement — The doc comment element.

[ Top ]

process [line 85]

void process(
PHP_CodeSniffer_File
$phpcsFile, int
$stackPtr)

Processes this test, when one of its tokens is encountered.

Access: public

Overridden in child classes as:

PEAR_Sniffs_Commenting_ClassCommentSniff::process(): Processes this test, when one of its tokens is encountered.

Parameters:

PHP_CodeSniffer_File $phpcsFile — The file being scanned.

int $stackPtr — The position of the current token in the stack passed in $tokens.

[ Top ]

processAuthors [line 512]

void processAuthors(
int
$commentStart)

Process the author tag(s) that this header comment has.

This function is different from other _process functions as $authors is an array of SingleElements, so we work out the errorPos for each element separately

Access: protected

Parameters:

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

[ Top ]

processCategory [line 439]

void processCategory(
int
$errorPos)

Process the category tag.

Access: protected

Parameters:

int $errorPos — The line number where the error occurs.

[ Top ]

processCopyrights [line 547]

void processCopyrights(
int
$commentStart)

Process the copyright tags.

Access: protected

Parameters:

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

[ Top ]

processLicense [line 588]

void processLicense(
int
$errorPos)

Process the license tag.

Access: protected

Parameters:

int $errorPos — The line number where the error occurs.

[ Top ]

processPackage [line 473]

void processPackage(
int
$errorPos)

Process the package tag.

Access: protected

Parameters:

int $errorPos — The line number where the error occurs.

[ Top ]

processTags [line 223]

void processTags(
int
$commentStart, int
$commentEnd)

Processes each required or optional 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 ]

processVersion [line 610]

void processVersion(
int
$errorPos)

Process the version tag.

Access: protected

Overridden in child classes as:

PEAR_Sniffs_Commenting_ClassCommentSniff::processVersion(): Process the version tag.

Parameters:

int $errorPos — The line number where the error occurs.

[ Top ]

register [line 69]

array register(
)

Returns an array of tokens this test wants to listen for.

Access: public

Overridden in child classes as:

PEAR_Sniffs_Commenting_ClassCommentSniff::register(): Returns an array of tokens this test wants to listen for.

[ Top ]