README

Reflection utilities for PHP 8.4+.

Installation

composer require componenta/reflection:^2.0

Reflection

use Componenta\Reflection\Reflection;

$class = Reflection::class(App\Service\UserService::class);
$object = Reflection::object($service);
$closure = Reflection::callable(static fn (): string => 'ok');
$method = Reflection::callable([App\Service\UserService::class, 'handle']);

Reflection::class() supports classes, interfaces, traits and enums and returns null when the symbol does not exist.

Reflection::callable() supports functions, closures, concrete methods and invokable objects. Callables resolved only through __call() or __callStatic() are rejected because they have no concrete method signature to reflect.

Reflection::reflect() accepts mixed input and returns the corresponding native reflector or null when the value cannot be reflected reliably.

Attributes

$class = Reflection::class(App\Command\CreatePostCommand::class);

$attributes = Reflection::getMetadata($class, PermissionPolicy::class);
$first = Reflection::getFirstMetadata($class, PermissionPolicy::class);
$has = Reflection::hasMetadata($class, PermissionPolicy::class);

Attribute definitions are cached, while attribute instances are created fresh for each read. hasMetadata() does not instantiate attributes.

Supported reflectors include functions, methods, classes, parameters, properties, class constants and global constants. Global constant attributes are available on PHP 8.5+.

Deep lookup

$attributes = Reflection::getDeepMetadata($class, SomeAttribute::class);

Deep lookup includes the class, methods, properties, property hooks and class constants. Paths are unambiguous:

App\Command\CreatePostCommand
App\Command\CreatePostCommand::handle()
App\Command\CreatePostCommand::$title
App\Command\CreatePostCommand::$title::get()
App\Command\CreatePostCommand::STATUS

Use getFirstDeepMetadata() for the first matching attribute and hasDeepMetadata() for an existence check without instantiating attributes.

Reflection types

use Componenta\Reflection\ReflectionType;

$type = (new ReflectionParameter($callable, 'value'))->getType();

ReflectionType::match($type, $value);
ReflectionType::contains($type, SomeInterface::class);
ReflectionType::getTypeNames($type);

ReflectionType supports named, union, intersection and DNF types.

getTypeNames(null) returns []. Nullable named types are normalized semantically, so ?int produces ['int', 'null'].

When native Reflection exposes self, parent or static, pass the declaring or effective class as scope:

ReflectionType::match($type, $value, scope: $declaringClass);
ReflectionType::getTypeNames($type, scope: $declaringClass);

For relative types declared in a trait, use the consuming class as the scope.

ReflectionType::toString() returns PHP's native string representation of the reflected type.

Coercion

if (ReflectionType::canCoerce($type, $value)) {
    $value = ReflectionType::coerce($type, $value);
}

Coercion is limited to reflected PHP types. Union coercion succeeds only when the value already matches a branch or exactly one branch is coercible; ambiguous conversions are rejected.

Arrays can be produced from arrays, iterables and Componenta\Arrayable\Arrayable values. Scalars are not wrapped into one-element arrays.

Cache management

Reflection::clearReflectors();

Class, function and method reflectors are cached strongly. Object and closure reflectors use WeakMap and do not extend application object lifetime.

Development

composer check

Tests use Pest 4. Static analysis runs with PHPStan at maximum level. CI covers PHP 8.4 and PHP 8.5.

componenta / reflection

Maintainers

Package info

Statistics

Security