Class: PHP_CodeSniffer_CommentParser_PairElement

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

Class Overview

PHP_CodeSniffer_CommentParser_AbstractDocElement
 |
 --PHP_CodeSniffer_CommentParser_PairElement

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

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 45]
A class to represent elements that have a value => comment format.

An example of a pair element tag is the \@throws as it has an exception type and a comment on the circumstance of when the exception is thrown.

Author: Squiz Pty Ltd

[ Top ]

Method Detail

__construct (Constructor) [line 70]

PHP_CodeSniffer_CommentParser_PairElement __construct(
PHP_CodeSniffer_CommentParser_DocElement
$previousElement, array
$tokens, string
$tag)

Constructs a PHP_CodeSniffer_CommentParser_PairElement doc tag.

Access: public

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

Parameters:

PHP_CodeSniffer_CommentParser_DocElement $previousElement — The element before this one.

array $tokens — The tokens that comprise this element.

string $tag — The tag that this element represents.

[ Top ]

getComment [line 132]

string getComment(
)

Returns the comment associated with the value of this tag.

Access: public

[ Top ]

getSubElements [line 84]

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_PairElement::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 ]

getValue [line 120]

string getValue(
)

Returns the value of the tag.

Access: public

[ Top ]

processSubElement [line 105]

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

Processes the sub element with the specified name.

See: PHP_CodeSniffer_CommentParser_PairElement::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 $whitespaceBefore — The whitespace that exists before the sub element.

[ Top ]