PhpStorm 2021.3 Help

配置远程 PHP 解释器

术语远程 PHP 解释器表示安装在远程主机或虚拟环境中的 PHP 引擎。术语远程 PHP 解释器与安装在您计算机上的本地 PHP 解释器相反,请参阅配置本地 PHP 解释器

您可以通过 SSH、Docker、Docker Compose、Vagrant 或 WSL 访问远程 PHP 解释器:

通过使用SSH,您可以通过 SSH 访问安装 PHP 解释器的主机来访问 PHP 解释器。

在你开始前:

使用 SSH 配置 PHP 解释器

  1. Ctrl+Alt+S打开 IDE 设置并选择PHP

  2. 在打开的PHP页面上,单击CLI 解释器列表浏览按钮旁边的。

  3. 在打开的CLI Interpreters对话框中,单击添加按钮左侧窗格,然后从弹出菜单中选择From Docker、Vagrant、VM、WSL、Remote...。

  4. 在打开的配置远程 PHP 解释器对话框中,选择SSH方法。

    通过 SSH 对话框的远程解释器
  5. SSH 配置列表中,选择已创建的 SSH 配置之一,或单击浏览按钮并创建一个新配置,如创建 SSH 配置中所述。

    要使用解释器配置,您需要设置项目文件夹、服务器上要将项目文件复制到的文件夹以及访问服务器上复制数据的 URL 地址之间的对应关系的路径映射。PhpStorm 首先尝试通过处理所有可用的应用程序级配置来检索路径映射本身。如果 PhpStorm 找到与所选 SSH 配置中指定的主机相同的配置,则会自动合并来自这些配置的映射。如果未找到此主机的配置,PhpStorm 会显示一条错误消息,通知您未配置路径映射。

    要解决此问题,请打开IDE 设置的 PHP 页面,单击Ctrl+Alt+S路径映射字段并将本地文件夹映射到服务器上的文件夹。打开

  6. PHP 解释器路径字段中,根据所选远程开发环境的配置指定PHP可执行文件的位置。

    • 对于远程主机,PhpStorm 默认建议/usr/bin/php位置。

    要指定不同的文件夹,请打开在打开的对话框中单击并选择相关文件夹。请注意,PHP 主目录必须打开才能进行编辑。

    单击OK时,PhpStorm 会检查 PHP 可执行文件是否实际存储在指定文件夹中。

    • 如果没有找到 PHP 可执行文件,PhpStorm 会显示一条错误消息,询问您是继续搜索还是保存解释器配置。

    • 如果找到 PHP 可执行文件,则返回CLI 解释器对话框,其中显示安装文件夹和检测到的 PHP 解释器版本。

  7. CLI Interpreters对话框中,单击Show phpinfo 显示 phpinfo 按钮让 PhpStorm 显示一个单独的信息窗口,其中包含安装详细信息以及加​​载的扩展和配置选项的列表。请注意,未列出在PHP 解释器对话框的配置选项字段中指定的其他选项。

通过使用Docker配置,您可以访问安装在 Docker 容器中的 PHP 解释器。

在你开始前:

  1. 确保按照Docker中的说明在您的计算机上下载、安装和配置Docker

  2. 确保已安装并启用DockerPHP Docker插件。默认情况下激活插件。如果插件被禁用,请在插件页面的已安装选项卡上启用它们,如安装插件中所述。

  3. 在要使用的Docker 容器中配置 PHP 开发环境。

了解有关在Docker中将Docker与 PhpStorm 结合使用的更多信息。

