PHP Reflection API - Knowledge of Laravel

Was ist die PHP Reflection API?

Die PHP Reflection API ist eine eingebaute PHP-Funktionalität, um Metainformationen zu Klassen, Methoden, Properties, Funktionen und Parametern zur Laufzeit auszulesen und zu untersuchen. Sie können etwa herausfinden, welche Argumente ein Konstruktor erwartet oder welche Attribute an einer Methode hängen — ohne den Quellcode zu ändern. Laravel nutzt die Reflection API intern in Illuminate/Container/Container.php intensiv, um automatische Auflösung im DI-Container, das Auslesen von PHP-Attributen und Method-Injection zu realisieren.

Wichtige Klassen

Klasse	Wichtigster Einsatz
`ReflectionClass`	Einstiegspunkt für Metainformationen einer Klasse
`ReflectionMethod`	Argumente, Zugriffsmodifikatoren und Attribute einer Methode
`ReflectionProperty`	Typen, Standardwerte und Attribute einer Property
`ReflectionParameter`	Argumentinformationen (Type-Hint, Standardwert) einer Methode/Funktion
`ReflectionFunction`	Metainformationen einer Funktion/Closure
`ReflectionAttribute`	Klassenname und Argumente eines Attributs

ReflectionClass — Klasseninformationen ermitteln

$ref = new ReflectionClass(UserController::class);

$ref->getName();          // Voll qualifizierter Klassenname
$ref->getShortName();     // Nur Klassenname
$ref->isInstantiable();   // Ist die Klasse instanziierbar?
$ref->getConstructor();   // Konstruktor als ReflectionMethod
$ref->getMethods();       // Alle Methoden als ReflectionMethod[]
$ref->getProperties();    // Alle Properties als ReflectionProperty[]
$ref->getAttributes();    // Attribute der Klasse als ReflectionAttribute[]

ReflectionParameter — Konstruktor-Argumente untersuchen

$ref = new ReflectionClass(UserController::class);
$constructor = $ref->getConstructor();

if ($constructor) {
    foreach ($constructor->getParameters() as $param) {
        $param->getName();           // Argumentname
        $param->getType();           // Type-Hint (ReflectionType)
        $param->isOptional();        // Ist das Argument optional?
        $param->isVariadic();        // Variadic?
        $param->getDefaultValue();   // Standardwert (falls vorhanden)
    }
}

Der Laravel-Container und die Reflection API

Der IoC-Container von Laravel implementiert Konstruktor-Injection (automatische Auflösung von Abhängigkeiten) über die Reflection API. So funktioniert app()->make(SomeClass::class) und die Dependency Injection.

Die `build()`-Methode des Containers (vereinfacht)

Die tatsächliche build()-Methode in Container.php sieht in etwa so aus:

// Vereinfachte Illuminate\Container\Container::build()
public function build($concrete)
{
    // 1. Klasse mit ReflectionClass inspizieren
    $reflector = new ReflectionClass($concrete);

    // Nicht instanziierbare Klassen (Interface, Abstract usw.) → Fehler
    if (! $reflector->isInstantiable()) {
        throw new BindingResolutionException("[$concrete] is not instantiable.");
    }

    // 2. Konstruktor ermitteln
    $constructor = $reflector->getConstructor();

    // Kein Konstruktor → direkt instanziieren
    if (is_null($constructor)) {
        return new $concrete;
    }

    // 3. Alle Konstruktorparameter ermitteln
    $dependencies = $constructor->getParameters();

    // 4. Jedes Argument rekursiv auflösen
    $instances = $this->resolveDependencies($dependencies);

    return new $concrete(...$instances);
}

protected function resolveDependencies(array $dependencies): array
{
    $results = [];

    foreach ($dependencies as $dependency) {
        // Bei vorhandenem Type-Hint rekursiv über Container auflösen
        $className = Util::getParameterClassName($dependency);

        $results[] = is_null($className)
            ? $this->resolvePrimitive($dependency)  // Primitivtyp
            : $this->resolveClass($dependency, $className); // Klassentyp
    }

    return $results;
}

