Class: PHP_CodeSniffer_CommentParser_ClassCommentParser

Source Location: /PHP_CodeSniffer-0.7.0/CodeSniffer/CommentParser/ClassCommentParser.php

Class Overview

PHP_CodeSniffer_CommentParser_AbstractParser
   |
   --PHP_CodeSniffer_CommentParser_ClassCommentParser

Parses Class doc comments.

Author(s):

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

Version:

Release: 0.7.0

Copyright:

2006 Squiz Pty Ltd (ABN 77 084 670 600)

Methods

Child classes:

PHP_CodeSniffer_CommentParser_MemberCommentParser: Parses class member comments.

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_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 31]
Parses Class doc comments.

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

array(string getAllowedTags(
)

Returns the allowed tags withing a class comment.

Return: => int)
Access: protected

Overridden in child classes as:

PHP_CodeSniffer_CommentParser_MemberCommentParser::getAllowedTags(): Returns the allowed tags for this parser.

Overrides PHP_CodeSniffer_CommentParser_AbstractParser::getAllowedTags() (Returns a list of tags that this comment parser allows for it's comment.)

[ Top ]

getAuthors [line 215]

array(PHP_CodeSniffer_CommentParser_SingleElement) getAuthors(
)

Returns the authors of this class comment.

Access: public

[ Top ]

getCategory [line 263]

PHP_CodeSniffer_CommentParser_SingleElement getCategory(
)

Returns the category of this class comment.

Access: public

[ Top ]

getCopyright [line 251]

PHP_CodeSniffer_CommentParser_SingleElement getCopyright(
)

Returns the copyright of this class comment.

Access: public

[ Top ]

getLicense [line 239]

PHP_CodeSniffer_CommentParser_PairElement getLicense(
)

Returns the license of this class comment.

Access: public

[ Top ]

getPackage [line 275]

PHP_CodeSniffer_CommentParser_SingleElement getPackage(
)

Returns the package that this class belongs to.

Access: public

[ Top ]

getSubpackage [line 287]

PHP_CodeSniffer_CommentParser_SingleElement getSubpackage(
)

Returns the subpackage that this class belongs to.

Access: public

[ Top ]

getVersion [line 227]

PHP_CodeSniffer_CommentParser_SingleElement getVersion(
)

Returns the version of this class comment.

Access: public

[ Top ]

parseAuthor [line 156]

array(PHP_CodeSniffer_CommentParser_SingleElement) parseAuthor(
array
$tokens)

Parses the author tag of this class comment.

Access: protected

Parameters:

array $tokens — The tokens that comprise this tag.

[ Top ]

parseCategory [line 141]

PHP_CodeSniffer_CommentParser_SingleElement parseCategory(
array
$tokens)

Parses the category tag of this class comment.

Access: protected

Parameters:

array $tokens — The tokens that comprise this tag.

[ Top ]

parseCopyright [line 126]

PHP_CodeSniffer_CommentParser_SingleElement parseCopyright(
array
$tokens)

Parses the copyright tag of this class comment.

Access: protected

Parameters:

array $tokens — The tokens that comprise this tag.

[ Top ]

parseLicense [line 111]

PHP_CodeSniffer_CommentParser_PairElement parseLicense(
array
$tokens)

Parses the license tag of this class comment.

Access: protected

Parameters:

array $tokens — The tokens that comprise this tag.

[ Top ]

parsePackage [line 187]

PHP_CodeSniffer_CommentParser_SingleElement parsePackage(
array
$tokens)

Parses the package tag found in this test.

Access: protected

Parameters:

array $tokens — The tokens that comprise this var.

[ Top ]

parseSubpackage [line 202]

PHP_CodeSniffer_CommentParser_SingleElement parseSubpackage(
array
$tokens)

Parses the package tag found in this test.

Access: protected

Parameters:

array $tokens — The tokens that comprise this var.

[ Top ]

parseVersion [line 172]

PHP_CodeSniffer_CommentParser_SingleElement parseVersion(
array
$tokens)

Parses the version tag of this class comment.

Access: protected

Parameters:

array $tokens — The tokens that comprise this tag.

[ Top ]