在 Docker 容器中配置 PHP 解释器

  1. Ctrl+Alt+S打开 IDE 设置并选择PHP

  2. 在打开的PHP页面上,单击CLI 解释器列表浏览按钮旁边的。

  3. 在打开的CLI Interpreters对话框中,单击添加按钮左侧窗格,然后从弹出菜单中选择From Docker、Vagrant、VM、WSL、Remote...。

  4. 在打开的配置远程 PHP 解释器对话框中,选择Docker方法。

    通过 Docker 对话框进行远程解释器
  5. 提供连接参数:

    • 服务器字段中,指定要使用的Docker 配置,有关详细信息,请参阅 配置 Docker 守护程序连接设置。从列表中选择一个配置或单击 新建... ,然后在打开的Docker 页面上创建一个新配置。

    • 镜像名称字段中,指定要使用的基本 Docker 镜像。从列表中选择之前下载的或您的自定义图像之一,或手动键入图像名称,例如php:latestphp:7.0-cli。当您稍后启动运行配置时,Docker 将在您的机器上搜索指定的映像。如果搜索失败,将从Docker Registry 页面上的Docker Official Images仓库下载镜像。

  6. PHP 解释器路径字段中,根据所选远程开发环境的配置指定PHP可执行文件的位置。

    • 对于 Docker 容器,PhpStorm 默认建议php位置。

    单击OK时,PhpStorm 会检查 PHP 可执行文件是否实际存储在指定文件夹中。

    • 如果没有找到 PHP 可执行文件,PhpStorm 会显示一条错误消息,询问您是继续搜索还是保存解释器配置。

    • 如果找到 PHP 可执行文件,则返回CLI 解释器对话框,其中显示安装文件夹和检测到的 PHP 解释器版本。

  7. CLI Interpreters对话框中,单击Show phpinfo 显示 phpinfo 按钮让 PhpStorm 显示一个单独的信息窗口,其中包含安装详细信息以及加​​载的扩展和配置选项的列表。请注意,未列出在PHP 解释器对话框的配置选项字段中指定的其他选项。

通过使用Docker Compose配置,您可以访问在多容器 Docker Compose 环境中运行的 PHP 解释器。

在你开始前:

  1. 确保按照Docker中的说明在您的计算机上下载、安装和配置Docker

  2. 确保已安装并启用DockerPHP Docker插件。默认情况下激活插件。如果插件被禁用,请在插件页面的已安装选项卡上启用它们,如安装插件中所述。

  3. 在要使用的Docker 容器中配置 PHP 开发环境。

在Using Docker Compose中了解有关将Docker Compose与 PhpStorm 结合使用的更多信息。

使用 Docker Compose 配置 PHP 解释器

  1. Ctrl+Alt+S打开 IDE 设置并选择PHP

  2. 在打开的PHP页面上,单击CLI 解释器列表浏览按钮旁边的。

  3. 在打开的CLI Interpreters对话框中,单击添加按钮左侧窗格,然后从弹出菜单中选择From Docker、Vagrant、VM、WSL、Remote...。

  4. 在打开的配置远程 PHP 解释器对话框中,选择Docker Compose方法。

    通过 Docker Compose 对话框进行远程解释器
  5. 提供连接参数:

    • 服务器字段中,指定要使用的Docker 配置,有关详细信息,请参阅 配置 Docker 守护程序连接设置。从列表中选择一个配置或单击 新建... ,然后在打开的Docker 页面上创建一个新配置。

    • 配置文件字段中,指定要使用的docker-compose配置文件。默认选择位于项目根目录中的基本配置文件。要选择不同的文件或多个文件,请在打开的Docker Compose 配置文件对话框中单击打开并选择所需的配置文件。

    • 服务列表中,选择与设置 PHP 开发环境的容器对应的服务。

    • 如有必要,在环境变量字段中,提供环境变量。有关详细信息,请参阅Docker 运行配置设置。

  6. PHP 解释器路径字段中,根据所选远程开发环境的配置指定PHP可执行文件的位置。

    • 对于 Docker 容器,PhpStorm 默认建议php位置。

    单击OK时,PhpStorm 会检查 PHP 可执行文件是否实际存储在指定文件夹中。

    • 如果没有找到 PHP 可执行文件,PhpStorm 会显示一条错误消息,询问您是继续搜索还是保存解释器配置。

    • 如果找到 PHP 可执行文件,则返回CLI 解释器对话框,其中显示安装文件夹和检测到的 PHP 解释器版本。

  7. CLI Interpreters对话框中,单击Show phpinfo 显示 phpinfo 按钮让 PhpStorm 显示一个单独的信息窗口,其中包含安装详细信息以及加​​载的扩展和配置选项的列表。请注意,未列出在PHP 解释器对话框的配置选项字段中指定的其他选项。

  8. CLI Interpreters对话框的Lifecycle区域中,选择 PhpStorm 应如何管理所选服务的 Docker 容器。

    • 始终启动一个新容器('docker-compose run'):选择此选项以通过运行命令启动容器。容器将在每次运行时重新启动。

    • 连接到现有容器('docker-compose exec'):选择此选项以启动容器一次,然后通过exec命令连接到它。

通过使用Vagrant配置,您可以访问安装在相应Vagrant实例上的 PHP 解释器。

