PHPStan

tip

Before you start, make sure Composer is installed on your machine and initialized in the current project as described in Composer dependency manager.

When you install PHPStan with Composer, PhpStorm automatically downloads the necessary scripts, registers them in the IDE, and, optionally, enables and configures the corresponding code inspection.

1. Inside composer.json, add the phpstan/phpstan dependency record to the require or require-dev key. Press CtrlSpace to get code completion for the package name and version.

2. Do one of the following:

   • Click the Install shortcut link on top of the editor panel.

   • If the Non-installed Composer packages inspection is enabled, PhpStorm will highlight the declared dependencies that are not currently installed. Press AltEnter and select whether you want to install a specific dependency or all dependencies at once.

Click next to the package record in the composer.json editor gutter to jump to the corresponding Settings page and configure PHPStan manually.

After PHPStan is initially configured, further modifications in composer.json will not affect the inspection configuration. To apply newer changes, reset the PHPStan configuration.

1. In the Settings dialog (CtrlAlt0S), navigate to PHP | Quality Tools.

2. On the Quality Tools page that opens, expand the PHPStan area and click next to the Configuration list.

3. In the PHPStan dialog that opens, empty the PHPStan path field.

   

4. Update the project Composer dependencies by clicking Update on top of the composer.json editor panel. For more information, refer to Update dependencies.

PhpStorm will perform the PHPStan configuration anew and thus apply the changes in composer.json.

When you install PHPStan with Composer, PhpStorm automatically detects PHPStan's executable file in the vendor/bin folder and sets the PHP interpreter configured in the system path to run it.

In Settings (CtrlAlt0S) | PHP | Quality Tools | PHPStan, you can change the default PHP interpreter, set the path to a manually downloaded and installed PHPStan executable file, or add some options to be passed to PHPStan when running it in PhpStorm.

• Configuration: in this field, you can change the default PHP interpreter and path to the PHPStan executable file.

  1. To only change the interpreter, select the required item from the list of local and remote PHP interpreters configured in your project.

     tip

     The PHPStan executable file (phpstan.bat for Windows or phpstan for Linux and macOS) contains a path to a PHP engine in it. PhpStorm lets you overwrite this path and use the PHP interpreter of your choice.

     note

     Learn more about configuring PHP interpreters in Configure remote PHP interpreters or in Configure local PHP interpreters.

  2. To change the path to the PHPStan executable file, or both the interpreter and the path, click next to the Configuration list to open the PHPStan dialog and edit the fields there as described on the PHPStan Dialog reference page.

• Show ignored files: use this setting to exclude files from PHPStan validation inspection. For more information, refer to the Quality Tools reference page.

• Options: in this area, add the PHPStan command options to run PHPStan as a PhpStorm inspection with. Edit the fields there as described on the PHPStan reference page.

You can include the information on the PHPStan configuration file inside the scripts section of composer.json. When you install or update project dependencies, the specified configuration file will be detected and the PHPStan validation inspection will be enabled automatically.

If no configuration file is specified in the scripts section of composer.json, PhpStorm will additionally check the project root to locate the ruleset with the phpstan.neon or phpstan.neon.dist default name.

• In the scripts section of composer.json, add the phpstan PHPStan launch command into one of the leaf elements.

  Provide the -c argument and the path to the configuration file:

  "scripts": {
      "phpstan": "vendor/bin/phpstan -c phpstan.neon"
  }

note

After PHPStan is initially configured, further modifications in composer.json will not affect the inspection configuration. To apply newer changes, reset the PHPStan configuration on the PHP |Quality Tools page of the Settings dialog (CtrlAlt0S) and update project dependencies.

1. In the Settings dialog (CtrlAlt0S), click Inspections under Editor.

2. On the Inspections page that opens, expand the PHP | Quality Tools node and select the checkbox next to PHPStan validation.

   

   tip

   If you have installed PHPStan with Composer but the corresponding inspection is currently disabled, PhpStorm highlights its record in composer.json. Press AltEnter and use the provided Enable inspection quick-fix to enable the inspection and open the Inspections page.

   

3. On the right-hand pane of the Inspections page, configure how PhpStorm should handle the PHPStan inspection output:

   • Scope: choose the scope to limit the inspection application to.

   • Severity: choose the severity degree for the inspection. The selected value determines how seriously the detected discrepancies will be treated by PhpStorm and presented in the inspection results.

   • Highlighting in editor: choose how the issues detected by the inspection are highlighted in the editor.

note

You can also enable and disable the validation inspection in the Settings dialog (CtrlAlt0S) | PHP | Quality Tools by using the ON/OFF toggle in the section, but note that this action is applied only to the Project Default inspection profile.

1. Go to Code | Inspect code.

2. In the Specify Inspection Scope dialog that opens, select the inspection profile from the list, or click Configure to open the Inspections dialog and configure a new profile.

   You can also click Configure to check which fixes will be applied within the scope of the selected inspection profile, and make sure that the PHPStan validation inspection is enabled.

3. View the inspection results in the Problems tool window. Errors and warnings reported by PHPStan are prefixed with phpstan:: to distinguish them from PhpStorm internal inspections.

   

1. In the Settings dialog (CtrlAlt0S), navigate to PHP | Quality Tools.

2. On the Quality Tools page that opens, expand the PHPStan area and click the Show ignored files link.

   • To add a file, click and locate the desired file in the dialog that opens.

   • To delete a file from the list and have PHPStan process it again, select the file and click .

   • To remove all the files from the list, click .