File | Settings | Languages and Frameworks | PHP | Quality Tools for Windows and Linux IntelliJ IDEA | Preferences | Languages and Frameworks | PHP | Quality Tools for macOS Ctrl+Alt+S
The page is available only when the PHP plugin is enabled. The plugin is not bundled with IntelliJ IDEA, but it can be installed from the JetBrains plugin repository as described in Manage plugins.
PHP_CodeSniffer
In this section, choose the PHP_CodeSniffer script to use.
Item
Description
Configuration
Choose the PHP_CodeSniffer script:
To use the script associated with a specific remote PHP interpreter, choose the name of this interpreter.
To use a local script, choose Local. In this case the local PHP_CodeSniffer will be executed no matter which PHP interpreter - local or remote - is used in the project. Note that there can be only one Local configuration for PHP_CodeSniffer because IntelliJ IDEA runs a script (phpcs.bat for Windows or phpcs for Linux and macOS) that contains a path to a PHP engine.
To use the script associated with the default project interpreter, that is, the one chosen on the PHP page of the Settings/Preferences dialog, choose By default project interpreter.
Ignored files
Click to open the PHP_CodeSniffer ignored files dialog, which lists the files that PHP_CodeSniffer skips. IntelliJ IDEA suggests adding a new file to the list during inspection when waiting for response from the PHP_CodeSniffer exceeds the limit specified in the Tool process timeout field. This is done to prevent slowing down processing. For each file, IntelliJ IDEA displays its name and location.
To add a file, click and locate the desired file in the dialog that opens.
To delete a file from the list and have PHP_CodeSniffer process it again, select the file and click the Remove file button .
To remove all the files from the list, click .
PHP_CodeSniffer Dialog
The dialog opens when you click next to the Configuration list on the PHP_CodeSniffer page.
Use this dialog to configure local PHP_CodeSniffer scripts or scripts associated with remote PHP interpreters as well as configure PHP_CodeSniffer's behaviour. See PHP_CodeSniffer for details.
Item
Description
PHP_CodeSniffer (phpcs) Path
In this field, specify the location of the PHP_CodeSniffer script: phpcs.bat for Windows or phpcs for Linux and macOS.
If the script is associated with a PHP interpreter, IntelliJ IDEA detects the path to it and fills in the field automatically, but you can edit it if necessary. Type the path manually or click and select the path in the dialog that opens.
To check that the specified path to phpcs.bat or phpcs ensures interaction between IntelliJ IDEA and PHP_CodeSniffer, that is, the tool can be launched from IntelliJ IDEA and IntelliJ IDEA will receive problem reports from it, click the Validate button. This validation is equal to running the phpcs --version command. If validation passes successfully, IntelliJ IDEA displays the information on the detected PHP_CodeSniffer version.
Interpreter
The field shows the chosen PHP interpreter to use the PHP_CodeSniffer from.
Maximum number of messages per file
In this field, set the upper limit for the total number of messages to be reported for a file. All the messages above this limit will be rejected. IntelliJ IDEA will display the following warning in the code: Too many PHP_CodeSniffer messages and suggest adding the file to the Ignored files list.
Tool process timeout
In this field, specify how long you want IntelliJ IDEA to wait for a result from PHP_CodeSniffer. If the timeout is exceeded, the process is killed to prevent excessive CPU and memory usage. This lets you fine tune the PHP_CodeSniffer process behavior depending on the configuration of your computer and the rule sets used.
PHP Code Beautifier and Fixer Settings
In this area, provide the path to the PHP Code Beautifier and Fixer tool in the Path to phpcbf field. Type the path manually or click and select the path in the dialog that opens.
PHP Mess Detector
In this section, choose the Mess Detector script to use.
Item
Description
Configuration
Choose the Mess Detector script:
To use the script associated with a specific remote PHP interpreter, choose the name of this interpreter.
To use a local script, choose Local. In this case the local Mess Detector will be executed no matter which PHP interpreter - local or remote - is used in the project. Note that there can be only one Local configuration for Mess Detector because IntelliJ IDEA runs a script (phpmd.bat for Windows or phpmd for Linux and macOS) that contains a path to a PHP engine.
To use the script associated with the default project interpreter, that is, the one chosen on the PHP page of the Settings/Preferences dialog, choose By default project interpreter.
Ignored files
Click to open the Mess Detector ignored files dialog, which lists the files that Mess Detector skips. IntelliJ IDEA suggests adding a new file to the list during inspection when waiting for response from the Mess Detector exceeds the limit specified in the Tool process timeout field. This is done to prevent slowing down processing. For each file, IntelliJ IDEA displays its name and location.
To add a file, click and locate the desired file in the dialog that opens.
To delete a file from the list and have Mess Detector process it again, select the file and click the Remove file button .
To remove all the files from the list, click .
Mess Detector Dialog
The dialog opens when you click next to the Configuration list on the Mess Detector page.
Use this dialog to configure local Mess Detector scripts or scripts associated with remote PHP interpreters as well as configure Mess Detector's behaviour. See PHP Mess Detector for details.
Item
Description
Mess Detector (phpmd) Path
In this field, specify the location of the Mess Detector script: phpmd.bat for Windows or phpmd for Linux and macOS.
If the script is associated with a PHP interpreter, IntelliJ IDEA detects the path to it and fills in the field automatically, but you can edit it if necessary. Type the path manually or click and select the path in the dialog that opens.
To check that the specified path to phpmd.bat or phpmd ensures interaction between IntelliJ IDEA and Mess Detector, that is, the tool can be launched from IntelliJ IDEA and IntelliJ IDEA will receive problem reports from it, click the Validate button. This validation is equal to running the phpmd --version command. If validation passes successfully, IntelliJ IDEA displays the information on the detected Mess Detector version.
Interpreter
The field shows the chosen PHP interpreter to use the Mess Detector from.
Maximum number of messages per file
In this field, set the upper limit for the total number of messages to be reported for a file. All the messages above this limit will be rejected. IntelliJ IDEA will display the following warning in the code: Too many Mess Detector messages and suggest adding the file to the Ignored files list.
Tool process timeout
In this field, specify how long you want IntelliJ IDEA to wait for a result from Mess Detector. If the timeout is exceeded, the process is killed to prevent excessive CPU and memory usage. This lets you fine tune the Mess Detector process behavior depending on the configuration of your computer and the rule sets used.
PHP CS Fixer
In this section, choose the PHP CS Fixer script to use.
Item
Description
Configuration
Choose the PHP CS Fixer script:
To use the script associated with a specific remote PHP interpreter, choose the name of this interpreter.
To use a local script, choose Local. In this case the local PHP CS Fixer will be executed no matter which PHP interpreter - local or remote - is used in the project. Note that there can be only one Local configuration for PHP CS Fixer because IntelliJ IDEA runs a script (php-cs-fixer.bat for Windows or php-cs-fixer for Linux and macOS) that contains a path to a PHP engine.
To use the script associated with the default project interpreter, that is, the one chosen on the PHP page of the Settings/Preferences dialog, choose By default project interpreter.
Ignored files
Click to open the PHP CS Fixer ignored files dialog, which lists the files that PHP CS Fixer skips. IntelliJ IDEA suggests adding a new file to the list during inspection when waiting for response from the PHP CS Fixer exceeds the limit specified in the Tool process timeout field. This is done to prevent slowing down processing. For each file, IntelliJ IDEA displays its name and location.
To add a file, click and locate the desired file in the dialog that opens.
To delete a file from the list and have PHP CS Fixer process it again, select the file and click the Remove file button .
To remove all the files from the list, click .
PHP CS Fixer Dialog
The dialog opens when you click next to the Configuration list on the PHP CS Fixer page.
Use this dialog to configure local PHP CS Fixer scripts or scripts associated with remote PHP interpreters as well as configure PHP CS Fixer's behaviour. See PHP CS Fixer for details.
Item
Description
PHP CS Fixer (php-cs-fixer) Path
In this field, specify the location of the PHP CS Fixer script: php-cs-fixer.bat for Windows or php-cs-fixer for Linux and macOS.
If the script is associated with a PHP interpreter, IntelliJ IDEA detects the path to it and fills in the field automatically, but you can edit it if necessary. Type the path manually or click and select the path in the dialog that opens.
To check that the specified path to php-cs-fixer.bat or php-cs-fixer ensures interaction between IntelliJ IDEA and PHP CS Fixer, that is, the tool can be launched from IntelliJ IDEA and IntelliJ IDEA will receive problem reports from it, click the Validate button. This validation is equal to running the php-cs-fixer --version command. If validation passes successfully, IntelliJ IDEA displays the information on the detected PHP CS Fixer version.
Interpreter
The field shows the chosen PHP interpreter to use the PHP CS Fixer from.
Maximum number of messages per file
In this field, set the upper limit for the total number of messages to be reported for a file. All the messages above this limit will be rejected. IntelliJ IDEA will display the following warning in the code: Too many PHP CS Fixer messages and suggest adding the file to the Ignored files list.
Tool process timeout
In this field, specify how long you want IntelliJ IDEA to wait for a result from PHP CS Fixer. If the timeout is exceeded, the process is killed to prevent excessive CPU and memory usage. This lets you fine tune the PHP CS Fixer process behavior depending on the configuration of your computer and the rule sets used.