PhpStorm 2021.3 Help

德鲁巴

您可以将 PhpStorm 用作Drupal开发的 IDE，包括模块、主题和核心。支持的版本为 6、7 和 8。

PhpStorm 在开发 Drupal 模块和核心时提供 Symfony2 和 Drupal 8 之间的集成。

下载和安装 Drupal

从Drupal 官方网站下载 Drupal并按照Drupal 安装说明中的说明进行安装。

在 PhpStorm 中设置 Drupal 项目

选项 1：使用 Drupal 模块创建 PhpStorm 项目

您可以通过 Drupal Module 模板创建一个 PhpStorm 项目，该项目将根据 Drupal 要求进行设置和配置。

PhpStorm 根据选定的 Drupal 版本生成和配置项目存根。对于 Drupal 8，会生成一个module_name.info.yml文件。

  1. 打开新建项目对话框

    选择文件 | 新建项目或单击PhpStorm 欢迎屏幕上的 创建新项目。

  2. 选择项目类型和位置

    在左侧窗格中，选择Drupal Module。

    在右侧窗格的位置字段中，指定将在其中创建项目的文件夹。

  3. 选择要使用的 Drupal 安装

    指定 Drupal 安装的根文件夹并选择要使用的 Drupal 版本，支持的版本为 6、7 和 8。

    稍后您可以更改 Drupal 安装并重新配置框架页面上的包含路径，如更改 Drupal 设置中所述

  4. 配置包含路径

    选择设置 PHP | 包含路径复选框让 Drupal 包含为项目自动配置的路径。离开对话框后，以下路径将添加到PHP页面的Include Paths列表中： <drupal 安装根目录>/includes、<drupal 安装根目录>/modules和<drupal 安装根目录>/sites/all/modules

选项 2：导入现有的 Drupal 模块

当您打开现有的 Drupal 模块时，PhpStorm 会识别 Drupal 特定的结构并建议激活 Drupal 支持。

  1. 打开你的项目

    在欢迎屏幕上单击打开或选择文件 | 从主菜单打开，然后选择存储 Drupal 模块的文件夹。

    PhpStorm 检测到 Drupal 特定的结构并显示通知：

    drupalStructureDetected.png

  2. 启用 Drupal 支持

    单击通知中的启用。在打开的Drupal 模块对话框中，选中启用 Drupal 集成复选框，然后像使用 Drupal 模块创建项目一样继续：指定 Drupal 安装的根文件夹，选择要使用的版本，并配置包含路径。

无论您是在现有 PhpStorm 项目中启用 Drupal 支持，还是使用 Drupal 模块创建新项目，PhpStorm 都会检查开发环境是否为 Drupal 开发正确配置。

任何检测到的不一致都会在事件日志工具窗口中报告，并作为弹出窗口针对每个差异 PhpStorm 建议修复。要应用建议，请单击报告事件旁边的链接。

Drupal 事件日志

将 Drupal 特定文件与 PHP 文件类型相关联

PhpStorm 将文件识别并视为php文件，并根据文件类型关联提供代码突出显示。

选项 1：使用事件日志

  • 在事件日志工具窗口中，单击Drupal 支持旁边的修复：<*.file extension> files are not associated with PHP file type消息。

选项 2：使用文件类型页面

  • 在Settings/Preferences对话框 ( Ctrl+Alt+S) 中，导航到Editor | 文件类型。

    在打开的文件类型页面上，在文件名模式区域中定义文件掩码。有关详细信息，请参阅文件类型关联。

更改 Drupal 设置

选项 1：启用或禁用 Drupal 集成

  • 在设置/首选项对话框 ( Ctrl+Alt+S) 中，导航到PHP | 框架。在打开的框架页面上，切换启用 Drupal 集成复选框以激活或停用当前 PhpStorm 项目中的 Drupal。

    要使用另一个 Drupal 安装，请键入相关安装文件夹的路径。

    必要时更改版本。

