Class: PHP_CodeSniffer_CommentParser_MemberCommentParser

Source Location: /PHP_CodeSniffer-0.8.0/CodeSniffer/CommentParser/MemberCommentParser.php

Class Overview

PHP_CodeSniffer_CommentParser_AbstractParser
 |
 --PHP_CodeSniffer_CommentParser_ClassCommentParser
 |
 --PHP_CodeSniffer_CommentParser_MemberCommentParser

Parses class member comments.

Author(s):

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

Version:

Release: 0.8.0

Copyright:

2006 Squiz Pty Ltd (ABN 77 084 670 600)

Methods

Inherited Variables

Class: PHP_CodeSniffer_CommentParser_AbstractParser

PHP_CodeSniffer_CommentParser_AbstractParser::$comment
PHP_CodeSniffer_CommentParser_AbstractParser::$commentString
PHP_CodeSniffer_CommentParser_AbstractParser::$deprecated
PHP_CodeSniffer_CommentParser_AbstractParser::$links
PHP_CodeSniffer_CommentParser_AbstractParser::$orders
PHP_CodeSniffer_CommentParser_AbstractParser::$phpcsFile
PHP_CodeSniffer_CommentParser_AbstractParser::$previousElement
PHP_CodeSniffer_CommentParser_AbstractParser::$sees
PHP_CodeSniffer_CommentParser_AbstractParser::$since
PHP_CodeSniffer_CommentParser_AbstractParser::$unknown
PHP_CodeSniffer_CommentParser_AbstractParser::$words

Inherited Methods

Class: PHP_CodeSniffer_CommentParser_ClassCommentParser

PHP_CodeSniffer_CommentParser_ClassCommentParser::getAllowedTags(): Returns the allowed tags withing a class comment.
PHP_CodeSniffer_CommentParser_ClassCommentParser::getAuthors(): Returns the authors of this class comment.
PHP_CodeSniffer_CommentParser_ClassCommentParser::getCategory(): Returns the category of this class comment.
PHP_CodeSniffer_CommentParser_ClassCommentParser::getCopyright(): Returns the copyright of this class comment.
PHP_CodeSniffer_CommentParser_ClassCommentParser::getLicense(): Returns the license of this class comment.
PHP_CodeSniffer_CommentParser_ClassCommentParser::getPackage(): Returns the package that this class belongs to.
PHP_CodeSniffer_CommentParser_ClassCommentParser::getSubpackage(): Returns the subpackage that this class belongs to.
PHP_CodeSniffer_CommentParser_ClassCommentParser::getVersion(): Returns the version of this class comment.
PHP_CodeSniffer_CommentParser_ClassCommentParser::parseAuthor(): Parses the author tag of this class comment.
PHP_CodeSniffer_CommentParser_ClassCommentParser::parseCategory(): Parses the category tag of this class comment.
PHP_CodeSniffer_CommentParser_ClassCommentParser::parseCopyright(): Parses the copyright tag of this class comment.
PHP_CodeSniffer_CommentParser_ClassCommentParser::parseLicense(): Parses the license tag of this class comment.
PHP_CodeSniffer_CommentParser_ClassCommentParser::parsePackage(): Parses the package tag found in this test.
PHP_CodeSniffer_CommentParser_ClassCommentParser::parseSubpackage(): Parses the package tag found in this test.
PHP_CodeSniffer_CommentParser_ClassCommentParser::parseVersion(): Parses the version tag of this class comment.

Class: PHP_CodeSniffer_CommentParser_AbstractParser

PHP_CodeSniffer_CommentParser_AbstractParser::__construct(): Constructs a Doc Comment Parser.
PHP_CodeSniffer_CommentParser_AbstractParser::getAllowedTags(): Returns a list of tags that this comment parser allows for it's comment.
PHP_CodeSniffer_CommentParser_AbstractParser::getComment(): Returns the comment element that appears at the top of this doc comment.
PHP_CodeSniffer_CommentParser_AbstractParser::getDeprecated(): Returns the deprecated element found in this comment.
PHP_CodeSniffer_CommentParser_AbstractParser::getLine(): Returns the line that the token exists on in the doc comment.
PHP_CodeSniffer_CommentParser_AbstractParser::getLinks(): Returns the link elements found in this comment.
PHP_CodeSniffer_CommentParser_AbstractParser::getSees(): Returns the see elements that appear in this doc comment.
PHP_CodeSniffer_CommentParser_AbstractParser::getSince(): Returns the since element found in this comment.
PHP_CodeSniffer_CommentParser_AbstractParser::getTagOrders(): Returns the tag orders (index => tagName).
PHP_CodeSniffer_CommentParser_AbstractParser::getUnknown(): Returns the unknown tags.
PHP_CodeSniffer_CommentParser_AbstractParser::parse(): Initiates the parsing of the doc comment.
PHP_CodeSniffer_CommentParser_AbstractParser::parseComment(): Parses the comment element that appears at the top of the doc comment.
PHP_CodeSniffer_CommentParser_AbstractParser::parseDeprecated(): Parses \@deprecated tags.
PHP_CodeSniffer_CommentParser_AbstractParser::parseLink(): Parses \@link tags.
PHP_CodeSniffer_CommentParser_AbstractParser::parseSee(): Parses see tag element within the doc comment.
PHP_CodeSniffer_CommentParser_AbstractParser::parseSince(): Parses \@since tags.
PHP_CodeSniffer_CommentParser_AbstractParser::parseTag(): Parses the specified tag.

Class Details

[line 33]
Parses class member comments.

Author: Marc McIntyre <mmcintyre@squiz.net>
Author: Greg Sherwood <gsherwood@squiz.net>
Version: Release: 0.8.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

getAllowedTags [line 76]

array getAllowedTags(
)

Returns the allowed tags for this parser.

Access: protected

Overrides PHP_CodeSniffer_CommentParser_ClassCommentParser::getAllowedTags() (Returns the allowed tags withing a class comment.)

[ Top ]

getVar [line 64]

PHP_CodeSniffer_CommentParser_PairElement getVar(
)

Returns the var tag found in the member comment.

Access: public

[ Top ]

parseVar [line 51]

PHP_CodeSniffer_CommentParser_SingleElement parseVar(
array
$tokens)

Parses Var tags.

Access: protected

Parameters:

array $tokens — The tokens that represent this tag.

[ Top ]