PHP_CodeSniffer

Configuration

Select the required interpreter from the list. The list contains all the currently configured local and remote PHP interpreters. For more information, refer to Configure local PHP interpreters and Configure remote PHP interpreters.

Clicking to the right of the drop-down list opens PHP_CodeSniffer Dialog.

Show ignored files

Click to open the PHP_CodeSniffer Ignored Files dialog, which lists the files that PHP_CodeSniffer skips. PhpStorm 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, PhpStorm 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 .

Check files with extensions

Provide a comma-separated list of file extensions that should be checked by PHP_CodeSniffer.

Show warnings as...

To have PHP_CodeSniffer report warnings in addition to errors, select the checkbox and choose the severity degree from the list. Clear the checkbox to have only errors reported and suppress reporting warnings.

Show sniff name

Select the checkbox to have the corresponding sniff's name displayed in the editor or the inspection results in addition to the inspection summary.

Installed standard paths

If you are relying on a custom third-party coding standard (for example, Coder or Joomla Coding Standards), you need to integrate it with PHP_CodeSniffer prior to using it. To do this, select the Installed standard paths checkbox, click and select the custom standard installation directory in the dialog that opens.

Coding standard

Appoint the coding standard to apply.

• To use one of the predefined coding standards, select it in the Coding standard list, appoint the coding style to check your code against. The list contains all the coding standards installed inside the main php_codesniffer directory structure.

• To have your code checked against your own previously defined coding standard, choose Custom from the list and provide the path to the ruleset.xml file with your own coding standard. Type the path manually or click and select the relevant folder in the dialog that opens.

Run mode

Configure how often PHP_CodeSniffer is triggered to analyze code:

• On the fly – PHP_CodeSniffer runs automatically in the background. Issues are highlighted in the editor as you type.

• On idle – PHP_CodeSniffer runs after you stop typing and the inactivity period specified in the Idle threshold (ms) field passes.

• On save – PHP_CodeSniffer is triggered only when the file is saved either manually or via PhpStorm's autosave. Issue highlighting is updated only when the file state is persisted to disk.

Idle threshold (ms)

Define the delay time in milliseconds after code modification before PHP_CodeSniffer runs.

Minimum interval (ms)

Define the minimum time in milliseconds that must pass between two consecutive runs of PHP_CodeSniffer on the same file. This prevents PHP_CodeSniffer from running too frequently in case of frequent file savings or heavy typing.