PHP Class Neos\Flow\Reflection\DocCommentParser

Afficher le fichier Open project: neos/flow-development-collection Class Usage Examples

Protected Properties

Свойство	Type	Description
$description	string	The description as found in the doc comment
$tags	array	An array of tag names and their values (multiple values are possible)

Méthodes publiques

Méthode	Description
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.

Méthodes protégées

Méthode	Description
parseTag ( string $line ) : void	Parses a line of a doc comment for a tag and its value.

Method Details

getDescription() public méthode

Returns the description which has been previously parsed

public getDescription ( ) : string
Résultat	string	The description which has been parsed

getTagValues() public méthode

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
Résultat	array	The tag's values

getTagsValues() public méthode

Returns the tags which have been previously parsed

public getTagsValues ( ) : array
Résultat	array	Array of tag names and their (multiple) values

isTaggedWith() public méthode

Checks if a tag with the given name exists

public isTaggedWith ( string $tagName ) : boolean
$tagName	string	The tag name to check for
Résultat	boolean	TRUE the tag exists, otherwise FALSE

parseDocComment() public méthode

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
Résultat	void

parseTag() protected méthode

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
Résultat	void

Property Details

$description protected_oe property

The description as found in the doc comment

protected string $description
Résultat	string

$tags protected_oe property

An array of tag names and their values (multiple values are possible)

protected array $tags
Résultat	array