Docs For Class PHP_CodeSniffer_CommentParser

Class: PHP_CodeSniffer_CommentParser_DocElement

Inherited Variables

Inherited Methods

Class Details

[line 40]
A DocElement represents a logical element within a Doc Comment.

Author: Squiz Pty Ltd

Method Detail

getLine [line 104]

int getLine(
)

Returns the line that this element started on.

Access: public

[ Top ]

getNextElement [line 96]

PHP_CodeSniffer_CommentParser_DocElement getNextElement(
)

Returns the element that appears after this element.

See: PHP_CodeSniffer_CommentParser_DocElement::getPreviousElement()
Access: public

[ Top ]

getOrder [line 78]

int getOrder(
)

Returns the order that this element appears in the doc comment.

The first element in the comment should have an order of 1.

Access: public

[ Top ]

getPreviousElement [line 87]

PHP_CodeSniffer_CommentParser_DocElement getPreviousElement(
)

Returns the element that appears before this element.

See: PHP_CodeSniffer_CommentParser_DocElement::getNextElement()
Access: public

[ Top ]

getRawContent [line 112]

string getRawContent(
)

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

Access: public

[ Top ]

getTag [line 50]

string getTag(
)

Returns the name of the tag that this element represents, omitting the @ symbol.

Access: public

[ Top ]

getWhitespaceAfter [line 68]

string getWhitespaceAfter(
)

Returns the whitespace that exists after this element.

See: PHP_CodeSniffer_CommentParser_DocElement::getWhitespaceBefore()
Access: public

[ Top ]

getWhitespaceBefore [line 59]

string getWhitespaceBefore(
)

Returns the whitespace that exists before this element.

See: PHP_CodeSniffer_CommentParser_DocElement::getWhitespaceAfter()
Access: public

[ Top ]

Class: PHP_CodeSniffer_CommentParser_DocElement

Class Overview

Author(s):

Methods

Inherited Variables

Inherited Methods

Class Details

Method Detail

getLine [line 104]

getNextElement [line 96]

getOrder [line 78]

getPreviousElement [line 87]

getRawContent [line 112]

getTag [line 50]

getWhitespaceAfter [line 68]

getWhitespaceBefore [line 59]