phpmd.xml

<?xml version="1.0"?>
<ruleset name="PHPMD rule set"
         xmlns="http://pmd.sf.net/ruleset/1.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://pmd.sf.net/ruleset/1.0.0
                     http://pmd.sf.net/ruleset_xml_schema.xsd"
         xsi:noNamespaceSchemaLocation="
                     http://pmd.sf.net/ruleset_xml_schema.xsd">
    <description>
        The rules set that checks code quality of the current project
    </description>

    <!-- A boolean flag argument is a reliable indicator for a violation of the Single Responsibility Principle -->
    <rule ref="rulesets/cleancode.xml/BooleanArgumentFlag" />

    <!--
        UnusedPrivateField
        UnusedPrivateMethod
        UnusedLocalVariable
        UnusedFormalParameter
    -->
    <rule ref="rulesets/unusedcode.xml" />

    <!--
        Superglobals
        CamelCaseClassName
        CamelCasePropertyName
        CamelCaseMethodName
        CamelCaseParameterName
        CamelCaseVariableName
    -->
    <rule ref="rulesets/controversial.xml" />

    <!--
        ExitExpression
        EvalExpression
        GotoStatement
        NumberOfChildren
        DepthOfInheritance
        CouplingBetweenObjects
        DevelopmentCodeFragment
    -->
    <rule ref="rulesets/design.xml" />

    <!-- Naming rules -->
    <rule ref="rulesets/naming.xml/ShortVariable" />
    <rule ref="rulesets/naming.xml/LongVariable">
        <properties>
            <property name="maximum" value="30" />
        </properties>
    </rule>
    <rule ref="rulesets/naming.xml/ShortMethodName" />
    <rule ref="rulesets/naming.xml/ConstructorWithNameAsEnclosingClass" />
    <rule ref="rulesets/naming.xml/ConstantNamingConventions" />
    <rule ref="rulesets/naming.xml/BooleanGetMethodName" />

    <!-- Code size rules -->
    <rule ref="rulesets/codesize.xml/CyclomaticComplexity">
        <properties>
            <property name="reportLevel" value="5" />
        </properties>
    </rule>
    <rule ref="rulesets/codesize.xml/ExcessiveClassComplexity">
        <properties>
            <property name="maximum" value="50" />
        </properties>
    </rule>
    <rule ref="rulesets/codesize.xml/NPathComplexity">
        <properties>
            <property name="minimum" value="50" />
        </properties>
    </rule>
    <rule ref="rulesets/codesize.xml/ExcessiveMethodLength">
        <properties>
            <property name="minimum" value="40" />
            <property name="ignore-whitespace" value="true" />
        </properties>
    </rule>
    <rule ref="rulesets/codesize.xml/ExcessiveClassLength">
        <properties>
            <property name="minimum" value="500" />
            <property name="ignore-whitespace" value="true" />
        </properties>
    </rule>
    <rule ref="rulesets/codesize.xml/ExcessiveParameterList">
        <properties>
            <property name="minimum" value="4" />
        </properties>
    </rule>
    <rule ref="rulesets/codesize.xml/TooManyFields">
        <properties>
            <property name="maxfields" value="15" />
        </properties>
    </rule>
    <rule ref="rulesets/codesize.xml/TooManyPublicMethods">
        <properties>
            <property name="maxmethods" value="10" />
        </properties>
    </rule>
</ruleset>