在PHP_CodeSniffer中查找字符串规则

时间:2012-04-12 16:35:59

标签: php codesniffer

我希望扫描文件中的字符串Firebug,但这不是必须的。我也希望在QFirebug :: log和QFirebug :: error静态方法之间有所区别。

如何在类名后提取方法名称?

public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
{
    $tokens = $phpcsFile->getTokens();
    echo $tokens[$stackPtr]['content'];
    if ($tokens[$stackPtr]['content'] === 'Firebug') {
        $error = 'found ' . $tokens[$stackPtr]['content'];
        $data  = array(trim($tokens[$stackPtr]['content']));
        $phpcsFile->addError($error, $stackPtr, 'Found', $data);
    }

}//end process()

1 个答案:

答案 0 :(得分:4)

如果使用-vv命令行参数运行phpcs,则可以看到PHP文件被破坏的标记列表。对于像Firebug::error();这样的行,您会得到:

Process token 1 on line 2 [lvl:0;]: T_STRING => Firebug
Process token 2 on line 2 [lvl:0;]: T_DOUBLE_COLON => ::
Process token 3 on line 2 [lvl:0;]: T_STRING => error
Process token 4 on line 2 [lvl:0;]: T_OPEN_PARENTHESIS => (
Process token 5 on line 2 [lvl:0;]: T_CLOSE_PARENTHESIS => )
Process token 6 on line 2 [lvl:0;]: T_SEMICOLON => ;

您没有显示整个嗅探,但我认为您正在寻找T_STRING令牌。在这种情况下,一旦你确定$ stackPtr指向“Firebug”sting,只需确认它是静态调用然后获取下一个字符串标记:

if ($tokens[$stackPtr]['content'] === 'Firebug'
    && $tokens[($stackPtr + 1)]['code'] === T_DOUBLE_COLON
) {
    // This is a static call to a Firebug class method.
    $methodName = $tokens[($stackPtr + 2)]['content'];
    /* your error code here */
}

或者,如果您认为人们要在双冒号之间放置空格,例如Firebug :: error(),那么您可以执行以下操作:

if ($tokens[$stackPtr]['content'] === 'Firebug') {
    // Find the next non-whitespace token.
    $colon = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr + 1), null, true);
    if ($tokens[$colon]['code'] === T_DOUBLE_COLON) {
        // This is a static call to a Firebug class method.
        $methodName = $phpcsFile->findNext(T_STRING, ($colon + 1));
        /* your error code here */
    }
}

如果你想更进一步,你也可以查找T_OPEN_PARENTHESIS和T_CLOSE_PARENTHESIS标记,以确认它是一个函数调用,但它取决于你正在使用的类。

希望有所帮助。