PHP Class Neos\Flow\Reflection\MethodReflection

Inheritance: extends ReflectionMethod
Datei anzeigen Open project: neos/flow-development-collection Class Usage Examples

Protected Properties

Property Type Description
$docCommentParser

Public Methods

Method Description
getDeclaredReturnType ( ) : string
getDeclaringClass ( ) : ClassReflection Returns the declaring class
getDescription ( ) : string Returns the description part of the doc comment
getParameters ( ) : array Replacement for the original getParameters() method which makes sure that ParameterReflection objects are returned instead of the original ReflectionParameter instances.
getTagValues ( string $tag ) : array Returns the values of the specified tag
getTagsValues ( ) : array Returns an array of tags and their values
isTaggedWith ( string $tag ) : boolean Checks if the doc comment of this method is tagged with the specified tag

Protected Methods

Method Description
getDocCommentParser ( ) : DocCommentParser Returns an instance of the doc comment parser and runs the parse() method.

Method Details

getDeclaredReturnType() public method

public getDeclaredReturnType ( ) : string
return string The name of a type (e.g. string, \stdClass) if it was declared as a return type, null otherwise

getDeclaringClass() public method

Returns the declaring class
public getDeclaringClass ( ) : ClassReflection
return ClassReflection The declaring class

getDescription() public method

Returns the description part of the doc comment
public getDescription ( ) : string
return string Doc comment description

getDocCommentParser() protected method

Returns an instance of the doc comment parser and runs the parse() method.
protected getDocCommentParser ( ) : DocCommentParser
return DocCommentParser

getParameters() public method

Replacement for the original getParameters() method which makes sure that ParameterReflection objects are returned instead of the original ReflectionParameter instances.
public getParameters ( ) : array
return array

getTagValues() public method

Returns the values of the specified tag
public getTagValues ( string $tag ) : array
$tag string Tag name to check for
return array Values of the given tag

getTagsValues() public method

Returns an array of tags and their values
public getTagsValues ( ) : array
return array Tags and values

isTaggedWith() public method

Checks if the doc comment of this method is tagged with the specified tag
public isTaggedWith ( string $tag ) : boolean
$tag string Tag name to check for
return boolean TRUE if such a tag has been defined, otherwise FALSE

Property Details

$docCommentParser protected_oe property

protected $docCommentParser