PHP Класс Neos\Flow\Reflection\DocCommentParser

Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$description string The description as found in the doc comment
$tags array An array of tag names and their values (multiple values are possible)

Открытые методы

Метод Описание
getDescription ( ) : string Returns the description which has been previously parsed
getTagValues ( string $tagName ) : array Returns the values of the specified tag. The doc comment must be parsed with parseDocComment() before tags are available.
getTagsValues ( ) : array Returns the tags which have been previously parsed
isTaggedWith ( string $tagName ) : boolean Checks if a tag with the given name exists
parseDocComment ( string $docComment ) : void 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.

Защищенные методы

Метод Описание
parseTag ( string $line ) : void Parses a line of a doc comment for a tag and its value.

Описание методов

getDescription() публичный Метод

Returns the description which has been previously parsed
public getDescription ( ) : string
Результат string The description which has been parsed

getTagValues() публичный Метод

Returns the values of the specified tag. The doc comment must be parsed with parseDocComment() before tags are available.
public getTagValues ( string $tagName ) : array
$tagName string The tag name to retrieve the values for
Результат array The tag's values

getTagsValues() публичный Метод

Returns the tags which have been previously parsed
public getTagsValues ( ) : array
Результат array Array of tag names and their (multiple) values

isTaggedWith() публичный Метод

Checks if a tag with the given name exists
public isTaggedWith ( string $tagName ) : boolean
$tagName string The tag name to check for
Результат boolean TRUE the tag exists, otherwise FALSE

parseDocComment() публичный Метод

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.
public parseDocComment ( string $docComment ) : void
$docComment string A doc comment as returned by the reflection getDocComment() method
Результат void

parseTag() защищенный Метод

The result is stored in the internal tags array.
protected parseTag ( string $line ) : void
$line string A line of a doc comment which starts with an @-sign
Результат void

Описание свойств

$description защищенное свойство

The description as found in the doc comment
protected string $description
Результат string

$tags защищенное свойство

An array of tag names and their values (multiple values are possible)
protected array $tags
Результат array