Composer 依赖管理器

当您创建一个新的 Composer 项目时，PhpStorm 基于您选择的 Composer 包创建一个项目，解析依赖项并将它们安装在项目的供应商目录下。

1. 选择文件 | 新建项目或单击PhpStorm 欢迎屏幕上的 创建新项目。

   新建项目对话框打开：

   

2. 在对话框中，指定项目的参数：

   • 选择项目类型和位置：

     • 在左侧窗格中，选择Composer Project。

     • 在右侧窗格的位置字段中，指定将在其中创建项目的文件夹。

   • 选择 Composer 命令的执行方式：

     • 要通过全局安装的composer可执行文件运行命令，请选择“composer”可执行文件并在字段中指定其位置。

     • 要通过本地composer.phar存档运行命令，请选择composer.phar。然后，在字段中指定现有composer.phar文件的位置，或者选择从 getcomposer.org 下载 composer.phar复选框以下载该文件的新实例。下载的composer.phar文件将保存在项目根文件夹下。

       然后，从PHP 解释器列表中选择一个已配置的本地 PHP 解释器。有关详细信息，请参阅配置本地 PHP 解释器。

     或者，在命令行参数字段中，键入其他命令行参数。

   • 在包区域中，在包字段中键入所需包的名称。要使用代码完成，请按Ctrl+Space。然后从要安装的版本列表中选择相关版本。

3. 单击创建。将使用选定的包调用create-project Composer 命令。结果，将创建 Composer 项目，其配置和结构取决于所选包。之后，创建的 PhpStorm 项目将打开。

在项目中初始化 Composer 时，会创建composer.json。该文件列出了项目依赖项和其他元数据，并自动设置为项目默认值。

1. 从主菜单中，选择工具 | 作曲家 | 初始化作曲家。

   Composer 设置对话框打开：

   

2. 选择 Composer 命令的执行方式：

   • 要通过全局安装的composer可执行文件运行命令，请选择“composer”可执行文件并在字段中指定其位置。

   • 要通过本地composer.phar存档运行命令，请选择composer.phar。然后，在字段中指定现有composer.phar文件的位置，或者选择从 getcomposer.org 下载 composer.phar复选框以下载该文件的新实例。下载的composer.phar文件将保存在项目根文件夹下。

     然后，从PHP 解释器列表中选择一个已配置的本地 PHP 解释器。有关详细信息，请参阅配置本地 PHP 解释器。

   • 要通过远程解释器运行命令，请选择远程解释器。

     • 从CLI 解释器列表中，选择要使用的远程解释器，或者单击并配置一个新的解释器，如配置远程 PHP 解释器中所述。

       在大多数情况下，PhpStorm 会自动检测路径映射。如有必要，您可以单击路径映射字段并在打开的编辑项目路径映射中手动指定它们。

     • 在Composer 可执行文件字段中，提供 Composer 可执行文件的名称。您可以单击，然后在打开的“选择服务器上的路径”对话框中找到可执行文件。

3. 单击确定关闭Composer 设置对话框。PhpStorm 创建一个composer.json存根文件并在编辑器中打开它：

   

   完成代码或接受生成的值。有关使用 composer.json 文件的详细信息，请参阅Composer.json：项目设置。

当您打开现有的 Composer 项目时，PhpStorm 使用 composer.json 文件中包含的信息来自动应用某些配置选项，例如项目的内容根目录和PHP 语言级别。

1. 在欢迎屏幕上单击打开或选择文件 | 从主菜单打开，然后选择存储 Composer 项目的文件夹。

   PhpStorm 将显示一个通知：

   

2. 单击初始化 Composer 设置。在打开的Composer对话框中，指定composer.json文件的位置。如果 PhpStorm 检测到现有文件，则composer.json 的路径字段将自动填充：

   

