SuperAPI AI 工具集

craft-php-guidelines

编程与开发

查看项目

更新于 10-16 00:30

技能介绍

用途:为 Craft CMS 5 插件与模块开发提供完整 PHP 编码规范,在编写、编辑、审查或讨论 Craft 插件/模块中的任何 PHP 代码时使用。

主要能力:规定 PHPDoc 覆盖类、方法、属性;@throws 链需记录被调用方法抛出的异常;@author 与 @since 置于类/方法文档块底部;类内使用 ===== 分节标题;私有成员加下划线前缀;插件源码不使用 declare(strict_types=1);使用 ?string 而非 string|null;始终使用严格比较与强制类型转换;控制流采用早返回、避免 else、优先 match;元素与查询用 DateTimeHelper,服务用 Carbon,二者不混用;解析数据库原始时间需显式指定 UTC;环境变量用 App::env() 而非 getenv();数据库使用 [[column]] 引用、beforePrepare() 中 addSelect()、外键显式 CASCADE/SET NULL;权限句柄用 kebab-case,常量用 SCREAMING_SNAKE_CASE;命名约定涵盖服务、队列任务、记录、事件、元素动作、枚举;面向用户文案禁用长破折号;控制台控制器文档块会原样渲染为帮助文本。

使用方式:按任务读取对应参考文件(phpdoc-standards、class-organization、naming-conventions、templates-and-patterns、tooling、authorization-parity)。使用 ddev craft make <type> --with-docblocks 脚手架,提交前运行 ddev composer check-cs 与 ddev composer phpstan 并通过测试。常与 craftcms、ddev 技能一同加载。

适用场景:Craft CMS 5 插件与模块的 PHP 开发、代码审查与规范统一。

限制:最低 PHP 8.2;部分规则为项目内部约定,与 Craft 核心风格不同;具体配置与版本细节以官方文档为准。