Util::getParameterClassName() extrahiert den Typnamen aus dem Ergebnis von $parameter->getType(). Es umhüllt den von ReflectionParameter::getType() gelieferten ReflectionNamedType bequemer.

PHP-Attribute auslesen

Ab PHP 8.0 lassen sich Attribute an Klassen, Methoden und Properties über die Reflection API auslesen. Laravel verarbeitet damit Queue- und Eloquent-Attribute.

Für den Einsatz von PHP-Attributen in Laravel siehe auch PHP-Attribute.

Grundmuster zum Auslesen von Attributen

use ReflectionClass;

// 1. Attribute einer Klasse holen
$ref = new ReflectionClass(ProcessOrder::class);
$attrs = $ref->getAttributes(Queue::class); // Nur bestimmte Attribute holen

foreach ($attrs as $attr) {
    $instance = $attr->newInstance(); // Attributklasse instanziieren
    echo $instance->queue;            // Property des Attributs lesen
}

// 2. Alle Attribute holen (ohne Filter)
$allAttrs = $ref->getAttributes();

foreach ($allAttrs as $attr) {
    echo $attr->getName();       // Attributklassenname (FQCN)
    print_r($attr->getArguments()); // Konstruktor-Argumente
}

Wie Laravel Queue-Attribute liest (vereinfacht)

// Vereinfachtes ReadsQueueAttributes aus InteractsWithQueue
protected function setJobInstanceForQueue(object $job): void
{
    $reflection = new ReflectionClass($job);

    foreach ($reflection->getAttributes(Queue::class) as $attribute) {
        $instance = $attribute->newInstance();
        $job->queue = $instance->queue instanceof \UnitEnum
            ? $instance->queue->value
            : $instance->queue;
    }
}

Method-Attribute auslesen

$ref = new ReflectionClass(UserController::class);

foreach ($ref->getMethods() as $method) {
    $attrs = $method->getAttributes(Route::class);

    foreach ($attrs as $attr) {
        $route = $attr->newInstance();
        echo "{$method->getName()} => {$route->path}";
    }
}

Anwendungsbeispiele in der Paketentwicklung

Prüfen, welche Interfaces eine Klasse implementiert

In einem Paket können Sie dynamisch feststellen, ob eine Klasse ein bestimmtes Interface implementiert.

use ReflectionClass;

function isQueueable(string $class): bool
{
    $ref = new ReflectionClass($class);

    return $ref->implementsInterface(\Illuminate\Contracts\Queue\ShouldQueue::class);
}

Metadaten sammeln — Routen automatisch per Attribut registrieren

Ein Muster, in dem Attribute und Reflection kombiniert werden, um Routen automatisch einzusammeln.

// Eigenes Route-Attribut
#[\Attribute(\Attribute::TARGET_METHOD)]
class Route
{
    public function __construct(
        public string $method,
        public string $path,
    ) {}
}

// Verwendung im Controller
class UserController
{
    #[Route('GET', '/users')]
    public function index() { /* ... */ }

    #[Route('POST', '/users')]
    public function store() { /* ... */ }
}

// Service Provider, der Routen automatisch aus Attributen registriert
class AttributeRouteServiceProvider extends ServiceProvider
{
    public function boot(Router $router): void
    {
        $ref = new ReflectionClass(UserController::class);

        foreach ($ref->getMethods(\ReflectionMethod::IS_PUBLIC) as $method) {
            foreach ($method->getAttributes(Route::class) as $attr) {
                $route = $attr->newInstance();
                $router->addRoute(
                    $route->method,
                    $route->path,
                    [UserController::class, $method->getName()],
                );
            }
        }
    }
}

Dynamische Methodenaufrufe — Method-Injection

Laravels call()-Methode löst Argumente per Reflection auf. So lässt sich derselbe Mechanismus in einem Paket bauen.

