TYPO3 CMS  TYPO3_6-2
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Extbase\Reflection\MethodReflection Class Reference
Inheritance diagram for TYPO3\CMS\Extbase\Reflection\MethodReflection:
Tx_Extbase_Reflection_MethodReflection

Public Member Functions

 __construct ($className, $methodName)
 
 getDeclaringClass ()
 
 getParameters ()
 
 isTaggedWith ($tag)
 
 getTagsValues ()
 
 getTagValues ($tag)
 
 getDescription ()
 

Protected Member Functions

 getDocCommentParser ()
 

Protected Attributes

 $docCommentParser
 

Detailed Description

This file is part of the TYPO3 CMS project.

It is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, either version 2 of the License, or any later version.

For the full copyright and license information, please read the LICENSE.txt file that was distributed with this source code.

The TYPO3 project - inspiring people to share! Extended version of the ReflectionMethod

Definition at line 19 of file MethodReflection.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Extbase\Reflection\MethodReflection::__construct (   $className,
  $methodName 
)

The constructor, initializes the reflection class

Parameters
string$classNameName of the method's class
string$methodNameName of the method to reflect

Definition at line 32 of file MethodReflection.php.

Member Function Documentation

◆ getDeclaringClass()

TYPO3\CMS\Extbase\Reflection\MethodReflection::getDeclaringClass ( )

Returns the declaring class

Returns
The declaring class

Definition at line 41 of file MethodReflection.php.

Referenced by TYPO3\CMS\Extbase\Reflection\MethodReflection\getParameters().

◆ getDescription()

TYPO3\CMS\Extbase\Reflection\MethodReflection::getDescription ( )

Returns the description part of the doc comment

Returns
string Doc comment description

Definition at line 96 of file MethodReflection.php.

References TYPO3\CMS\Extbase\Reflection\MethodReflection\getDocCommentParser().

◆ getDocCommentParser()

TYPO3\CMS\Extbase\Reflection\MethodReflection::getDocCommentParser ( )
protected

Returns an instance of the doc comment parser and runs the parse() method.

Returns

Definition at line 106 of file MethodReflection.php.

References TYPO3\CMS\Extbase\Reflection\MethodReflection\$docCommentParser.

Referenced by TYPO3\CMS\Extbase\Reflection\MethodReflection\getDescription(), TYPO3\CMS\Extbase\Reflection\MethodReflection\getTagsValues(), TYPO3\CMS\Extbase\Reflection\MethodReflection\getTagValues(), and TYPO3\CMS\Extbase\Reflection\MethodReflection\isTaggedWith().

◆ getParameters()

TYPO3\CMS\Extbase\Reflection\MethodReflection::getParameters ( )

Replacement for the original getParameters() method which makes sure that objects are returned instead of the orginal ReflectionParameter instances.

Returns
array of Parameter reflection objects of the parameters of this method

Definition at line 52 of file MethodReflection.php.

References TYPO3\CMS\Extbase\Reflection\MethodReflection\getDeclaringClass().

◆ getTagsValues()

TYPO3\CMS\Extbase\Reflection\MethodReflection::getTagsValues ( )

Returns an array of tags and their values

Returns
array Tags and values

Definition at line 77 of file MethodReflection.php.

References TYPO3\CMS\Extbase\Reflection\MethodReflection\getDocCommentParser().

◆ getTagValues()

TYPO3\CMS\Extbase\Reflection\MethodReflection::getTagValues (   $tag)

Returns the values of the specified tag

Parameters
string$tagTag name to check for
Returns
array Values of the given tag

Definition at line 87 of file MethodReflection.php.

References TYPO3\CMS\Extbase\Reflection\MethodReflection\getDocCommentParser().

◆ isTaggedWith()

TYPO3\CMS\Extbase\Reflection\MethodReflection::isTaggedWith (   $tag)

Checks if the doc comment of this method is tagged with the specified tag

Parameters
string$tagTag name to check for
Returns
boolean TRUE if such a tag has been defined, otherwise FALSE

Definition at line 67 of file MethodReflection.php.

References $result, and TYPO3\CMS\Extbase\Reflection\MethodReflection\getDocCommentParser().

Member Data Documentation

◆ $docCommentParser

TYPO3\CMS\Extbase\Reflection\MethodReflection::$docCommentParser
protected

Definition at line 24 of file MethodReflection.php.

Referenced by TYPO3\CMS\Extbase\Reflection\MethodReflection\getDocCommentParser().