在你开始前:

  1. 确保按照Vagrant: Working with Reproducible Development Environments中的描述,在您的计算机上下载、安装和配置VagrantOracle 的 VirtualBox

  2. 确保在Settings/Preferences |的Installed选项卡中启用了Vagrant捆绑插件。插件页面,如管理插件中所述。

  3. 确保将以下可执行文件的父文件夹添加到系统PATH变量中:

    • vagrant.batvagrant从你的 Vagrant 安装。这应该由 Vagrant 安装程序自动完成。

    • Oracle VirtualBox 安装中的VBoxManage.exeVBoxManage

  4. 在要使用的Vagrant 实例中配置 PHP 开发环境。

在Vagrant: Working with Reproducible Development Environments中了解更多关于使用Vagrant和 PhpStorm 的信息。

在 Vagrant 实例中配置 PHP 解释器

  1. Ctrl+Alt+S打开 IDE 设置并选择PHP

  2. 在打开的PHP页面上,单击CLI 解释器列表浏览按钮旁边的。

  3. 在打开的CLI Interpreters对话框中,单击添加按钮左侧窗格,然后从弹出菜单中选择From Docker、Vagrant、VM、WSL、Remote...。

  4. 在打开的配置远程 PHP 解释器对话框中,选择Vagrant方法。

    通过 Vagrant 对话框的远程解释器
  5. 提供连接参数:

    • 指定指向您要使用的环境的Vagrant 实例文件夹。从技术上讲,它是所需环境的VagrantFile配置文件所在的文件夹。基于此设置,PhpStorm 检测到Vagrant 主机并将其显示为Vagrant Host URL只读字段中的链接。

      要使用解释器配置,您需要设置项目文件夹、服务器上要将项目文件复制到的文件夹以及访问服务器上复制数据的 URL 地址之间的对应关系的路径映射。PhpStorm 评估来自VagrantFile配置文件的路径映射。

  6. PHP 解释器路径字段中,根据所选远程开发环境的配置指定PHP可执行文件的位置。

    • 对于 Vagrant 实例,PhpStorm 默认建议/usr/bin/php 位置。

    要指定不同的文件夹,请打开在打开的对话框中单击并选择相关文件夹。请注意,PHP 主目录必须打开才能进行编辑。

    单击OK时,PhpStorm 会检查 PHP 可执行文件是否实际存储在指定文件夹中。

    • 如果没有找到 PHP 可执行文件,PhpStorm 会显示一条错误消息,询问您是继续搜索还是保存解释器配置。

    • 如果找到 PHP 可执行文件,则返回CLI 解释器对话框,其中显示安装文件夹和检测到的 PHP 解释器版本。

  7. CLI Interpreters对话框中,单击Show phpinfo 显示 phpinfo 按钮让 PhpStorm 显示一个单独的信息窗口,其中包含安装详细信息以及加​​载的扩展和配置选项的列表。请注意,未列出在PHP 解释器对话框的配置选项字段中指定的其他选项。

通过使用WSL ,您可以通过Windows Subsystem for Linux兼容层访问安装在 Linux 环境中的 PHP 解释器。

在开始之前,请确保满足以下先决条件:

  • 在您的 Windows 10 计算机上,确保已启用WSL功能,并安装了首选的 Linux 发行版。有关详细信息,请参阅适用于 Windows 10 的 Windows 子系统 Linux 安装指南

  • 在 Linux 安装中,确保已安装 PHP。有关详细的安装说明,请参阅Debian GNU/Linux 安装说明。如果你使用的是 Ubuntu,你可以在终端中运行这个命令来快速安装 PHP:

    sudo apt install php php-mbstring php-xml php-zip php-curl php-xdebug

