Question

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

IDEA： 在PHP源代码中编写可以检测（并发出DOT记录）以下模式的CodeSniffer“sniff”应该不难：

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来在依赖图中表示这种情况 - 可能与parens一起显示以使方法名称可以容易地与类名区分开。并且建立一个约定可能不是一个坏主意，其中任何动态生成类名的方法必须包含annotation（在关联的注释中），它指示可能生成的每个类名 - 这些“记录的动态依赖关系“然后可以自动包含在依赖关系图中。

Answer 1

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

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

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

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

如果您不确定如何开始或者您只是想要一些帮助来写嗅探，请与我联系，我可以帮您写一下。我只需要知道你发现的每个案例你想要的输出，或者我可以使用一些基本的东西。如果您想要一只手，我的电子邮件是：gsherwood at squiz dot net

Answer 2

我为此写了一个工具：PhpDependencyAnalysis。

这是基于命名空间的面向对象的PHP项目（＆gt; = 5.3.3）的可扩展静态代码分析。它在可自定义的级别上创建依赖图，例如在包级别或类级别上。因此，它通常可用于声明依赖性，但它也可用于根据符合分离关注度，Demeter法和非循环依赖性原则来执行分层体系结构中层之间的违规检测。您也可以将输出格式更改为DOT。

只需查看PhpDependencyAnalysis on GitHub。

CodeSniffer嗅探为PHP代码生成依赖图？

2 个答案: