PHP 8.4.0 RC4 available for testing

    Clase ReflectionFunction

    (PHP 5, PHP 7, PHP 8)

    Introducción

    La ReflectionFunction muestra información sobre una función.

    Sinopsis de la Clase

    class ReflectionFunction extends ReflectionFunctionAbstract implements Reflector {
    /* Constantes */
    const integer IS_DEPRECATED = 262144;
    /* Propiedades */
    public $name;
    /* Métodos */
    public __construct(mixed $name)
    public static export(string $name, string $return = ?): string
    public getClosure(): Closure
    public invoke(mixed $... = ?): mixed
    public invokeArgs(array $args): mixed
    public isAnonymous(): bool
    public isDisabled(): bool
    public __toString(): string
    /* Métodos heredados */
    final private ReflectionFunctionAbstract::__clone(): void
    public ReflectionFunctionAbstract::getAttributes(?string $name = null, int $flags = 0): array
    public ReflectionFunctionAbstract::getClosureCalledClass(): ?ReflectionClass
    public ReflectionFunctionAbstract::getClosureScopeClass(): ReflectionClass
    public ReflectionFunctionAbstract::getClosureThis(): object
    public ReflectionFunctionAbstract::getClosureUsedVariables(): array
    public ReflectionFunctionAbstract::getDocComment(): string
    public ReflectionFunctionAbstract::getEndLine(): int
    public ReflectionFunctionAbstract::getExtension(): ReflectionExtension
    public ReflectionFunctionAbstract::getExtensionName(): string
    public ReflectionFunctionAbstract::getFileName(): string
    public ReflectionFunctionAbstract::getName(): string
    public ReflectionFunctionAbstract::getNamespaceName(): string
    public ReflectionFunctionAbstract::getNumberOfParameters(): int
    public ReflectionFunctionAbstract::getNumberOfRequiredParameters(): int
    public ReflectionFunctionAbstract::getParameters(): array
    public ReflectionFunctionAbstract::getReturnType(): ?ReflectionType
    public ReflectionFunctionAbstract::getShortName(): string
    public ReflectionFunctionAbstract::getStartLine(): int
    public ReflectionFunctionAbstract::getStaticVariables(): array
    public ReflectionFunctionAbstract::getTentativeReturnType(): ?ReflectionType
    public ReflectionFunctionAbstract::hasReturnType(): bool
    public ReflectionFunctionAbstract::hasTentativeReturnType(): bool
    public ReflectionFunctionAbstract::inNamespace(): bool
    public ReflectionFunctionAbstract::isClosure(): bool
    public ReflectionFunctionAbstract::isDeprecated(): bool
    public ReflectionFunctionAbstract::isGenerator(): bool
    public ReflectionFunctionAbstract::isInternal(): bool
    public ReflectionFunctionAbstract::isStatic(): bool
    public ReflectionFunctionAbstract::isUserDefined(): bool
    public ReflectionFunctionAbstract::isVariadic(): bool
    public ReflectionFunctionAbstract::returnsReference(): bool
    abstract public ReflectionFunctionAbstract::__toString(): void
    }

    Propiedades

    name

    Nombre de la función. De sólo lectura, lanza una ReflectionException en el intento de escribir.

    Constantes predefinidas

    Modificadores ReflectionFunction

    ReflectionFunction::IS_DEPRECATED

    Indica las funciones obsoletas.

    Tabla de contenidos

    Improve This Page

    Learn How To Improve This Page • Submit a Pull Request • Report a Bug
    ＋add a note

    User Contributed Notes 2 notes

    up
    7
    a dot lucassilvadeoliveira at gmail dot com
    3 years ago
    We can use this functionality to automatically pass arguments to our function based on some data structure.

    NOTE: I am using a php 8.0> feature called "Nameds parameter"

    <?php

    $valuesToProcess     = [
    'name' => 'Anderson Lucas Silva de Oliveira',
    'age' => 21,
    'hobbie' => 'Play games'
    ];

    function     processUserData($name, $age, $job = "", $hobbie = "")
    {
    $msg = "Hello $name. You have $age years old";
    if (!empty(    $job)) {
    $msg .= ". Your job is $job";
    }

    if (!empty(    $hobbie)) {
    $msg .= ". Your hobbie is $hobbie";
    }

    echo     $msg . ".";
    }

    $refFunction = new ReflectionFunction('processUserData');
    $parameters = $refFunction->getParameters();

    $validParameters = [];
    foreach (    $parameters as $parameter) {
    if (!    array_key_exists($parameter->getName(), $valuesToProcess) && !$parameter->isOptional()) {
    throw new     DomainException('Cannot resolve the parameter' . $parameter->getName());
    }

    if(!    array_key_exists($parameter->getName(), $valuesToProcess)) {
    continue;
    }

    $validParameters[$parameter->getName()] = $valuesToProcess[$parameter->getName()];
    }

    $refFunction->invoke(...$validParameters);
    ?>

    Results in:

    Hello Anderson Lucas Silva de Oliveira. You have 21 years old. Your hobbie is Play games.
    up
    -2
    Lorenz R.S.
    13 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 ]
    ＋add a note
    To Top