3. 配置项目设置：

   • 默认情况下，vendor/*/*目录下的所有包都从项目中排除并添加为写保护库。要保护它们不被编辑，请选中将包添加为库复选框。否则，如果您想在 vendor/*/*下编辑 Composer 包，请清除将包添加为库复选框。

   • 确保选中Synchronize IDE Settings with composer.json复选框以自动检测 PHP 语言级别并根据composer.json的配置配置项目源和测试根。

     PhpStorm 知道 PSR-0/PSR-4 源根及其命名空间前缀。它根据部分设置 Source 根，并根据autoload部分设置 Tests 根。PhpStorm 还根据该部分中的设置检测 PHP 语言级别。autoload-devphprequire

     由于composer.json包含有关项目配置的最新信息，因此这种自动同步可确保 Source 和 Test 文件夹与项目结构完全匹配，并自动设置正确的 PHP 语言级别。

     要了解更多关于 PSR 和自动加载的信息，请参阅Composer 官网。有关同步设置的示例和详细信息，请参阅PhpStorm 博客文章。要了解有关配置内容根的更多信息，请参阅内容根。

   • 为了在 composer.json 中检索可用的包更新并提供更好的编码帮助，每次打开项目或修改composer.json时，PhpStorm 都会在后台运行update --dry-run命令。如有必要，您可以通过清除Check for available package updates复选框来禁用运行该命令。

   单击确定以应用指定的项目设置并关闭对话框。

4. 设置 Composer 命令执行：

   • 执行以下操作之一：

     • 在设置/首选项对话框 ( Ctrl+Alt+S) 中，转到PHP | 作曲家。

     • 如果您的项目中有一个composer.json文件，请选择工具 | 作曲家 | 从主菜单安装以打开Composer 设置对话框。

   • 选择 Composer 命令的执行方式：

     • 要通过全局安装的composer可执行文件运行命令，请选择“composer”可执行文件并在字段中指定其位置。

     • 要通过本地composer.phar存档运行命令，请选择composer.phar。然后，在字段中指定现有composer.phar文件的位置，或者选择从 getcomposer.org 下载 composer.phar复选框以下载该文件的新实例。下载的composer.phar文件将保存在项目根文件夹下。

       然后，从PHP 解释器列表中选择一个已配置的本地 PHP 解释器。有关详细信息，请参阅配置本地 PHP 解释器。

     • 要通过远程解释器运行命令，请选择远程解释器。

       • 从CLI 解释器列表中，选择要使用的远程解释器，或者单击并配置一个新的解释器，如配置远程 PHP 解释器中所述。

         在大多数情况下，PhpStorm 会自动检测路径映射。如有必要，您可以单击路径映射字段并在打开的编辑项目路径映射中手动指定它们。

       • 在Composer 可执行文件字段中，提供 Composer 可执行文件的名称。您可以单击，然后在打开的“选择服务器上的路径”对话框中找到可执行文件。

5. 安装项目依赖：

   • 如果您的项目中有一个composer.json文件，请选择工具 | 作曲家 | 从主菜单安装。

   • 否则，如果您有多个composer.json文件，请选择Composer | 从相关的上下文菜单安装。另请参阅在 PhpStorm 项目中指定默认 composer.json。

   您也可以在编辑器中打开composer.json文件，然后单击编辑器面板顶部的安装快捷方式链接。

您可以在一个 PhpStorm 项目中拥有多个composer.json文件。对于每个composer.json，操作是从其在编辑器或项目视图中的上下文菜单中调用的，或者使用编辑器面板顶部的快捷链接。您还可以为您的 PhpStorm 项目指定默认的 composer.json。它的 Composer 动作是从Tools |调用的。作曲家主菜单项。

1. 在设置/首选项对话框 ( Ctrl+Alt+S) 中，转到PHP | 作曲家。

2. 指定默认composer.json的位置。如果您的 PhpStorm 项目中有一个 Composer 配置文件，则composer.json 的路径字段会自动填充。

3. 默认情况下，vendor/*/*目录下的所有包都从项目中排除并添加为写保护库。要保护它们不被编辑，请选中将包添加为库复选框。

   否则，如果您想在vendor/*/*下编辑 Composer 包，请清除将包添加为库复选框。

4. 确保选中Synchronize IDE settings with composer.json复选框以自动检测 PHP 语言级别并根据composer.json的配置配置项目源和测试根。

   PhpStorm 知道 PSR-0/PSR-4 源根及其命名空间前缀。它根据部分设置 Source 根，并根据autoload部分设置 Tests 根。PhpStorm 还根据该部分中的设置检测 PHP 语言级别。autoload-devphprequire

   由于composer.json包含有关项目配置的最新信息，因此这种自动同步可确保 Source 和 Test 文件夹与项目结构完全匹配，并自动设置正确的 PHP 语言级别。

   要了解更多关于 PSR 和自动加载的信息，请参阅Composer 官网。有关同步设置的示例和详细信息，请参阅PhpStorm 博客文章。要了解有关配置内容根的更多信息，请参阅内容根。