![]() |
TYPO3
7.6
|
Public Member Functions | |
parseDocComment ($docComment) | |
getTagsValues () | |
getTagValues ($tagName) | |
isTaggedWith ($tagName) | |
getDescription () | |
Protected Member Functions | |
parseTag ($line) | |
Protected Attributes | |
$description = '' | |
$tags = array() | |
A little parser which creates tag objects from doc comments
Definition at line 20 of file DocCommentParser.php.
getDescription | ( | ) |
Returns the description which has been previously parsed
Definition at line 98 of file DocCommentParser.php.
References DocCommentParser\$description.
getTagsValues | ( | ) |
Returns the tags which have been previously parsed
Definition at line 60 of file DocCommentParser.php.
References DocCommentParser\$tags.
getTagValues | ( | $tagName | ) |
Returns the values of the specified tag. The doc comment must be parsed with parseDocComment() before tags are available.
string | $tagName | The tag name to retrieve the values for |
\RuntimeException |
Definition at line 74 of file DocCommentParser.php.
References DocCommentParser\isTaggedWith().
isTaggedWith | ( | $tagName | ) |
Checks if a tag with the given name exists
string | $tagName | The tag name to check for |
Definition at line 88 of file DocCommentParser.php.
Referenced by DocCommentParser\getTagValues().
parseDocComment | ( | $docComment | ) |
Parses the given doc comment and saves the result (description and tags) in the parser's object. They can be retrieved by the getTags() getTagValues() and getDescription() methods.
string | $docComment | A doc comment as returned by the reflection getDocComment() method |
Definition at line 40 of file DocCommentParser.php.
References elseif, and DocCommentParser\parseTag().
|
protected |
Parses a line of a doc comment for a tag and its value. The result is stored in the interal tags array.
string | $line | A line of a doc comment which starts with an @-sign |
Definition at line 110 of file DocCommentParser.php.
Referenced by DocCommentParser\parseDocComment().
|
protected |
Definition at line 25 of file DocCommentParser.php.
Referenced by DocCommentParser\getDescription().
|
protected |
Definition at line 30 of file DocCommentParser.php.
Referenced by DocCommentParser\getTagsValues().