Class: PHP_CodeSniffer_CommentParser_FunctionCommentParser

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

Class Overview

PHP_CodeSniffer_CommentParser_AbstractParser
   |
   --PHP_CodeSniffer_CommentParser_FunctionCommentParser

Parses function 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

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 34]
Parses function 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

__construct (Constructor) [line 65]

PHP_CodeSniffer_CommentParser_FunctionCommentParser __construct(
string
$comment, PHP_CodeSniffer_File
$phpcsFile)

Constructs a PHP_CodeSniffer_CommentParser_FunctionCommentParser.

Access: public

Overrides PHP_CodeSniffer_CommentParser_AbstractParser::__construct() (Constructs a Doc Comment Parser.)

Parameters:

string	`$comment`	—	The comment to parse.
PHP_CodeSniffer_File	`$phpcsFile`	—	The file that this comment is in.

[ Top ]

getAllowedTags [line 168]

array(string getAllowedTags(
)

Returns the allowed tags that can exist in a function comment.

Return: => boolean)
Access: protected

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

[ Top ]

getParams [line 128]

array(PHP_CodeSniffer_CommentParser_ParameterElement) getParams(
)

Returns the parameter elements that this function comment contains.

Returns an empty array if no parameter elements are contained within this function comment.

Access: public

[ Top ]

getReturn [line 142]

PHP_CodeSniffer_CommentParser_PairElement getReturn(
)

Returns the return element in this fucntion comment.

Returns null if no return element exists in the comment.

Access: public

[ Top ]

getThrows [line 156]

array(PHP_CodeSniffer_CommentParser_PairElement) getThrows(
)

Returns the throws elements in this fucntion comment.

Returns empty array if no throws elements in the comment.

Access: public

[ Top ]

parseParam [line 79]

PHP_CodeSniffer_CommentParser_ParameterElement parseParam(
array(string)
$tokens)

Parses parameter elements.

Access: protected

Parameters:

array(string) $tokens — The tokens that conmpise this sub element.

[ Top ]

parseReturn [line 95]

PHP_CodeSniffer_CommentParser_PairElement parseReturn(
array(string)
$tokens)

Parses return elements.

Access: protected

Parameters:

array(string) $tokens — The tokens that conmpise this sub element.

[ Top ]

parseThrows [line 111]

PHP_CodeSniffer_CommentParser_PairElement parseThrows(
array(string)
$tokens)

Parses throws elements.

Access: protected

Parameters:

array(string) $tokens — The tokens that conmpise this sub element.

[ Top ]