goaop/parser-reflection

提供基于原始源代码的反射信息

资助包维护!
lisachenko

4.0.0-RC2 2024-03-18 21:43 UTC

README

此库已废弃。请使用 BetterReflection

解析反射API库提供了一组类,这些类扩展了原始内部反射类,但由 PHP-Parser 库提供支持,从而允许在不将类加载到内存中时创建反射实例。

此库可用于分析源代码;用于自动代理创建等。

Build Status Code Coverage Total Downloads Daily Downloads Scrutinizer Code Quality PHP Version License

安装

可以使用Composer安装库。安装非常简单

$ composer require goaop/parser-reflection

Composer会将库安装到您的项目目录 vendor/goaop/parser-reflection

用法

初始化

在首次使用库之前,可以可选地初始化。如果您使用Composer安装包和加载类,那么您不需要担心初始化,库将自动初始化。

如果项目使用自定义自动加载器,则应遵循以下步骤

  1. 创建一个实现 \Go\ParserReflection\LocatorInterface 的新类
  2. 创建该类的实例,并将其传递给 ReflectionEngine::init() 方法进行初始配置

不加载类即可反射具体类/方法/属性

只需像传统类一样使用 Go\ParserReflection 包的反射类即可

$parsedClass = new \Go\ParserReflection\ReflectionClass(SomeClass::class);
var_dump($parsedClass->getMethods());

$parsedMethod = new \Go\ParserReflection\ReflectionMethod(SomeClass::class, 'someMethod');
echo (string)$parsedMethod;

或者,您可以使用额外的类 ReflectionFileReflectionFileNamespace 来分析原始PHP文件

$parsedFile     = new \Go\ParserReflection\ReflectionFile('SomeClass.php');
$fileNameSpaces = $parsedFile->getFileNamespaces();
// We can iterate over namespaces in the file
foreach ($fileNameSpaces as $namespace) {
    $classes = $namespace->getClasses();
    // Iterate over the classes in the namespace
    foreach ($classes as $class) {
        echo "Found class: ", $class->getName(), PHP_EOL;
        // Now let's show all methods in the class
        foreach ($class->getMethods() as $method) {
            echo "Found class method: ", $class->getName(), '::', $method->getName(), PHP_EOL;
        }
        
        // ...all properties in the class
        foreach ($class->getProperties() as $property) {
            echo "Found class property: ", $class->getName(), '->', $property->getName(), PHP_EOL;
        }
    }
}

它是如何工作的?

为了了解库的工作原理,让我们看看在调用 new \Go\ParserReflection\ReflectionClass(SomeClass::class) 时会发生什么

  • \Go\ParserReflection\ReflectionClass 要求反射引擎为给定的类名提供AST节点
  • 反射引擎要求定位器查找给定类的文件名
  • ComposerLocator 实例要求Composer查找给定类的文件名,并将此结果返回给反射引擎
  • 反射引擎加载文件内容,并将其传递给 PHP-Parser 进行标记化和处理
  • PHP-Parser返回一个AST(抽象语法树)
  • 然后反射引擎分析此AST以提取特定节点,并将它们包装成相应的反射类。

兼容性

所有解析反射类都扩展了PHP内部反射类,这意味着您可以在任何请求\ReflectionClass实例的地方使用\Go\ParserReflection\ReflectionClass实例。所有反射方法都应该与原始方法兼容,提供不涉及对象操作的方法,例如invoke()invokeArgs()setAccessible()等。这些方法将触发类加载过程并切换到内部反射。