本教程介绍 PhpStorm 版本7 为Drupal开发的最佳做法。PhpStorm绑定的插件提供很多Drupal的特定功能,主要为Drupal7 和Drupal6 版本,其中一些功能也适用于Drupal8。
在一个现有的PhpStorm 项目集成 Drupal
你需要提供一些额外的信息关于Drupal安装路径(Drupal安装的根文件夹)和版本号(目前支持Drupal 6 和 Drupal 7)。选择设置PHP | Include paths 自动配置为项目包含路径。
图1 Drupal集成设置可以在 Settings | Drupal。
根据上图确认后,PHPStorm 会弹出消息及事件日志让你修复(Fix)文件关联。
PHPStorm 文件关联
使用代码高亮显示,你需要设置一些额外的文件类型关联。
一个特殊的检查将会由PHPStorm IDE执行,当Drupal集成启用时(如果所需的文件关联没有设置) 并自动弹出窗口建议解决这个问题出现以及事件日志。
- .module, .install, .theme 应该关联到 PHP 文件类型
- .info 应该关联到 INI 文件类型
图2 Drupal文件关联设置可以在 Settings | File Types | PHP files(PHP)
PHPStorm 设置Drupal 代码标准
在开发Drupal项目当然应该遵从Drupal规定的代码规范。PhpStorm 已经预置Drupal代码标准(代码风格)。可以通过 Settings | Code Style | PHP | Set From… | Predefined Style | Drupal 来设置。
图3 代码标准总是可以重新配置在 Settings | Code Style | PHP
PHPStorm 支持Drupal 钩子(HOOK)
任何钩子(hook)的调用都被PHPStorm 默认索引在IDE里,钩子的名字可以用在代码完成,通过Tab键来实现创建钩子。
导航到任何Drupal钩子的定义,可以从编辑器 沟(gutter )“导航到钩子调用”通过Gutter图标:
点击 Gutter 图标你将被导航到相关使用 module_invoke_all(), module_invoke() 或者 drupal_alter() 义的钩子调用模块。
图4 查看钩子函数的Gutter 图标和快速定义文档。
Drupal 子的快速文档可以在PHPStorm IDE中查看通过View | Quick Documentation (或者只是按下Ctrl+Q)。该快速文档是取自.api.php 文件,它用来提供查询核心模块和许多其他模块备API参考函数目的。
PHPStorm 实现查询Drupal API 参考函数
Drupal API文档在 https://api.drupal.org/api/drupal 可以很容易地从PhpStorm IDE选择并跳转。只需选择您想要查询的API函数,在编辑器中鼠标右键点击可以看见“Search in Drupal API”菜单项,然后选择即可跳转到Drupal API网站。
图5 选择参考函数并鼠标邮件点击Search in Drupal API。
默认的浏览器会打开以你通过PHPStorm IDE发送的请求达到Drupal API文档。
图6 通过PHPStom 达到Drupal API 参考函数。
本教程中使用的PHPStorm 7 可以通过 PhpStorm Early Access Program 下载 PhpStorm 7 EAP 130.1176。