dereuromark/cakephp-ide-helper

CakePHP IdeHelper 插件,用于提高自动补全功能

资助包维护!
dereuromark

安装量: 1,397,027

依赖项: 26

建议者: 46

安全: 0

星标: 182

关注者: 15

分支: 40

开放问题: 11

类型:cakephp-plugin

2.3.0 2024-08-30 10:08 UTC

README

CI Coverage Status PHPStan Latest Stable Version Minimum PHP Version License Total Downloads

CakePHP 应用程序的 IdeHelper 插件。

提高您的生产力。避免错误。

此分支适用于 CakePHP 5.0+。详细信息请参阅 版本映射

功能

主要思想是提高 IDE 兼容性,并使用注解使 IDE 理解 CakePHP 的“魔法”,这样您就可以通过类方法和对象链进行点击,以及更容易地发现明显的问题和错误。IDE 通常会将有问题的代码标记为黄色(缺少、方法错误等)。

这还提高了与像 PHPStan 这样的工具的兼容性。然后它们可以更容易地跟踪代码并提供更有价值的帮助。

  • 就像烘焙新代码一样,为现有代码添加注解(例如,在升级应用程序时)。
  • 可以多次运行而无需再次添加注解。
  • 它还可以替换或删除过时的注解。
  • 它与您的应用程序以及任何加载的插件一起工作。
  • 支持 CI 检查,就像编码标准检查一样挂钩。

支持以下注解

  • 模型(表和实体)
  • 控制器(包括如 Admin 这样的前缀)和组件
  • 视图(AppView)和助手
  • 模板(.php PHP 模板文件,包括元素)
  • 命令、外壳和任务
  • ... 更多

Screenshot

支持以下代码补全帮助

  • 行为(在 BehaviorRegistry 上访问属性)

支持(魔法)字符串以及以下返回类型/值的 IDE 自动完成/类型提示

  • 插件、组件、行为、助手、邮件发送器
  • 关联、验证
  • I18n 翻译、缓存
  • 元素和布局
  • 表及其字段
  • 路由路径、请求/ENV、连接
  • ... 更多(使用 PhpStorm 元文件)

通过 Illuminator 任务支持更好的 IDE 使用,以增强现有代码

  • EntityFieldTask 将所有实体字段添加为类常量,以便在 IDE 中更容易使用

IDE 支持

此插件旨在与支持注解和代码补全的任何 IDE 一起使用。到目前为止已测试的 IDE 兼容性为 100%

  • PhpStorm(包括元文件生成器)
  • IntelliJ
  • Atom
  • VS Code
  • ... [在此处报告或提交您选择的 IDE 的 PR 以确认其完全兼容性]

有关详细信息和建议/设置,请参阅 Wiki

带有元文件生成器任务的插件

以下插件使用此插件来提高 IDE 在工厂和魔法字符串使用方面的兼容性

  • Migrations 用于迁移文件编写(直接包含在 IdeHelper 中)。
  • Queue 用于 QueuedJobsTable::createJob() 的使用。
  • Burzum/CakeServiceLayer 用于 loadService() 的使用。
  • ...(在此处添加您的插件)

带有 Illuminator 任务的插件

  • StateMachine 用于将 XML 中的状态同步到 PHP。
  • ...(在此处添加您的插件)

更多

更多有用的任务集合可以在 IdeHelperExtra 插件 中找到。

安装、设置、使用

有关详细信息,请参阅 文档