选项 2：更新包含路径

  • 在Settings/Preferences对话框 ( Ctrl+Alt+S) 中，导航到PHP。

    在打开的PHP 页面上，在Include Paths区域中进行所需的更改。

在 PhpStorm 中使用 Drupal 钩子

PhpStorm在.module文件中提供对Drupal 挂钩的完整原生支持。

  • 对钩子声明使用代码完成

    PhpStorm 索引任何钩子调用，因此钩子名称在代码完成中可用，以创建钩子实现。要完成声明，请开始输入挂钩名称并按Ctrl+Space。

    Drupal 挂钩名称完成

  • 导航到挂钩调用

    • 要从编辑器导航到挂钩调用，请单击实施 Drupal Hook 图标装订线中的图标。

    • 在多次调用的情况下，PhpStorm 会显示可用的钩子调用列表，您可以选择要跳转到的一个。

      选择 Hook 调用

      您将导航到使用 、 或 调用相关挂钩module_invoke_all()的module_invoke()行drupal_alter()。

  • 查看钩子文档

    将插入符号放在钩子的名称上，然后选择查看 | 快速文档查找或按Ctrl+Q。

在 PhpStorm 项目中设置 Drupal 代码样式

如果项目被识别为 Drupal 模块，或者在现有项目中启用了 Drupal 集成，或者当您使用 Drupal 模块创建新项目时，PhpStorm 会自动提供应用预配置的 Drupal 编码标准（代码样式）。但是，您可以随时在“设置”对话框的“代码样式：PHP ”页面上更改或自定义此设置。

在项目中使用预配置的 Drupal 代码样式

  • 在事件日志工具窗口中，单击可以为此项目消息设置Drupal 样式格式旁边的设置。

您还可以在代码样式：PHP 页面上设置预定义的代码样式。在Settings/Preferences对话框 ( Ctrl+Alt+S) 中，导航到Editor | 代码风格 | PHP。然后，单击Set from并选择Predefined | 德鲁巴_

如果适用，请使用页面上的控件自定义代码样式。

根据 Drupal 编码标准检查代码

使用 PhpStorm，您可以结合使用检测编码标准问题的PHP_CodeSniffer工具和为 PHP_CodeSniffer提供一组 Drupal 特定标准的Coder 。这将确保您的代码干净、一致并且没有一些常见错误。

要开始使用，请使用安装和配置 PHP_CodeSniffer 中描述的任何技术安装 PHP_CodeSniffer。可能最简单的方法是使用Composer安装它。

安装 PHP_CodeSniffer

  1. 在composer.json中，将squizlabs/php_codesniffer依赖记录添加到requireorrequire-dev部分。按Ctrl+Space以获得包名称和版本的代码完成。

  2. 执行以下操作之一：

    • 单击编辑器面板顶部的安装快捷方式链接。

    • 如果启用了未安装的 Composer 包检查，PhpStorm 将突出显示当前未安装的已声明依赖项。按Alt+Enter并选择是否要一次安装特定依赖项或所有依赖项。

接下来，安装Coder，它将为 PHP_CodeSniffer 提供 Drupal 特定的标准。

安装编码器

  1. 在composer.json中，将drupal/coder依赖记录添加到requireorrequire-dev部分。按Ctrl+Space以获得包名称和版本的代码完成。

  2. 执行以下操作之一：

    • 单击编辑器面板顶部的安装快捷方式链接。

    • 如果启用了未安装的 Composer 包检查，PhpStorm 将突出显示当前未安装的已声明依赖项。按Alt+Enter并选择是否要一次安装特定依赖项或所有依赖项。

将安装Coder包，并自动选择相应的Drupal标准进行PHP_CodeSniffer 验证检查。如有必要，您可以进一步自定义编辑器上的检查 | 设置/首选项对话框 ( Ctrl+Alt+S)的检查页面。有关详细信息，请参阅将 PHP_CodeSniffer 配置为 PhpStorm 检查。

从 PhpStorm 查看 Drupal API 文档

在 PhpStorm 编辑器中，选择您感兴趣的符号，然后从上下文菜单中选择Search in Drupal API 。Drupal API 文档打开。

