Skip to main content

PHPMD - PHP Mess Detector

https://github.com/phpmd/phpmd

What PHPMD does is: It takes a given PHP source code base and look for several potential problems within that source. These problems can be things like:

  • Possible bugs
  • Suboptimal code
  • Overcomplicated expressions
  • Unused parameters, methods, properties

Vortex comes with pre-configured PHPMD ruleset for Drupal projects.

Usage​

vendor/bin/phpmd . text phpmd.xml

or

ahoy lint-be

Configuration​

See configuration reference.

All global configuration takes place in the phpmd.xml file.

Targets include custom modules and themes, settings and tests.

Adding targets is not supported via configuration file. Instead, use the exclusion patterns to exclude files and directories.

<exclude-pattern>*\/dir\/another\/*\.php</exclude-pattern>

Ignoring​

Ignoring rules globally takes place in the phpmd.xml file:

<rule ref="rulesets/cleancode.xml/MissingImport">
    <properties>
        <property name="ignore-global" value="true"/>
    </properties>
</rule>

PHPMD does not support ignoring of all PHPMD rules within a file.

PHPMD does not support ignoring of a specific rule within a file.

PHPMD does not support ignoring of the code blocks.

PHPMD does not support ignoring the current and the next line.

PHPMD supports ignoring rules for methods or classes.

/**
 * This will suppress all the PMD warnings in
 * this class.
 *
 * @SuppressWarnings(PHPMD)
 */
class Bar {
    function  foo() {
        $baz = 23;
    }
}

class Bar {
  /**
   * This will suppress UnusedLocalVariable
   * warnings in this method
   *
   * @SuppressWarnings(PHPMD.UnusedLocalVariable)
   */
  public function foo() {
      $baz = 42;
  }
}

Ignoring fail in CI​

This tool runs in CI by default and fails the build if there are any violations.

Set VORTEX_CI_PHPMD_IGNORE_FAILURE environment variable to 1 to ignore failures. The tool will still run and report violations, if any.