SuperAPI AI 工具集

php-project-guide

编程与开发

查看项目

更新于 10-16 09:10

技能介绍

PHP Project Guide 是为 AI 智能体提供的基础知识技能,目标是在 PhpStorm 中高效处理任意 PHP 项目。内容涵盖项目检测、编码规范、测试模式、框架指引以及 MCP 工具使用。

用途 该技能用于在首次接触一个新的 PHP 项目时,帮助 AI 智能体先了解项目环境与依赖结构,再据此生成符合项目实际情况的代码或执行相关操作。

快速开始:首次与 PHP 项目交互 遇到新 PHP 项目时,按以下步骤执行。

  1. 检测 PHP 环境 调用 get_php_project_config()。它返回已配置的 PHP 语言级别、解释器详情(名称、路径、本地或远程)以及运行时信息(精确 PHP 版本、已加载扩展、php.ini 路径、调试器)。在生成代码前使用该信息理解 PHP 环境。

  2. 识别依赖与框架 调用 get_composer_dependencies()。它从 composer.lock 返回所有已安装包及其精确版本。可据此确定:框架(laravel/framework、symfony/framework-bundle 或两者皆无)、测试框架(phpunit/phpunit、pestphp/pest、codeception/codeception)、静态分析(phpstan/phpstan、vimeo/psalm)、代码风格(friendsofphp/php-cs-fixer、squizlabs/php_codesniffer)。可使用可选的 nameFilter glob 参数搜索特定包(例如 nameFilter: "laravel/*")。

  3. 路由到框架专属指引 根据依赖判断项目类型:laravel/framework 对应 Laravel,参见 references/framework-laravel.md;symfony/framework-bundle 对应 Symfony,参见 references/framework-symfony.md;两者皆无则为通用 PHP,参见 references/php-standards.md。

PhpStorm MCP 工具速查 代码分析:get_inspections 用于编辑后、代码审查时查找问题及可用快速修复;apply_quick_fix 用于自动解决检查问题;get_file_problems 用于任意文件类型的快速错误/警告检查(不返回快速修复);build_project 用于触发项目构建并获取编译错误。

代码搜索:search_structural 用于通过 SSR 语义化查找代码模式(需要 fileType: "PHP");get_structural_patterns 用于按类别发现预定义 PHP 搜索模式;search_text 用于跨项目文件的快速文本子串搜索;search_regex 用于带匹配坐标的正则搜索;search_symbol 用于语义化符号查找(类、方法、字段);search_file 用于按 glob 模式查找文件;find_files_by_name_keyword 用于按名称子串快速查找文件(使用索引);find_files_by_glob 用于递归查找匹配 glob 模式的文件。

代码智能:get_symbol_info 用于获取指定位置符号的快速文档;rename_refactoring 用于在整个项目中安全重命名符号;get_php_project_config 用于获取 PHP 语言级别、解释器、扩展、运行时信息;get_composer_dependencies 用于理解项目依赖、框架与版本。

文件操作:read_file 用于以高级模式读取文件(切片、行、偏移、缩进);get_file_text_by_path 用于按项目相对路径读取完整文件文本;replace_text_in_file 用于在文件中进行定向查找替换;create_new_file 用于创建带内容的新文件;reformat_file 用于应用 IDE 代码格式化规则。

执行:get_run_configurations 用于列出可用的运行/测试配置;execute_run_configuration 用于运行指定配置并获取结果;execute_terminal_command 用于在 IDE 终端中运行 shell 命令。详细参数与用法模式参见 references/mcp-tools-reference.md。

文档查询 当需要这些参考之外的文档时:Context7 MCP 可先使用 resolve-library-id 再使用 query-docs 查询任意 PHP 框架或库,返回最新文档与代码示例;PHP 官方文档见 https://www.php.net/manual;PhpStorm 帮助见 https://www.jetbrains.com/help/phpstorm/;phpstorm-stubs 见 https://github.com/JetBrains/phpstorm-stubs,提供 PHP 内置函数签名与类型信息。

参考文档 references/project-detection.md:composer.json 结构、PSR-4 自动加载、目录布局。references/php-standards.md:PER/PSR 编码规范、PHP 版本特性、反模式。references/testing-guide.md:PHPUnit、Pest、运行测试、常见错误。references/framework-laravel.md:Laravel 目录结构、Eloquent、artisan、路由。references/framework-symfony.md:Symfony 目录结构、Doctrine、console、服务。references/static-analysis.md:PHPStan、Psalm、PHP CS Fixer、PHP CodeSniffer。references/composer-guide.md:Composer 命令、版本约束、自动加载。references/mcp-tools-reference.md:PhpStorm MCP 工具详细参数与工作流。

限制 资料未提供该技能的收费、价格、平台限制或实际使用效果等信息。该技能依赖 PhpStorm 环境及其 MCP 工具,所涉及的具体工具行为与可用性以实际环境为准。