如何使用PHPCS强制指定目录下的类继承特定父类？

当然可以实现！这正是PHPCS自定义规则的拿手场景——咱们可以编写一个自定义嗅探（Sniff），精准管控src/Controller/CP目录下所有类的继承关系，完全符合你提到的需求：继承AbstractController就报错，继承AbstractCPController则合规。

步骤1：编写自定义嗅探类 #

首先创建一个嗅探类，让它监听类定义的令牌，然后判断目标目录下的类是否继承了正确的父类。

<?php
namespace YourProject\Sniffs\Classes;

use PHP_CodeSniffer\Files\File;
use PHP_CodeSniffer\Sniffs\Sniff;

class CPControllerParentSniff implements Sniff
{
    /**
     * 注册要监听的PHP令牌（这里监听类定义）
     */
    public function register()
    {
        return [T_CLASS];
    }

    /**
     * 处理每个匹配到的令牌
     */
    public function process(File $phpcsFile, $stackPtr)
    {
        // 先判断当前文件是否在目标目录下，非目标目录直接跳过
        $filePath = $phpcsFile->getFilename();
        if (strpos($filePath, 'src/Controller/CP/') === false) {
            return;
        }

        $tokens = $phpcsFile->getTokens();
        // 查找类的extends关键字位置
        $extendsPtr = $phpcsFile->findNext(T_EXTENDS, $stackPtr, $tokens[$stackPtr]['scope_opener']);
        
        // 如果类没有继承任何父类，直接抛出错误
        if ($extendsPtr === false) {
            $error = 'CP目录下的控制器类必须继承 AbstractCPController';
            $phpcsFile->addError($error, $stackPtr, 'NoParent');
            return;
        }

        // 获取父类的名称
        $parentClassPtr = $phpcsFile->findNext(T_STRING, $extendsPtr + 1, $tokens[$stackPtr]['scope_opener']);
        $parentClassName = $tokens[$parentClassPtr]['content'];

        // 检查父类是否是指定的AbstractCPController，不是则报错
        if ($parentClassName !== 'AbstractCPController') {
            $error = 'CP目录下的控制器类必须继承 AbstractCPController，当前继承的是 %s';
            $data = [$parentClassName];
            $phpcsFile->addError($error, $parentClassPtr, 'WrongParent', $data);
        }
    }
}

步骤2：配置PHPCS加载自定义嗅探 #

接下来需要在项目的phpcs.xml（或phpcs.xml.dist）配置文件中，告诉PHPCS加载咱们的自定义嗅探：

<?xml version="1.0"?>
<ruleset name="YourProject">
    <!-- 指定自定义嗅探所在的根目录 -->
    <rule src="./path/to/your/sniffs/directory"/>
    
    <!-- 启用刚才创建的CP控制器父类检查规则 -->
    <rule ref="YourProject.Classes.CPControllerParent"/>
    
    <!-- 这里可以添加其他你需要的PHPCS规则... -->
</ruleset>

步骤3：测试验证 #

现在运行PHPCS检查src/Controller/CP目录下的文件：

• 当类继承AbstractController时，会收到错误提示：CP目录下的控制器类必须继承 AbstractCPController，当前继承的是 AbstractController
• 当类继承AbstractCPController时，检查会顺利通过

额外注意事项 #

• 如果AbstractCPController带有命名空间（比如\App\Controller\AbstractCPController），记得在嗅探类里对比完整的带命名空间的类名
• 可以根据需求调整错误级别：如果只是想提醒而不是强制阻断，把addError换成addWarning即可
• 确保PHPCS能正确找到自定义嗅探的路径，比如把嗅探放在项目的phpcs/Sniffs/Classes目录下，配置里的src就设为./phpcs/

内容的提问来源于stack exchange，提问作者michnovka