[ 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_AbstractDocElement

Source Location: /PHP_CodeSniffer-1.0.0RC3/CodeSniffer/CommentParser/AbstractDocElement.php

Class Overview

A class to handle most of the parsing operations of a doc comment element.

Author(s):

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

Version:

Release: 1.0.0RC3

Copyright:

2006 Squiz Pty Ltd (ABN 77 084 670 600)

Child classes:

PHP_CodeSniffer_CommentParser_PairElement: A class to represent elements that have a value => comment format.

PHP_CodeSniffer_CommentParser_ParameterElement: A class to represent param tags within a function comment.

PHP_CodeSniffer_CommentParser_SingleElement: A class to represent single element doc tags.

Inherited Variables

Inherited Methods

Class Details

[line 65]
A class to handle most of the parsing operations of a doc comment element.

Extending classes should implement the getSubElements method to return a list of elements that the doc comment element contains, in the order that they appear in the element. For example a function parameter element has a type, a variable name and a comment. It should therefore implement the method as follows:

  protected function getSubElements ()

  {
    return array(
        'type',
        'variable',
        'comment',
        );
  }

The processSubElement will be called for each of the sub elements to allow the extending class to process them. So for the parameter element we would have:

  protected function processSubElement ($name, $content, $whitespaceBefore)

  {
    if ($name === 'type') {
      echo 'The name of the variable was '.$content;
    }
    // Process other tags.
  }

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

[ Top ]

Class Variables

$afterWhitespace = ''

[line 87]

The whitespace the occurs after this element and its sub elements.

Access: protected

Type: string

[ Top ]

$nextElement = null

[line 80]

The element proceeding this element.

Access: protected

Type: PHP_CodeSniffer_CommentParser_DocElement

[ Top ]

$phpcsFile = null

[line 101]

The file this element is in.

Access: protected

Type: array(string)

[ Top ]

$previousElement = null

[line 73]

The element previous to this element.

Access: protected

Type: PHP_CodeSniffer_CommentParser_DocElement

[ Top ]

$tag = ''

[line 108]

The tag that this element represents (omiting the @ symbol).

Access: protected

Type: string

[ Top ]

$tokens = array()

[line 94]

The tokens that comprise this element.

Access: protected

Type: array(string)

[ Top ]

Method Detail

__construct (Constructor) [line 130]

PHP_CodeSniffer_CommentParser_AbstractDocElement __construct(
PHP_CodeSniffer_CommentParser_DocElement
$previousElement, array
$tokens, string
$tag, PHP_CodeSniffer_File
$phpcsFile)

Constructs a Doc Element.

Throws: Exception If $previousElement in not a DocElement or if getSubElements() does not return an array.
Access: public

Overridden in child classes as:

PHP_CodeSniffer_CommentParser_PairElement::__construct(): Constructs a PHP_CodeSniffer_CommentParser_PairElement doc tag.

PHP_CodeSniffer_CommentParser_ParameterElement::__construct(): Constructs a PHP_CodeSniffer_CommentParser_ParameterElement.

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

PHP_CodeSniffer_CommentParser_CommentElement::__construct(): Constructs a PHP_CodeSniffer_CommentParser_CommentElement.

Parameters:

PHP_CodeSniffer_CommentParser_DocElement $previousElement — The element that ocurred before this.

array $tokens — The tokens of this element.

string $tag — The doc element tag this element represents.

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

[ Top ]

getLine [line 286]

int getLine(
)

Returns the line in which this element first occured.

Access: public

[ Top ]

getNextElement [line 206]

PHP_CodeSniffer_CommentParser_DocElement getNextElement(
)

Returns the element that exists after this.

Access: public

[ Top ]

getOrder [line 246]

int getOrder(
)

Returns the order that this element appears in the comment.

Access: public

[ Top ]

getPreviousElement [line 194]

PHP_CodeSniffer_CommentParser_DocElement getPreviousElement(
)

Returns the element that exists before this.

Access: public

[ Top ]

getRawContent [line 274]

string getRawContent(
)

Returns the raw content of this element, ommiting the tag.

Access: public

[ Top ]

getSubElements [line 308]

array(string) getSubElements(
)

Returns the sub element names that make up this element in the order they appear in the element.

See: PHP_CodeSniffer_CommentParser_AbstractDocElement::processSubElement()
Abstract:
Access: protected

Overridden in child classes as:

PHP_CodeSniffer_CommentParser_PairElement::getSubElements(): Returns the element names that this tag is comprised of, in the order that they appear in the tag.

PHP_CodeSniffer_CommentParser_ParameterElement::getSubElements(): Returns the element names that this tag is comprised of, in the order that they appear in the 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.

[ Top ]

getTag [line 262]

string getTag(
)

Returns the tag that this element represents, ommiting the @ symbol.

Access: public

[ Top ]

getWhitespaceAfter [line 234]

string getWhitespaceAfter(
)

Returns the whitespace that exists after this element.

Access: public

[ Top ]

getWhitespaceBefore [line 218]

string getWhitespaceBefore(
)

Returns the whitespace that exists before this element.

Access: public

[ Top ]

processSubElement [line 322]

void processSubElement(
string
$name, string
$content, string
$whitespaceBefore)

Called to process each sub element as sepcified in the return value of getSubElements().

See: PHP_CodeSniffer_CommentParser_AbstractDocElement::getSubElements()
Abstract:
Access: protected

Overridden in child classes as:

PHP_CodeSniffer_CommentParser_PairElement::processSubElement(): Processes the sub element with the specified name.

PHP_CodeSniffer_CommentParser_ParameterElement::processSubElement(): Processes the sub element with the specified name.

PHP_CodeSniffer_CommentParser_SingleElement::processSubElement(): Processes the sub element with the specified name.

Parameters:

string $name — The name of the element to process.

string $content — The content of the the element.

string $whitespaceBefore — The whitespace found before this element.

[ Top ]