PhpStorm 2021.3 Help

Symfony

PhpStorm 为使用Symfony框架开发应用程序提供编码辅助和导航工具。

Symfony 支持是通过Symfony 插件提供的。该插件的源代码及其问题跟踪器可以在 GitHub 上找到。

在你开始前

在开始使用 Symfony 之前，请确保 Symfony 和 PHP Annotations 插件已安装并启用。

为项目启用 Symfony 插件

安装 Symfony 插件后，您需要为项目显式启用它。创建或打开 Symfony 项目后，PhpStorm 将显示一条通知消息，建议您启用该插件。

为项目启用 Symfony 插件

  1. 执行以下任一操作：

    • 单击通知消息中的Enable the Symfony plugin with autoconfiguration链接。

      Symfony 插件通知

    • 在设置/首选项对话框 ( Ctrl+Alt+S) 中，导航到PHP | Symfony并选中Enable Plugin for this Project复选框。

  2. 重新启动 PhpStorm 以使更改生效。

指定附加设置

根据 Symfony 项目的结构，您可能需要更改PHP |下的一些附加设置。交响乐。当使用遵循由 Composer 项目生成的结构的 Symfony 应用程序时，symfony/framework-standard-edition默认路径和设置可以正常工作。

请注意，appDevDebugProjectContainer.xml和appDevUrlGenerator.php必须位于 Symfony 的默认路径下，才能使用 Symfony 插件提供的所有功能。当无法找到这些文件时，它将使用回退机制，但在这种情况下完成和导航将不太精确。

当使用非默认项目结构时，以下路径应在 Symfony 插件设置中更新：

  • 翻译根路径：复制所有翻译的位置的路径。这应该设置为缓存文件夹下的翻译路径，以便插件发现所有可能的翻译。在 Symfony 4 及更高版本中，默认路径是./var/cache/dev/translations/。

  • 应用目录：应用目录的路径。在 Symfony 4 及更高版本中，默认路径是./config/。

  • Web 目录： Web目录的路径。在 Symfony 4 及更高版本中，默认路径是./public/。

Symfony 常规设置

Symfony 分析器

当为项目启用 Symfony 插件时，将在 PhpStorm 状态栏中添加一个额外的区域。单击状态栏中的Symfony将打开弹出菜单，其中包含向我们的 Symfony 应用程序发出的最新请求的相关目标。

Symfony 分析器工具栏

  • 单击分析器弹出菜单中的相应项：

    • 调试 URL：给定请求的 Symfony 分析器 URL，例如/app_dev.php/_profiler/355651。

    • Routes : 应用中的路由注册

    • 控制器：参与创建响应的控制器。

    • 模板：与响应相关的任何模板。

Symfony 代码风格

PhpStorm 提供了为 Symfony 开发量身定制的内置Symfony2 代码样式。

设置 Symfony2 代码风格

  1. 在Settings/Preferences对话框 ( Ctrl+Alt+S) 中，导航到Editor | 代码风格 | PHP。

  2. 单击右上角的Set from链接，然后从弹出菜单中选择Symfony2选项。

    Symfony 代码样式设置

根据编码标准检查代码

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

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

安装 PHP_CodeSniffer

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

  2. 执行以下操作之一：

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

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

接下来，安装Symfony 编码标准，它将为 PHP_CodeSniffer 提供特定标准。

安装 Symfony 编码标准

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

  2. 执行以下操作之一：

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

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

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

使用 PhpStorm 的 Symfony 命令行工具

PhpStorm 与 Symfony 控制台和脚本界面集成。在开始之前，请按照Symfony 文档中的说明安装 Symfony 控制台。

自动配置 Symfony

手动配置 Symfony

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

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

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

    命令行工具对话框

  4. 当你点击OK时，Symfony对话框打开。

    提供 Symfony 控制台可执行文件和 PHP 解释器的路径，设置 Symfony 版本，然后单击OK。

    默认的可执行位置是<Symfony-home>/data/bin/symfony对于Symfony 1.*，<Symfony-home>/app/console对于Symfony 2和<Symfony-home>/bin/console对于Symfony 3 及更高版本.

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

运行 Symfony 命令

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

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

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

    运行 symfony 命令

终止命令

调试 Symfony 命令

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

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

    在 Symfony 命令中设置断点

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

    运行/调试配置：PHP 脚本

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

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

    • 在参数字段中，键入实际命令及其参数，例如app:list-users.

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

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

    调试 Symfony 命令
最后修改时间：2021 年 3 月 8 日
教程：将 Yii 命令行工具与 PhpStorm 集成在 Symfony 项目中导航