php - CodeSniffer 嗅探用于为 PHP 代码生成依赖关系图？

Question

目标: 我有兴趣生成 DOT Format PHP 程序中类依赖关系的描述。

想法: 在 PHP 源代码中编写可以检测(并发出 DOT 记录)以下模式的 CodeSniffer“嗅探”应该不难:

class SomeClassName extends BasicClassName {  // SomeClassName refers to BasicClassName
...
    new OtherClassName();            // SomeClassName refers to OtherClassName
    ThisClassName::some_method();    // SomeClassName refers to ThisClassName
    ThatClassName::$some_member;     // SomeClassName refers to ThatClassName
    RandomClassName::some_constant;  // SomeClassName refers to RandomClassName
...
}

但我还没有发现任何已发布的嗅探来发出此信息(以及任何其他表明我可能错过的“真实”类依赖关系的模式)。

注意: 我特别不关心 PHP 的 include() 和 require() 语句 ( whose behavior I'm not convinced is even well-defined )。出于这个问题的目的，我们假设所有 PHP 类解析都是通过 autoloading 处理的。 ，并且我们希望仅使用静态代码分析来构建类依赖关系图。

编辑: 不幸的是，我看不到处理以下问题的通用方法:

class ThatClassName {
...
    function generateClassName() {
        // something too complicated to analyze statically...
    }

    function foo() {
        $name = $this->generateClassName();
        $instance = new $name; // ThatClassName refers to ... what?
        ...
    }
...
}

但是当然可以通过显示依赖于 generateClassName() 方法的 ThatClassName 在依赖关系图中表示这种情况 - 可能用括号显示以使方法名称易于与类名称区分开来。建立一个约定，任何动态生成类名的方法都必须包含一个 annotation 可能不是一个坏主意。 (在关联的注释中)指示可能生成的每个类名 - 这些“记录的动态依赖项”然后可以自动包含在依赖关系图中。

Answer 1

这并不是 PHP_CodeSniffer 真正设计的目的；特别是因为嗅探不应该输出数据或写入文件。但是，肯定没有什么能阻止你在嗅探中这样做。毕竟它只是 PHP 代码，不需要报告任何错误或警告。

我还没有遇到任何像你描述的那样做任何事情的嗅探器，所以我认为你必须写一个新的。

如果您想创建一个新的嗅探器，我建议您从一个抽象范围嗅探器开始。这允许您在 T_CLASS token 中查找 T_NEW 和 T_DOUBLE_COLON token 。 Here is an example.

或者，如果您还想查看全局函数和类外的其他代码，您可以在常规嗅探中查找 T_NEW 和 T_DOUBLE_COLON 标记

如果您不确定如何开始，或者您只是需要一些帮助来编写嗅探器，请联系我，我可以帮助您编写此代码。我只需要知道找到的每个案例你想要什么输出，或者我可以只使用一些基本的东西。如果你需要帮助，我的电子邮件是:gsherwood at squiz dot net