使用 PhpStorm 中的 Drush 命令行工具

PhpStorm 与 Drush 命令行 shell 和脚本界面 5.8 及更高版本集成。在开始之前，请按照https://github.com/drush-ops/drush中的说明下载并安装 Drush 。

自动配置 Drush

手动配置 Drush

  1. 在设置/首选项对话框 ( Ctrl+Alt+S) 中，转到工具 | 命令行工具支持。

  2. 单击添加按钮工具栏上的 。

  3. 在命令行工具对话框中，从列表中选择 Drush，并指定其可见性级别（项目或全局）。

    命令行工具对话框

  4. 当您单击OK时，将打开Drush对话框。

    指定 Drush 可执行文件的路径。默认位置通常是Windows 上的C:/ProgramData/Drush/drush.bat和macOS 或 Linux 上的/usr/bin/drush 。如果您遵循标准安装过程，请单击“确定”接受预定义的路径。

    如果是自定义安装，请输入 Drush 可执行文件的路径，然后单击OK。

  5. 单击确定应用更改并返回命令行工具支持页面。或者，单击编辑按钮以编辑工具属性或编辑源按钮自定义命令集。有关详细信息，请参阅自定义工具。

运行 Drush 命令

  • 从主菜单中，选择工具 | 运行命令或按Ctrl两次。

    在打开的“运行任何内容”窗口中，以<drush> <command>格式键入命令的调用。

    命令执行结果显示在运行工具窗口中。

    运行 drush 命令

终止命令

调试 Drush 命令

Drupal 命令在扩展的控制器类中定义DrushCommands。要调试命令，至关重要的是为命令本身启动调试会话，而不是在其中定义它的控制器类文件。否则，将跳过 Drupal 引导过程，执行将失败。

  1. 在与所选命令对应的控制器类中，单击要设置断点的代码行处的编辑器装订线。

    在 Drupal 命令中设置断点

  2. 创建一个运行/调试配置，该配置将使用所选命令运行drush工具。在主菜单中，选择运行 | 编辑配置，然后单击并从列表中添加按钮选择PHP 脚本。

    运行/调试配置：PHP 脚本

  3. 在PHP 脚本对话框中，提供运行/调试配置参数。

    • 在文件字段中，提供drush可执行文件的路径。

    • 在参数字段中，键入实际命令及其参数，例如status.

    Drupal CLI 命令的运行/调试配置对话框

  4. 在 PhpStorm 工具栏上，选择创建的运行/调试配置并单击调试按钮。命令执行将在指定的断点处停止。

    调试 Drupal 命令

将 Drupal 8 与 Symfony2 一起使用

PhpStorm 提供 Drupal、版本 8 和 Symfony2 之间的紧密集成。通过这种集成，Symfony2 组件与 Drupal 基础设施相连。要利用此集成：

  1. 安装 Drupal Symfony2 Bridge 插件

    在“设置/首选项”对话框 ( Ctrl+Alt+S) 中，导航到“插件”页面。单击Browse Repositories，选择插件并单击Install。有关详细信息，请参阅安装插件。

  2. 启用注释

    要获得高级注释支持，请按照安装插件中的说明安装PHP注释插件。

Drupal 8 - Symfony2 集成有哪些编码帮助可用？

  • 适合在 Drupal 特定的t() 函数中使用的字符串在您的项目中被索引并提供完成。

  • 在url()和其他 Drupal API 函数中完成相关的yml键值，这使得搜索正确的值更容易。

  • 通过按或选择Navigate |导航到yml文件 转到声明。Ctrl+B

  • 完全支持yml文件中描述的服务容器，包括使用.Ctrl+B

  • 支持Twig 模板引擎，它现在是 Drupal 8 的默认模板引擎，包括 Drupal 功能的完成、导航和识别。另请参阅Drupal 8 中的 Twig。

最后修改时间：2021 年 10 月 20 日
WP-CLI 命令行工具 Joomla!