PhpStorm 2021.3 Help

PHP 命令行工具

PhpStorm 支持运行流行的第三方或用户自定义 PHP 工具的命令: Symfony 1.1+Symfony2Zend Framework 1Zend Framework 2 (ZFTool)YiiComposerDrush 5.8+LaravelDoctrine(基于 Symfony 控制台) , WordPress 命令行界面

在开始之前,请确保在“设置/首选项”对话框 ( )的“插件”页面上启用了命令行工具支持插件。Ctrl+Alt+S

将外部 PHP 命令行工具与 PhpStorm 集成

  1. 下载并安装该工具。

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

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

  4. 命令行工具对话框中,从列表中选择工具,并指定其可见性级别(项目全局)。

    命令行工具对话框
  5. 单击OK时,将打开工具设置对话框。在此对话框中,设置工具执行。

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

运行命令

运行命令

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

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

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

    运行作曲家命令

终止命令

自定义工具

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

  2. 在“命令行工具支持”页面上,选择列表中的工具并单击编辑源按钮工具栏上的 。xml工具描述符在编辑器中打开。

  3. 更新命令的定义(有关详细信息,请参阅定义您自己的命令行工具)。在您键入时,会即时检查工具描述符的格式是否正确。

  4. 重新加载命令定义。在“设置/首选项”对话框 ( ) 的“命令行工具支持”页面上,选择列表中的工具并单击工具栏上的 。Ctrl+Alt+S从可执行按钮重新加载命令列表

定义自己的命令行工具

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

  2. 单击添加按钮工具栏并在打开的命令行工具对话框中,从选择工具列表中选择自定义工具,并为其指定可见性级别(项目全局)。

  3. 在“工具设置”对话框中,键入工具的路径和工具别名。

    当您单击OK时,PhpStorm 会将您带到命令行工具支持页面,新工具已添加到列表中。

  4. 单击“确定”接受更改并关闭“设置/首选项”对话框。

    工具定义xml文件会自动在编辑器中打开,让您定义工具命令。

    命令的定义组织如下:

    <command> <!--命令的容器--> <name> <!--命令本身,必填,非空--> </name> <help> <!--命令的帮助信息,可选--> </help> <params> <!--命令的参数及其默认值--> </params> <optionsBefore> <!--命令的选项容器--> <option name="" shortcut= ""> <!--选项本身,必填,非空;您还可以通过属性提供简写缩写和使用模式--> <help> <!--命令的帮助消息,可选--> </help> </option> </optionsBefore> </command>
  5. 重新加载命令定义。在“设置/首选项”对话框 ( ) 的“命令行工具支持”页面上,选择列表中的工具并单击工具栏上的 。Ctrl+Alt+S从可执行按钮重新加载命令列表

有关将自定义Yii命令行工具与 PhpStorm集成的分步指南,请参阅教程:将 Yii 命令行工具与 PhpStorm集成。

保持工具描述符一致

每次您在xml工具描述符中编辑命令定义时,PhpStorm都会即时检查它的格式是否正确。每次调用命令时都会执行完全验证。

如果检测到任何不一致,“运行工具”窗口中会显示一条错误消息。

验证工具定义

  1. 设置/首选项对话框 ( Ctrl+Alt+S) 中,转到工具 | 命令行工具支持。具有不一致描述符的工具标有警告图标

    CLI 工具验证错误
  2. 选择列表中的工具并单击编辑源按钮工具栏上的 。xml工具描述符在编辑器中打开。

  3. 根据需要更新命令的定义。有关详细信息,请参阅定义您自己的命令行工具

自定义工具命令定义

下表列出了第三方开发者提供的几个自定义命令行工具。

最后修改时间:2021 年 3 月 8 日