PHP 7.0.6 Released

    The ReflectionFunction class

    (PHP 5, PHP 7)

    Introduction

    The ReflectionFunction class reports information about a function.

    Class synopsis

    ReflectionFunction extends ReflectionFunctionAbstract implements Reflector {
    /* Constants */
    const integer IS_DEPRECATED = 262144 ;
    /* Properties */
    public $name ;
    /* Methods */
    public __construct ( mixed $name )
    public static string export ( string $name [, string $return ] )
    public Closure getClosure ( void )
    public mixed invoke ([ mixed $parameter [, mixed $... ]] )
    public mixed invokeArgs ( array $args )
    public bool isDisabled ( void )
    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

    Name of the function. Read-only, throws ReflectionException in attempt to write.

    Predefined Constants

    ReflectionFunction Modifiers

    ReflectionFunction::IS_DEPRECATED

    Indicates deprecated functions.

    Table of Contents

    User Contributed Notes

    Lorenz R.S.
    4 years ago
    Here is a concise example of ReflectionFunction usage for Parameter Reflection / introspection (e.g. to automatically generate API descriptions)

    <?php
    $properties     = $reflector->getProperties();
    $refFunc = new ReflectionFunction('preg_replace');
    foreach(     $refFunc->getParameters() as $param ){
            //invokes ■ReflectionParameter::__toString
            print $param;
    }
    ?>

    prints:

    Parameter #0 [ <required> $regex ]
    Parameter #1 [ <required> $replace ]
    Parameter #2 [ <required> $subject ]
    Parameter #3 [ <optional> $limit ]
    Parameter #4 [ <optional> &$count ]
    To Top