[ 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
DisallowInlineIfSniff.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
LanguageConstructSpacingSniff.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
ValidLogicalOperatorsSniff.php
ValidVariableNameSniff.php
ValidVariableNameSniff.php
VariableCommentSniff.php
ZendCodingStandard.php

Class: PHP_CodeSniffer_CommentParser_CommentElement

Source Location: /PHP_CodeSniffer-1.0.0/CodeSniffer/CommentParser/CommentElement.php

Class Overview

PHP_CodeSniffer_CommentParser_AbstractDocElement
 |
 --PHP_CodeSniffer_CommentParser_SingleElement
 |
 --PHP_CodeSniffer_CommentParser_CommentElement

A class to represent Comments of a doc comment.

Author(s):

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

Version:

Release: 1.0.0

Copyright:

2006 Squiz Pty Ltd (ABN 77 084 670 600)

Methods

Inherited Variables

Class: PHP_CodeSniffer_CommentParser_SingleElement

PHP_CodeSniffer_CommentParser_SingleElement::$content
PHP_CodeSniffer_CommentParser_SingleElement::$contentWhitespace

Class: PHP_CodeSniffer_CommentParser_AbstractDocElement

PHP_CodeSniffer_CommentParser_AbstractDocElement::$afterWhitespace
PHP_CodeSniffer_CommentParser_AbstractDocElement::$nextElement
PHP_CodeSniffer_CommentParser_AbstractDocElement::$phpcsFile
PHP_CodeSniffer_CommentParser_AbstractDocElement::$previousElement
PHP_CodeSniffer_CommentParser_AbstractDocElement::$tag
PHP_CodeSniffer_CommentParser_AbstractDocElement::$tokens

Inherited Methods

Class: PHP_CodeSniffer_CommentParser_SingleElement

PHP_CodeSniffer_CommentParser_SingleElement::__construct(): Constructs a SingleElement doc tag.
PHP_CodeSniffer_CommentParser_SingleElement::getContent(): Returns the content of this tag.
PHP_CodeSniffer_CommentParser_SingleElement::getSubElements(): Returns the element names that this tag is comprised of, in the order that they appear in the tag.
PHP_CodeSniffer_CommentParser_SingleElement::getWhitespaceBeforeContent(): Returns the witespace before the content of this tag.
PHP_CodeSniffer_CommentParser_SingleElement::process(): Processes a content check for single doc element.
PHP_CodeSniffer_CommentParser_SingleElement::processSubElement(): Processes the sub element with the specified name.

Class: PHP_CodeSniffer_CommentParser_AbstractDocElement

PHP_CodeSniffer_CommentParser_AbstractDocElement::__construct(): Constructs a Doc Element.
PHP_CodeSniffer_CommentParser_AbstractDocElement::getLine(): Returns the line in which this element first occured.
PHP_CodeSniffer_CommentParser_AbstractDocElement::getNextElement(): Returns the element that exists after this.
PHP_CodeSniffer_CommentParser_AbstractDocElement::getOrder(): Returns the order that this element appears in the comment.
PHP_CodeSniffer_CommentParser_AbstractDocElement::getPreviousElement(): Returns the element that exists before this.
PHP_CodeSniffer_CommentParser_AbstractDocElement::getRawContent(): Returns the raw content of this element, ommiting the tag.
PHP_CodeSniffer_CommentParser_AbstractDocElement::getSubElements(): Returns the sub element names that make up this element in the order they appear in the element.
PHP_CodeSniffer_CommentParser_AbstractDocElement::getTag(): Returns the tag that this element represents, ommiting the @ symbol.
PHP_CodeSniffer_CommentParser_AbstractDocElement::getWhitespaceAfter(): Returns the whitespace that exists after this element.
PHP_CodeSniffer_CommentParser_AbstractDocElement::getWhitespaceBefore(): Returns the whitespace that exists before this element.
PHP_CodeSniffer_CommentParser_AbstractDocElement::processSubElement(): Called to process each sub element as sepcified in the return value of getSubElements().

Class Details

[line 48]
A class to represent Comments of a doc comment.

Comments are in the following format.

Note that the sentence before two newlines is assumed the short comment description.

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

[ Top ]

Method Detail

__construct (Constructor) [line 69]

PHP_CodeSniffer_CommentParser_CommentElement __construct(
PHP_CodeSniffer_CommentParser_DocElemement
$previousElement, array
$tokens, PHP_CodeSniffer_File
$phpcsFile)

Constructs a PHP_CodeSniffer_CommentParser_CommentElement.

Access: public

Overrides PHP_CodeSniffer_CommentParser_SingleElement::__construct() (Constructs a SingleElement doc tag.)

Parameters:

PHP_CodeSniffer_CommentParser_DocElemement $previousElement — The element that appears before this element.

array $tokens — The tokens that make up this element.

PHP_CodeSniffer_File $phpcsFile — The file that this element is in.

[ Top ]

getLongComment [line 139]

string getLongComment(
)

Returns the long comment description.

See: PHP_CodeSniffer_CommentParser_CommentElement::getShortComment()
Access: public

[ Top ]

getNewlineAfter [line 207]

int getNewlineAfter(
)

Returns the number of newlines that exist before the tags.

Access: public

[ Top ]

getShortComment [line 82]

string getShortComment(
)

Returns the short comment description.

See: PHP_CodeSniffer_CommentParser_CommentElement::getLongComment()
Access: public

[ Top ]

getWhiteSpaceBetween [line 189]

string getWhiteSpaceBetween(
)

Returns the whitespace that exists between the short and the long comment description.

Access: public

[ Top ]

isEmpty [line 231]

boolean isEmpty(
)

Returns true if there is no comment.

Access: public

[ Top ]