CodeSniffer嗅探为PHP代码生成依赖图?
作者:互联网
目标:
我有兴趣在PHP程序中生成类依赖关系的DOT Format描述.
理念:
在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(在相关注释中),它指示可能生成的每个类名 – 这些“记录的动态依赖”然后可以自动包含在依赖图中.
解决方法:
这不是PHP_CodeSniffer的设计目的;特别是因为嗅探不应该输出数据或写入文件.但是,肯定没有什么能阻止你在嗅闻中做这件事.毕竟它只是PHP代码,它不需要报告任何错误或警告.
我没有遇到任何像你描述的那样做的嗅闻,所以我认为你必须写一个新的.
如果你想创建一个新的嗅探器,我建议从一个抽象的范围嗅探开始.这允许您在T_CLASS标记内查找T_NEW和T_DOUBLE_COLON标记. Here is an example.
或者,如果您还想查看全局函数和类外的其他代码,您可以在常规嗅探中查找T_NEW和T_DOUBLE_COLON标记
如果你不确定如何开始或者你只是想要一些帮助来写嗅探,请联系我,我可以帮你写这个.我只需要知道你发现的每个案例你想要的输出,或者我可以使用一些基本的东西.如果你想要一只手,我的电子邮件是:gsherwood at squiz dot net
标签:php,static-analysis,codesniffer 来源: https://codeday.me/bug/20190629/1330657.html