PHP 8.1.0 RC 2 available for testing

ReflectionFunction クラス

(PHP 5, PHP 7, PHP 8)

はじめに

ReflectionFunction クラスは 関数についての情報を報告します。

クラス概要

class ReflectionFunction extends ReflectionFunctionAbstract implements Reflector {
/* 定数 */
const int IS_DEPRECATED = 262144;
/* プロパティ */
public $name;
/* メソッド */
public __construct(Closure|string $function)
public static export(string $name, string $return = ?): string
public invoke(mixed ...$args): mixed
public invokeArgs(array $args): mixed
public isDisabled(): bool
public __toString(): string
/* 継承したメソッド */
public ReflectionFunctionAbstract::getAttributes(string $name = null, int $flags = 0): array
}

プロパティ

name

関数名。読み込み専用で、書き込もうとすると ReflectionException をスローします。

定義済み定数

ReflectionFunction の修飾子

ReflectionFunction::IS_DEPRECATED

非推奨の関数であることを示します。

目次

add a note add a note

User Contributed Notes 2 notes

up
1
a dot lucassilvadeoliveira at gmail dot com
9 months 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
0
Lorenz R.S.
10 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