CodeSniffer嗅探用于为PHP代码生成依赖图?

Pet*_*ter 5 php static-analysis codesniffer

目标: 我对在PHP 程序中生成类依赖项的DOT 格式描述感兴趣。

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

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
...
}
Run Code Online (Sandbox Code Playgroud)

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

注意: 我特别关心 PHP 的 include() 和 require() 语句(我不相信它们的行为甚至是明确定义的)。出于这个问题的目的,我们假设所有 PHP 类解析都是通过自动加载处理的,并且我们希望仅使用静态代码分析来构建类依赖关系图。

编辑: 不幸的是,我看不到处理以下问题的一般方法:

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

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

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

Gre*_*ood 2

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

我还没有遇到过任何嗅探器正在做你所描述的事情,所以我认为你必须写一个新的。

如果您想创建一个新的嗅探,我建议从抽象范围嗅探开始。这允许您在 T_CLASS 令牌内查找 T_NEW 和 T_DOUBLE_COLON 令牌。这是一个例子。

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

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