PhpStorm 2021.3 Help

PHP斯坦

PhpStorm 通过与PHPStan工具的集成提供代码质量检查,该工具根据一组验证规则验证您的代码的一致性。

要从 PhpStorm 而不是命令行使用 PHPStan,您需要在 PhpStorm 中注册它并将其配置为 PhpStorm代码检查。一旦在 PhpStorm 中安装并启用,该工具就可以在任何打开的 PHP 文件中使用,并且不需要额外的步骤来启动它。文件中的每次更新都会激活动态代码检查,因此可以轻松摆脱发现的问题。

PHPStan 即时报告的错误和警告显示为弹出消息。当该工具以批处理模式运行时,错误和警告会显示在“问题”工具窗口中。每条消息都有phpstan前缀以将其与 PhpStorm 内部检查区分开来。

PHPStan 集成是通过开源 PHPStan 插件实现的。该插件与 PhpStorm 捆绑在一起,默认启用。

先决条件

在将 PHPStan 集成到 PhpStorm 之前,请确保满足以下先决条件:

  • 必须将包含 PHP 引擎可执行文件的目录添加到系统中path。这允许代码质量工具脚本执行对系统范围的 PHP 引擎的调用。

  • 对于基于 Docker Compose 的远程解释器,请确保使用execmode 以避免产生额外的容器。

    1. 设置/首选项对话框 ( Ctrl+Alt+S) 中,转到PHP

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

    3. 在打开的CLI 解释器对话框中,将所选解释器的生命周期模式设置为连接到现有容器 ('docker-compose exec')

      docker-compose exec 用于 PHP 解释器

安装和配置 PHPStan

PHPStan 脚本可以用作本地脚本、与 PHP 解释器关联的脚本,或声明为项目依赖项并通过Composer安装的脚本,这是首选和推荐的方式。

使用 Composer 安装 PHPStan

在开始之前,请确保 Composer 已安装在您的计算机上并在当前项目中初始化,如Composer 依赖项管理器中所述。

当您使用 Composer 安装 PHPStan 时,PhpStorm 会自动下载必要的脚本,在 IDE 中注册它们,并且可以选择启用和配置相应的代码检查

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

  2. 执行以下操作之一:

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

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

点击composer.json设置/首选项按钮编辑器gutter中包记录旁边的,跳转到对应的Settings/Preferences页面,手动配置PHPStan

composer.json 中 phpstan 设置的装订线图标

重置 PHPStan 配置

初始配置 PHPStan 后,composer.json 中的进一步修改不会影响检查配置。要应用较新的更改,请重置 PHPStan 配置。

  1. 设置/首选项对话框 ( Ctrl+Alt+S) 中,导航到PHP | 质量工具

  2. 在打开的质量工具页面上,展开PHPStan区域并单击配置列表浏览按钮旁边的。

  3. 在打开的PHPStan对话框中,清空PHPStan 路径字段。

    空 PHPStan 路径字段
  4. 通过单击composer.json编辑器面板顶部的更新来更新项目 Composer 依赖项。有关详细信息,请参阅更新依赖项。

PhpStorm 将重新执行 PHPStan 配置,从而应用composer.json中的更改。

手动配置 PHPStan

您可以使用手动下载的本地 PHP 代码质量工具脚本或与 PHP 解释器关联的脚本。可以有许多本地和远程 PHP 解释器,在Settings/Preferences对话框的PHP页面上指定的解释器被认为是Project Default在配置远程 PHP 解释器配置本地 PHP 解释器中了解有关配置 PHP 解释器的更多信息。

选择要使用的 PHPStan 脚本

  1. 设置/首选项对话框 ( Ctrl+Alt+S) 中,导航到PHP | 质量工具

  2. 在打开的质量工具页面上,展开PHPStan区域。从配置列表中,选择 PHPStan 脚本:

    • 要使用与特定远程 PHP 解释器关联的脚本,请选择该解释器的名称。

    • 要使用本地脚本,请选择Local。在这种情况下,无论项目中使用的是本地还是远程的 PHP 解释器,都会执行本地 PHPStan。请注意,PHPStan 只能有一个本地配置,因为 PhpStorm 运行包含 PHP 引擎路径的脚本( Windows 为phpstan.bat ,Linux 和 macOS 为phpstan )。

    • 要使用与默认项目解释器关联的脚本,即在设置/首选项对话框的PHP页面上选择的脚本,请选择默认项目解释器

配置本地 PHPStan 脚本

  1. 下载并安装PHPStan脚本。

    要检查 PHPStan 安装,请切换到安装目录并运行以下命令:

    phpstan--版本

    如果该工具可用,您将收到以下格式的消息:

  2. 在 PhpStorm 中注册本地 PHPStan 脚本:

    • 设置/首选项对话框 ( Ctrl+Alt+S) 中,导航到PHP | 质量工具

    • 在打开的质量工具页面上,展开PHPStan区域并单击配置列表浏览按钮旁边的。

    • 在打开的PHPStan对话框中,在PHPStan 路径字段中指定phpstan.batphpstan PHPStan 可执行文件的位置。手动键入路径或单击并在打开的对话框中选择相关文件夹。浏览按钮

      要检查phpstan.batphpstan的指定路径是否确保 PhpStorm 和 PHPStan 之间的交互,即可以从 PhpStorm 启动该工具并且 PhpStorm 将从它接收问题报告,请单击“验证”按钮。此验证等同于运行phpstan --version命令。如果验证成功通过,PhpStorm 会显示有关检测到的 PHPStan 版本的信息。

  3. 如有必要,在Tool process timeout字段中,指定您希望 PhpStorm 等待 PHPStan 结果的时间,然后终止进程以防止过多的 CPU 和内存使用。

