phpactor/worse-reflection

Lazy AST reflector that is much worse than better

0.6.0 2024-08-09 07:17 UTC

Requires

• php: ^8.1
• amphp/amp: ^2.6
• jetbrains/phpstorm-stubs: *
• phpactor/docblock-parser: ^0.2.0
• phpactor/text-document: ^2.1.0
• phpactor/tolerant-php-parser: dev-main
• psr/log: ^1.0||^2.0||^3.0

Requires (Dev)

• ergebnis/composer-normalize: ^2.0
• friendsofphp/php-cs-fixer: ^3.0
• phpactor/class-to-file: ~0.5.0
• phpactor/test-utils: ^1.1.5
• phpbench/phpbench: dev-master
• phpspec/prophecy-phpunit: ^2.0
• phpstan/phpstan: ^1.0
• phpunit/phpunit: ^9.0
• symfony/filesystem: ^6.0
• symfony/var-dumper: ^5.2

MIT

• Daniel Leech

README

This package is not actively developed here but in the main phpactor repository. It is occasionally updated. Raise any issues about this repository there.

This library aims to provide a light class-based AST based "reflection" library.

Worse than Better

It is influenced by BetterReflection, diffrerences are as follows:

• Can reflect variables.
• Does not aim to implement built-in PHP reflection API.
• Uses the amazing Tolerant Parser.
• Uses the PHPStorm stubs to provide reflections of internal classes.

It is being developed to provide support for the Phpactor introspection and refactoring tool. And is therefore driven by that use case.

If you want comprehsnsive reflection, use BetterReflection. If you want faster reflection including type/value flow with no support and frequent BC breaks, then you can use this one (note that I havn't benchmarked BR in sometime, it may well be faster now).

Usage

$reflector = ReflectorBuilder::create()
    ->addSource('<?php ...')
    ->build();

$class = $reflector->reflectClass('Foobar');

$class->methods()->get('foobar')->visiblity()    == Visibility::public();
$class->properties()->get('barbar')->visiblity() == Visibility::public();

/** @var ReflectionMethod */
foreach ($class->methods() as $method) {
    echo $method->name();                                  // methodName
    echo $method->returnType()->short();                   // Foobar
    echo (string) $method->returnType();                   // This\Is\Foobar
    echo (string) $method->inferredReturnTypes()->best(); // from docblock if it exists

    foreach ($method->parameters() as $parameter) {
        $parameter->name();                      // paramName
        (string) $parameter->inferredType();     // Fully\Qualified\ParamType
    }

}

foreach ($class->traits() as $trait) {
    // ...
}

foreach ($class->interfaes() as $interface) {
    // ...
}

foreach ($class->method('foobar')->frame()->locals() as $variable) {
    $variable->offset()->toInt(); // byte offset
    $variable->type();            // variable type (if available )
    $variable->value();           // variable value (if available)
}

$offset = $reflection->reflectOffset(
    SourceCode::fromString('...'), 
    Offset::fromInt(1234)
);

$offset->value()->type();    // type at offset (if available)
$offset->value()->value();   // value (e.g. 1234)
$offset->frame();            // return frame

See tests for more examples...

Contributing

This package is open source and welcomes contributions! Feel free to open a pull request on this repository.

Support

• Create an issue on the main Phpactor repository.
• Join the #phpactor channel on the Slack Symfony Devs channel.