PHP 7.0.6 Released

The ReflectionMethod class

(PHP 5, PHP 7)

Introduction

The ReflectionMethod class reports information about a method.

Class synopsis

ReflectionMethod extends ReflectionFunctionAbstract implements Reflector {

/* Constants */

const integer IS_STATIC = 1 ;

const integer IS_PUBLIC = 256 ;

const integer IS_PROTECTED = 512 ;

const integer IS_PRIVATE = 1024 ;

const integer IS_ABSTRACT = 2 ;

const integer IS_FINAL = 4 ;

/* Properties */

public $name ;

public $class ;

/* Methods */

public __construct ( mixed $class , string $name )

public static string export ( string $class , string $name [, bool $return = false ] )

public Closure getClosure ( object $object )

public ReflectionClass getDeclaringClass ( void )

public int getModifiers ( void )

public ReflectionMethod getPrototype ( void )

public mixed invoke ( object $object [, mixed $parameter [, mixed $... ]] )

public mixed invokeArgs ( object $object , array $args )

public bool isAbstract ( void )

public bool isConstructor ( void )

public bool isDestructor ( void )

public bool isFinal ( void )

public bool isPrivate ( void )

public bool isProtected ( void )

public bool isPublic ( void )

public bool isStatic ( void )

public void setAccessible ( bool $accessible )

public string __toString ( void )

/* Inherited methods */

final private void ReflectionFunctionAbstract::__clone ( void )

public ReflectionClass ReflectionFunctionAbstract::getClosureScopeClass ( void )

public object ReflectionFunctionAbstract::getClosureThis ( void )

public string ReflectionFunctionAbstract::getDocComment ( void )

public int ReflectionFunctionAbstract::getEndLine ( void )

public ReflectionExtension ReflectionFunctionAbstract::getExtension ( void )

public string ReflectionFunctionAbstract::getExtensionName ( void )

public string ReflectionFunctionAbstract::getFileName ( void )

public string ReflectionFunctionAbstract::getName ( void )

public string ReflectionFunctionAbstract::getNamespaceName ( void )

public int ReflectionFunctionAbstract::getNumberOfParameters ( void )

public int ReflectionFunctionAbstract::getNumberOfRequiredParameters ( void )

public array ReflectionFunctionAbstract::getParameters ( void )

public ReflectionType ReflectionFunctionAbstract::getReturnType ( void )

public string ReflectionFunctionAbstract::getShortName ( void )

public int ReflectionFunctionAbstract::getStartLine ( void )

public array ReflectionFunctionAbstract::getStaticVariables ( void )

public bool ReflectionFunctionAbstract::hasReturnType ( void )

public bool ReflectionFunctionAbstract::inNamespace ( void )

public bool ReflectionFunctionAbstract::isClosure ( void )

public bool ReflectionFunctionAbstract::isDeprecated ( void )

public bool ReflectionFunctionAbstract::isGenerator ( void )

public bool ReflectionFunctionAbstract::isInternal ( void )

public bool ReflectionFunctionAbstract::isUserDefined ( void )

public bool ReflectionFunctionAbstract::isVariadic ( void )

public bool ReflectionFunctionAbstract::returnsReference ( void )

abstract public void ReflectionFunctionAbstract::__toString ( void )

}

Properties

name: Method name
class: Class name

Predefined Constants

ReflectionMethod Modifiers

ReflectionMethod::IS_STATIC: Indicates that the method is static.
ReflectionMethod::IS_PUBLIC: Indicates that the method is public.
ReflectionMethod::IS_PROTECTED: Indicates that the method is protected.
ReflectionMethod::IS_PRIVATE: Indicates that the method is private.
ReflectionMethod::IS_ABSTRACT: Indicates that the method is abstract.
ReflectionMethod::IS_FINAL: Indicates that the method is final.

Table of Contents

ReflectionMethod::__construct — Constructs a ReflectionMethod
ReflectionMethod::export — Export a reflection method.
ReflectionMethod::getClosure — Returns a dynamically created closure for the method
ReflectionMethod::getDeclaringClass — Gets declaring class for the reflected method.
ReflectionMethod::getModifiers — Gets the method modifiers
ReflectionMethod::getPrototype — Gets the method prototype (if there is one).
ReflectionMethod::invoke — Invoke
ReflectionMethod::invokeArgs — Invoke args
ReflectionMethod::isAbstract — Checks if method is abstract
ReflectionMethod::isConstructor — Checks if method is a constructor
ReflectionMethod::isDestructor — Checks if method is a destructor
ReflectionMethod::isFinal — Checks if method is final
ReflectionMethod::isPrivate — Checks if method is private
ReflectionMethod::isProtected — Checks if method is protected
ReflectionMethod::isPublic — Checks if method is public
ReflectionMethod::isStatic — Checks if method is static
ReflectionMethod::setAccessible — Set method accessibility
ReflectionMethod::__toString — Returns the string representation of the Reflection method object.

User Contributed Notes

webseiten dot designer at googlemail dot com

5 years ago


Note that the public member $class contains the name of the class in which the method has been defined:

<?php
class A {public function __construct() {}}
class B extends A {}

$method = new ReflectionMethod('B', '__construct');
echo $method->class; // prints 'A'
?>

no dot prob at gmx dot net

9 years ago


I have written a function which returns the value of a given DocComment tag.



Full example:



<?php



header('Content-Type: text/plain');



class Example

{

    /**

     * This is my DocComment!

     * 

     * @DocTag: prints Hello World!

     */

    public function myMethod()

    {

        echo 'Hello World!';

    }

}



function getDocComment($str, $tag = '')

{

    if (empty($tag))

    {

        return $str;

    }



    $matches = array();

    preg_match("/".$tag.":(.*)(\\r\\n|\\r|\\n)/U", $str, $matches);



    if (isset($matches[1]))

    {

        return trim($matches[1]);

    }



    return '';

}



$method = new ReflectionMethod('Example', 'myMethod');



// will return Hello World!

echo getDocComment($method->getDocComment(), '@DocTag');



?>



Maybe you can add this functionality to the getDocComment methods of the reflection classes.