配置与 PHP 解释器关联的 PHPStan 脚本

  1. 设置/首选项对话框 ( Ctrl+Alt+S) 中,转到PHP | 质量工具

  2. 在打开的质量工具页面上,展开PHPStan区域并单击配置列表浏览按钮旁边的。PHPStan对话框打开,在左侧窗格中显示所有已配置 PHPStan 脚本的列表,其中一个是 Local 类型其他以与脚本关联的 PHP 解释器命名。

  3. 单击添加按钮工具栏上的 。在打开的PHPStan by Remote Interpreter对话框中,选择远程 PHP 解释器以使用关联的脚本。如果列表不包含相关解释器,请单击浏览按钮并在CLI 解释器对话框中配置远程解释器,如配置远程 PHP 解释器中所述。

    当您单击OK时,PhpStorm 会将您返回到PHPStan对话框,其中新的PHPStan配置已添加到列表中,右侧窗格显示选择的远程 PHP 解释器、与其关联的 PHPStan 的路径以及高级 PHPStan 选项.

  4. 如有必要,在Tool process timeout字段中,指定您希望 PhpStorm 等待 PHPStan 结果的时间,然后终止进程以防止过多的 CPU 和内存使用。

将 PHPStan 配置为 PhpStorm 检查

使用 Composer 配置 PHPStan 检查

您可以在composer.json的脚本部分中包含有关 PHPStan 配置文件的信息。当您安装更新项目依赖项时,将检测指定的配置文件并自动启用PHPStan 验证检查。

如果没有在composer.jsonscripts部分指定配置文件,PhpStorm 将额外检查项目根目录以找到 默认名称为phpstan.neonphpstan.neon.dist的规则集。

  • composer.jsonscripts部分中,将PHPStan 启动命令添加到叶元素之一中。phpstan

    提供-c参数和配置文件的路径:

    “脚本”:{“phpstan”:“供应商/bin/phpstan -c phpstan.neon”}

手动配置 PHPStan 检查

  1. Settings/Preferences对话框 ( Ctrl+Alt+S) 中,单击Editor下的Inspections

  2. 在打开的检查页面上,展开PHP | Quality Tools节点并选中PHPStan validation旁边的复选框。

  3. 在页面的右侧窗格中,使用选项区域中的控件配置 PHPStan 工具:

    1. Severity列表中,选择 PHPStan 检查的严重程度。选定的值决定了 PhpStorm 处理检测到的差异的严重程度并显示在检查结果中。

    2. 范围列表中,选择将检查应用程序限制到的范围。

    3. 级别字段中,提供执行 PHPStan 检查的所需规则级别。请注意,如果提供了配置文件,则 PhpStorm 依赖于此文件中指定的级别值,并且忽略级别字段。

    4. 配置文件字段中,提供PHPStan 配置文件的路径。

    5. Autoload file中,提供自动加载器的路径。请注意,如果提供了配置文件,则 PhpStorm 依赖于此文件中指定的autoload-file值,并且Autoload file字段将被忽略。

    6. 内存限制字段中,提供 PHPStan 允许分配的最大 RAM 量。您可以提供以字节为单位的显式整数值,也可以使用简写符号500M4G等)。

以批处理模式运行 PHPStan

  1. 从主菜单中,选择代码 | 检查代码

  2. 从列表中选择检查配置文件,或单击以在打开的检查对话框中浏览按钮配置新配置文件。您还可以单击以检查将应用哪些修复并确保启用PHPStan 验证检查。浏览按钮

    使用完整项目运行(仅限批处理模式)选项来选择是整个项目还是仅其源根包含在检查运行范围内。

  3. 在问题工具窗口中查看检查结果。PHPStan 报告的错误和警告带有前缀,以将它们与 PhpStorm 内部检查区分开来。

从 PHPStan 验证检查中排除文件

当等待 PHPStan 响应超过PHPStan对话框中工具进程超时字段中指定的限制时,PhpStorm 建议将该文件添加到忽略列表中

  1. 设置/首选项对话框 ( Ctrl+Alt+S) 中,导航到PHP | 质量工具

  2. 在打开的质量工具页面上,展开PHPStan区域并单击显示忽略的文件链接。

    • 要添加文件,请单击添加按钮并在打开的对话框中找到所需的文件。

    • 要从列表中删除文件并让 PHPStan 再次处理它,请选择该文件并单击删除按钮

    • 要从列表中删除所有文件,请单击关闭按钮

最后修改时间:2021 年 11 月 22 日