IntelliJ IDEA 2018.2 Help

Mess Detector

On this page:

Mess Detector Page

File | Settings | Languages and Frameworks | PHP | Mess Detector for Windows and Linux
IntelliJ IDEA | Preferences | Languages and Frameworks | Mess Detector for macOS


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 Managing Plugins.

On this page, choose the Mess Detector script to use.

Item Description
Configuration From this list, choose the script to use:
  • 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 dialog, choose By default project interpreter.
Ignored files This area displays a list of 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 delete a file from the list and have Mess Detector process it again, select the file and click the Remove file button icons general remove svg.
  • To remove all the files from the list, click the Clean the list button icons actions close svg.

Mess Detector Dialog

The dialog opens when you click browseButton next to the Configuration list on the Mess Detector page.

Use this dialog to configure local Mess Detector scripts, scripts associated with remote PHP interpreters, see PHP Mess Detector, and configure Mess Detector's behaviour.

The left-hand pane of the dialog shows all the configured Mess Detector scripts, one of them is of the type Local, and others are named after the remote PHP interpreters with which the scripts are associated. When you select a configuration, the right-hand pane shows its details.

  • To configure or edit the Local script, select Local and specify the location of phpmd.bat or phpmd in the PHP Mess Detector path field.
  • To configure a new script associated with a remote PHP interpreter:
    1. Click icons general add svg on the toolbar.
    2. In the Mess Detector by Remote Interpreter dialog that opens, choose the remote PHP interpreter to use the associated script from. If the list does not contain a relevant interpreter, click browseButton and configure a remote interpreter in the CLI Interpreters dialog as described in Configuring Remote PHP Interpreters.

      When you click OK, IntelliJ IDEA brings you back to the Mess Detector dialog where the new Mess Detector configuration is added to the list and the right-hand pane shows the chosen remote PHP interpreter, the path to the Mess Detector associated with it, and the advanced Mess Detector options.

ItemDescription
PHP Mess Detector (phpmd) Path In this text box, specify the location of the Mess Detector utility phpmd or phpmd.bat.
  • 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.
  • If you've installed Mess Detector using PEAR, you can locate the binaries installation directory by running the following command at the command prompt:

    pear config-get bin_dir

In either case, type the path manually or click Browse browseButton 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 text box, 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 right in the code: Too many PHP Mess Detector messages and suggest adding the file to the Ignored files list.
Tool process timeout In this text box, specify how long you want IntelliJ IDEA to wait for a result from PHP Mess Detector, whereupon the process is killed to prevent excessive CPU and memory usage. This gives you the capability to fine tune the PHP Mess Detector process behavior depending on the configuration of your computer and the rule sets used.
Last modified: 4 September 2018

See Also