使用 WSL 配置 PHP 解释器

  1. Ctrl+Alt+S打开 IDE 设置并选择PHP

  2. 在打开的PHP页面上,单击CLI 解释器列表浏览按钮旁边的。

  3. 在打开的CLI Interpreters对话框中,单击添加按钮左侧窗格,然后从弹出菜单中选择From Docker、Vagrant、VM、WSL、Remote...。

  4. 在打开的配置远程 PHP 解释器对话框中,选择WSL方法。

    通过 WSL 对话框进行远程解释器
  5. Linux 分发列表中,选择要使用的已安装 Linux 分发之一。

  6. PHP 解释器路径字段中,根据所选远程开发环境的配置指定PHP可执行文件的位置。

    • 对于 WSL,PhpStorm 默认建议/usr/local/bin/php

    要指定不同的文件夹,请打开在打开的对话框中单击并选择相关文件夹。请注意,PHP 主目录必须打开才能进行编辑。

    单击OK时,PhpStorm 会检查 PHP 可执行文件是否实际存储在指定文件夹中。

    • 如果没有找到 PHP 可执行文件,PhpStorm 会显示一条错误消息,询问您是继续搜索还是保存解释器配置。

    • 如果找到 PHP 可执行文件,则返回CLI 解释器对话框,其中显示安装文件夹和检测到的 PHP 解释器版本。

  7. CLI Interpreters对话框中,单击Show phpinfo 显示 phpinfo 按钮让 PhpStorm 显示一个单独的信息窗口,其中包含安装详细信息以及加​​载的扩展和配置选项的列表。请注意,未列出在PHP 解释器对话框的配置选项字段中指定的其他选项。

提供额外的配置选项

  1. Ctrl+Alt+S打开 IDE 设置并选择PHP

  2. 在打开的PHP页面上,单击CLI 解释器列表浏览按钮旁边的。

  3. CLI 解释器对话框的附加区域中,您可以选择自定义 PHP 安装的配置设置。

    • 调试器扩展字段中,指定 Xdebug 的路径。 如果您在php.ini 文件中禁用了 Xdebug,这将使 PhpStorm 能够在必要时激活 Xdebug ,请参阅配置 Xdebug 以在按需模式下使用

    • 配置选项字段中,编写要通过-d 命令行选项传递的配置指令字符串,从而将新条目添加到php.ini文件中。此字段中指定的指令会覆盖 PhpStorm 生成的默认指令,例如-dxdebug.remote_enable=1, -dxdebug.remote_host=127.0.0.1, -dxdebug.remote_port=9001, -dxdebug.remote_mode=req

      例如,如果您指定-dxdebug.remote_mode=jit指令,它将覆盖默认-dxdebug.remote_mode=req指令,从而将Xdebug切换到Just-In-Time (JIT)模式,请参阅Debug in the Just-In-Time 模式了解详细信息。

      为此,请单击“配置选项浏览按钮”字段旁边的,然后在打开的“配置选项”对话框中创建条目列表。

      • 要添加新条目,请单击添加按钮。在添加到列表的新行中,分别在名称字段中指定新条目的名称及其值。

        您可以根据需要添加任意数量的条目,只需记住它们将被转换为长度限制为 256 个字符的命令行。

      • 要删除条目,请在列表中选择它并单击删除按钮

      • 要更改条目的顺序,请单击向上按钮向下按钮

      单击OK后,您将返回CLI Interpreters对话框,其中的条目将转换为命令行。

配置自定义映射

如果您使用可通过 SSH 连接访问或位于 Vagrant 实例或 Docker 容器中的解释器,则会自动从相应的部署配置VagrantfileDockerfile检索映射。

  1. Ctrl+Alt+S打开 IDE 设置并选择PHP

  2. 解释器列表中,选择要为其自定义映射的远程解释器。Path Mappings只读字段显示从相应的部署配置、VagrantfileDockerfile检索到的路径映射。要指定自定义映射,请单击路径映射字段浏览按钮旁边的。

  3. Edit Project Path Mappings对话框显示从部署配置、VagrantfileDockerfile检索到的路径映射。这些映射是只读的。

    • 要添加自定义映射,请分别在本地路径远程路径字段中单击添加按钮并指定项目中的路径和远程运行时环境上的相应路径。手动键入路径或单击并在打开的对话框中选择相关文件或文件夹。浏览按钮

    • 要删除自定义映射,请在列表中选择它并单击删除按钮

即时在配置的 PHP 解释器之间切换

  1. Ctrl+Shift+A并开始输入Change PHP interpreter。在建议列表中,选择更改 PHP 解释器操作。

    如有必要,您可以通过按 直接在建议列表中为此操作分配键盘快捷键Alt+Enter,或稍后按配置键盘快捷键中所述分配键盘快捷键。

  2. 在打开的弹出菜单中,选择已配置的本地远程PHP 解释器之一。

所选解释器将被设置为设置/首选项对话框 ( )的PHP页面上的默认项目解释器。这也会影响设置为使用默认项目解释器的运行/调试配置测试框架质量工具的配置。Ctrl+Alt+S

切换 PHP 解释器
最后修改:2021 年 11 月 26 日