教程：将 Yii 命令行工具与 PhpStorm 集成

1. 创建一个新的 Composer 项目并选择安装yiisoft/yii2-app-basic包。

   

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

3. 单击工具栏上的 。在命令行工具对话框中，从选择工具列表中选择自定义工具并将其可见性级别设置为project。

   

4. 单击确定。在“工具设置”对话框中，提供工具的主要参数。在我们的例子中，该工具位于项目根目录下，我们使用yii它的别名。

   

5. 应用更改并关闭“设置/首选项”对话框。工具xml定义将在编辑器中打开。

   

6. 要为yii命令使用代码补全，我们需要先在xml工具描述符中定义它们。

   命令的定义组织如下：

   <command> <!--命令的容器--> <name> <!--命令本身，必填，非空--> </name> <help> <!--命令的帮助信息，可选--> </help> <params> <!--命令的参数及其默认值--> </params> <optionsBefore> <!--命令的选项容器--> <option name="" shortcut= ""> <!--选项本身，必填，非空；您还可以通过属性提供简写缩写和使用模式--> <help> <!--命令的帮助消息，可选--> </help> </option> </optionsBefore> </command>

   让我们为一个简单的hello命令添加一个定义，它与输入的参数相呼应。该命令通过以下语法执行：

   yii 你好 [消息] [...选项...]

   此命令的结果定义应如下所示：

   <command> <name>hello</name> <help>回显输入的参数</help> <params>message</params> <optionsBefore> <option name="--appconfig"> <help> 自定义应用程序配置文件小路。如果未设置，则使用默认应用程序配置。</help> </option> <option name="--color" pattern="equals"> <help> 布尔值，0 或 1。启用或禁用输出中的 ANSI 颜色。如果没有设置，ANSI 颜色仅对支持它的终端启用。</help> </option> <option name="--help" shortcut="-h" pattern="equals"> <help> 布尔值，0 或 1。定义是否显示当前命令的帮助信息。</help> </option> <option name="--interactive" pattern="equals"> <help> 布尔值，0 或 1。定义是否以交互方式运行命令。</help> </option> </optionsBefore>

7. 基本工具定义已准备就绪。选择工具 | 从主菜单运行命令Ctrl，或按两次。在打开的“运行任何内容”窗口中，键入命令并按Enter。

   

您可以在yii2-phpstorm-commandlinetool GitHub 存储库中找到完整的yii工具定义文件。也看看其他值得注意的例子！