phpstorm.md

IDE JetBrains PhpStorm

This document describing how you can configure your IDE PhpStorm.

Configuring PhpStorm

General

• Go to Settings -> Plugins and install next plugins:
  • .env files support
  • .ignore
  • Makefile Language
  • Php Inspections (EA Extended)
  • Laravel Idea
  • Rainbow brackets
  • String Manipulation
• Go to Settings -> Php -> Frameworks -> Laravel Idea and check settings for Laravel Idea plugin.
• If you want control quality of your PHP project - pay your attention to the tools, described here.

CLI Interpreter

You need to set correct CLI interpreter for your PhpStorm. In order to do it please open Settings -> PHP section and follow recommendations configuring remote PHP interpreters.

Composer

Go to Settings -> Php -> Composer and set path to composer.json, check other settings:

Server

In order to configure PHP servers please open Settings -> PHP -> Servers. You need to configure how your local files will be mapped inside docker container:

Test Frameworks

If you want to run tests directly from your IDE you need to do following configuration in Settings -> PHP -> Test Frameworks:

Next you need to add Run/Debug configuration for PHP Remote Debug. It needs to be the same as image below:

Debugging

In order to use Xdebug as debugging tool please follow Using Xdebug documentation.

Code Style

This environment has committed .idea/ catalog, so most IDE configs should be available out of the box. But if you want to have own configs, you can put ./idea in gitignore and delete folder from the git repository. Anyway you can always import our recommended code style if you don't have committed ./idea folder inside your repository:

• Go to Settings -> Editor -> Code Style -> PHP and import scheme Project (CodeStyle.xml) from docs/phpstorm:

PHP Inspections and code quality tools

• Go to Settings -> PHP -> Quality tools and configure next:

Note: make sure that you have proper local path for the PHP CS Fixer ruleset .php-cs-fixer.dist.php.

Note: make sure that you have proper local path for the MessDetector ruleset phpmd_ruleset.xml.

• If you don't have committed folder .idea/, go to Settings -> Editor -> Inspections and import profile Project Default (Inspections.xml) from docs/phpstorm:

• Go to Settings -> Tools -> External tools and create ecs tool:

Note: Arguments value should be exec-bash cmd="./vendor/bin/ecs --clear-cache check $FilePathRelativeToProjectRoot$".

Note: In order to use it - right click on the necessary file/folder in PhpStorm and select context menu External Tools -> ecs.

• Go to Settings -> Tools -> External tools and create phpcs tool:

Note: Arguments value should be exec-bash cmd="./vendor/bin/phpcs --version && ./vendor/bin/phpcs --standard=PSR12 --colors -p $FilePathRelativeToProjectRoot$".

Note: In order to use it - right click on the necessary file/folder in PhpStorm and select context menu External Tools -> phpcs.

For inspecting your code you can use main menu item Code -> Inspect Code. Code will be processed by code quality tools like PHP CS Fixer, PHP Mess Detector, PHP CodeSniffer, PHPStan.

External documentations

• Configuring Remote PHP Interpreters
• Test Frameworks
• Laravel Development using PhpStorm
• Laravel Plugin plugin for PhpStorm
• Php Inspections (EA Extended) plugin for PhpStorm
• Qodana code quality tool