use ReflectionFunction;
use ReflectionMethod;

function callWithDependencies(callable $callable, Container $container): mixed
{
    if (is_array($callable)) {
        [$object, $method] = $callable;
        $ref = new ReflectionMethod($object, $method);
        $params = $ref->getParameters();
    } else {
        $ref = new ReflectionFunction($callable);
        $params = $ref->getParameters();
    }

    $args = [];
    foreach ($params as $param) {
        $type = $param->getType()?->getName();
        $args[] = $type ? $container->make($type) : null;
    }

    return $callable(...$args);
}

// Anwendungsbeispiel
callWithDependencies([new UserController(), 'index'], app());

Standardwerte von Properties einsammeln

Muster, um Defaults aus einer Config-Klasse per Reflection zu extrahieren.

use ReflectionClass;
use ReflectionProperty;

function getDefaults(string $class): array
{
    $ref = new ReflectionClass($class);
    $defaults = [];

    foreach ($ref->getProperties(ReflectionProperty::IS_PUBLIC) as $prop) {
        if ($prop->hasDefaultValue()) {
            $defaults[$prop->getName()] = $prop->getDefaultValue();
        }
    }

    return $defaults;
}

class DatabaseConfig
{
    public string $driver = 'mysql';
    public int $port = 3306;
    public bool $strict = true;
}

// ['driver' => 'mysql', 'port' => 3306, 'strict' => true]
$defaults = getDefaults(DatabaseConfig::class);

Performance-Überlegungen

Die Reflection API parst Klasseninformationen jedes Mal neu, was Kosten verursacht. In Produktionscode empfiehlt es sich, Ergebnisse zu cachen.

class ReflectionCache
{
    private static array $cache = [];

    public static function getClass(string $class): \ReflectionClass
    {
        return self::$cache[$class] ??= new \ReflectionClass($class);
    }
}

// Anwendungsbeispiel
$ref = ReflectionCache::getClass(UserController::class);

PHP OPcache cacht keine Reflection-Ergebnisse. Wenn Sie viele Klassen in einer Schleife untersuchen, sollten Sie eigenes Caching einbauen. Der Laravel-Container selbst wiederverwendet innerhalb desselben Requests bereits ReflectionClass-Instanzen.

​Was ist die PHP Reflection API?

​Wichtige Klassen

​ReflectionClass — Klasseninformationen ermitteln

​ReflectionParameter — Konstruktor-Argumente untersuchen

​Der Laravel-Container und die Reflection API

​Die build()-Methode des Containers (vereinfacht)

​PHP-Attribute auslesen

​Grundmuster zum Auslesen von Attributen

​Wie Laravel Queue-Attribute liest (vereinfacht)

​Method-Attribute auslesen

​Anwendungsbeispiele in der Paketentwicklung

​Prüfen, welche Interfaces eine Klasse implementiert

​Metadaten sammeln — Routen automatisch per Attribut registrieren

​Dynamische Methodenaufrufe — Method-Injection

​Standardwerte von Properties einsammeln

​Performance-Überlegungen

​Nächste Schritte

PHP-Attribute

Paketentwicklung

Was ist die PHP Reflection API?

Wichtige Klassen

ReflectionClass — Klasseninformationen ermitteln

ReflectionParameter — Konstruktor-Argumente untersuchen

Der Laravel-Container und die Reflection API

Die `build()`-Methode des Containers (vereinfacht)

PHP-Attribute auslesen

Grundmuster zum Auslesen von Attributen

Wie Laravel Queue-Attribute liest (vereinfacht)

Method-Attribute auslesen

Anwendungsbeispiele in der Paketentwicklung

Prüfen, welche Interfaces eine Klasse implementiert

Metadaten sammeln — Routen automatisch per Attribut registrieren

Dynamische Methodenaufrufe — Method-Injection

Standardwerte von Properties einsammeln

Performance-Überlegungen

Nächste Schritte