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

Packages:
PHP_CodeSniffer

Classes:

Files:

AbstractDocElement.php
AbstractParser.php
AbstractPatternSniff.php
AbstractScopeSniff.php
AbstractVariableSniff.php
ClassCommentParser.php
CodeSniffer.php
CommentElement.php
ControlSignatureSniff.php
DocElement.php
Exception.php
File.php
FunctionCallSignatureSniff.php
FunctionCommentParser.php
IncludingFileSniff.php
IncorrectPatternException.php
InlineCommentSniff.php
LineLengthSniff.php
LowerCaseConstantSniff.php
MemberCommentParser.php
MethodCallArgumentSpacingSniff.php
MultipleStatementSniff.php
OpeningMethodBraceSniff.php
PairElement.php
ParameterElement.php
ParserException.php
ScopeClosingBraceSniff.php
ScopeIndentSniff.php
ShortOpenTagSniff.php
SingleElement.php
Sniff.php
SniffException.php
Tokens.php
ValidClassNameSniff.php
ValidConstantNameSniff.php
ValidDefaultValueSniff.php
ValidFunctionNameSniff.php

Class: PHP_CodeSniffer_CommentParser_ParameterElement

Source Location: /PHP_CodeSniffer-0.1.1/CodeSniffer/CommentParser/ParameterElement.php

Class Overview

PHP_CodeSniffer_CommentParser_AbstractDocElement
 |
 --PHP_CodeSniffer_CommentParser_ParameterElement

A class to represent param tags within a function comment.

Author(s):

Squiz Pty Ltd

Methods

Inherited Variables

Class: PHP_CodeSniffer_CommentParser_AbstractDocElement

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

Inherited Methods

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 42]
A class to represent param tags within a function comment.

Author: Squiz Pty Ltd

[ Top ]

Method Detail

__construct (Constructor) [line 94]

PHP_CodeSniffer_CommentParser_ParameterElement __construct(
PHP_CodeSniffer_CommentParser_DocElement
$previousElement, array
$tokens)

Constructs a PHP_CodeSniffer_CommentParser_ParameterElement.

Access: public

Overrides PHP_CodeSniffer_CommentParser_AbstractDocElement::__construct() (Constructs a Doc Element.)

Parameters:

PHP_CodeSniffer_CommentParser_DocElement $previousElement — The element previous to this one.

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

[ Top ]

alignsWith [line 245]

boolean alignsWith(
PHP_CodeSniffer_CommentParser_ParameterElement
$other)

Returns true if this parameter aligns with the other parameter.

Access: public

Parameters:

PHP_CodeSniffer_CommentParser_ParameterElement $other — The other parameter to check alignment with.

[ Top ]

getComment [line 169]

string getComment(
)

Returns the comment of this comment for this parameter.

Access: public

[ Top ]

getPosition [line 226]

int getPosition(
)

Returns the postition of this parameter are it appears in the comment.

This method differs from getOrder as it is only relative to method parameters.

Access: public

[ Top ]

getSubElements [line 108]

array(string) getSubElements(
)

Returns the element names that this tag is comprised of, in the order that they appear in the tag.

See: PHP_CodeSniffer_CommentParser_ParameterElement::processSubElement()
Access: protected

Overrides PHP_CodeSniffer_CommentParser_AbstractDocElement::getSubElements() (Returns the sub element names that make up this element in the order they appear in the element.)

[ Top ]

getType [line 157]

string getType(
)

Returns the variable type that this string represents.

Access: public

[ Top ]

getVarName [line 145]

string getVarName(
)

Returns the variable name that this parameter tag represents.

Access: public

[ Top ]

getWhiteSpaceBeforeComment [line 211]

string getWhiteSpaceBeforeComment(
)

Returns the whitespace before the comment.

See: PHP_CodeSniffer_CommentParser_ParameterElement::getWhiteSpaceBeforeVarName()
See: PHP_CodeSniffer_CommentParser_ParameterElement::getWhiteSpaceBeforeType()
Access: public

[ Top ]

getWhiteSpaceBeforeType [line 183]

stirng getWhiteSpaceBeforeType(
)

Returns the whitespace before the variable type.

See: PHP_CodeSniffer_CommentParser_ParameterElement::getWhiteSpaceBeforeVarName()
See: PHP_CodeSniffer_CommentParser_ParameterElement::getWhiteSpaceBeforeComment()
Access: public

[ Top ]

getWhiteSpaceBeforeVarName [line 197]

string getWhiteSpaceBeforeVarName(
)

Returns the whitespace before the variable name.

See: PHP_CodeSniffer_CommentParser_ParameterElement::getWhiteSpaceBeforeComment()
See: PHP_CodeSniffer_CommentParser_ParameterElement::getWhiteSpaceBeforeType()
Access: public

[ Top ]

processSubElement [line 130]

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

Processes the sub element with the specified name.

See: PHP_CodeSniffer_CommentParser_ParameterElement::getSubElements()
Access: protected

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

Parameters:

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

string $content — The content of this sub element.

string $beforeWhitespace — The whitespace that exists before the sub element.

[ Top ]