Composer

Path to composer.json

In this field, specify the location of the composer.json that you want to use as the project's default Composer file. All the Composer commands invoked from Tools | Composer from the main menu will be executed in accordance with the settings from this configuration file.

You can have several composer.json files in one PhpStorm project, and invoke Composer actions and commands for each of them.

If a project contains subdirectories with dedicated composer.json files, PhpStorm handles Composer-managed dependencies and settings for each of such modules independently. Every subdirectory with composer.json installed in it will have its own PSR-0/PSR-4 roots settings, configurations for test frameworks, and a vendor directory with External Libraries.

Add packages as libraries

Use this checkbox to configure the open-for-edit status of Composer packages. To protect packages under vendor/*/* against editing, leave the checkbox selected (this is the default setting).

If you want to edit the Composer packages under vendor/*/*, clear the checkbox.

Synchronize IDE Settings with composer.json

Select this checkbox to automatically detect the PHP language level and configure project Source and Test roots based on the configuration from composer.json.

PhpStorm is aware of PSR-0/PSR-4 source roots and their namespace prefixes. It sets the Source root based on the autoload section, and the Tests root based on the autoload-dev section. PhpStorm also detects the PHP language level based on the php setting in the require section.

Because composer.json contains the most up-to-date information about the project configuration, this automatic synchronization ensures that the Source and Test folders exactly match the project structure, and the correct PHP language level is set automatically.

tip

For more information about PSR and autoloading, refer to the Composer official website. For examples and details on synchronizing settings, refer to the PhpStorm blog post. For more information about configuring content roots, refer to Content root.

note

When settings synchronization with composer.json is enabled, PHP language level cannot be set manually on the PHP page of the Settings dialog (CtrlAlt0S) or in the PhpStorm status bar.

Check for available package updates

Use this checkbox to configure automatic checks for available package updates. By default, the checkbox is selected. To retrieve the available package updates and provide better coding assistance in composer.json, PhpStorm runs the update --dry-run command in the background every time you open a project or modify composer.json.

Show composer.json top panel with quick actions

Use this checkbox to toggle the visibility of the quick actions panel displayed on top of the composer.json editor. For more information, refer to Work with composer.json.

Notify about missing 'vendor' directory

Select this checkbox to have PhpStorm check whether the vendor directory is missing and display the corresponding notification every time you open a project or modify composer.json. You can use the shortcut link in the notification to quickly install Composer dependencies.

Run install/update with ‑‑ignore‑platform‑reqs

Select this checkbox to have PhpStorm run Composer's install and update commands with the --ignore-platform-reqs option.

This will ignore all platform requirements (php, hhvm, lib-*, and ext-*) specified in the composer.json file and force installation/update of other dependencies regardless of the platform packages available in your PhpStorm project.

Execution

In this area, choose how the Composer commands will be executed:

• To run commands via a globally installed composer executable, choose 'composer' executable and specify its location in the field.

• To run commands via the local composer.phar archive, choose composer.phar. Then, either specify the location of the existing composer.phar file in the field or select the Download composer.phar from getcomposer.org checkbox to download a new instance of the file. The downloaded composer.phar file will be saved under the project root folder.

  Then, choose one of the configured local PHP interpreters from the PHP interpreter list. For more information, refer to Configure local PHP interpreters.

• To run commands via a remote interpreter, choose Remote interpreter.

  • From the CLI Interpreter list, select a remote interpreter to use, or click and configure a new one as described in Configure remote PHP interpreters.

    In most cases, PhpStorm detects path mappings automatically. If necessary, you can click in the Path mappings field and specify them manually in the Edit Project Path Mappings that opens.

  • In the Composer executable field, provide the name of the Composer executable. You can click , and locate the executable in the Select Path On The Server dialog that opens.

  note

  If you rely on Docker, you can use the composer Official Docker image, which is preconfigured as a remote interpreter in PhpStorm out of the box. This image is not intended for production use. If necessary, you can create and manage your own Docker images in PhpStorm as described in Docker images.