phpmd.xml

<?xml version="1.0"?>
<ruleset name="AgelxNash phpmd ruleset"
         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>
        https://gist.github.com/slayerfat/2b3cc4faf94d2863b505
        Inspired by https://github.com/phpmd/phpmd/issues/137
        using http://phpmd.org/documentation/creating-a-ruleset.html
    </description>

    <rule ref="rulesets/cleancode.xml">
        <exclude name="StaticAccess" />
        <exclude name="BooleanArgumentFlag" />
        <exclude name="ElseExpression" />
    </rule>

    <rule ref="rulesets/codesize.xml">
        <exclude name="TooManyPublicMethods" />
        <exclude name="TooManyPublicMethods" />
        <exclude name="ExcessiveMethodLength" />
        <exclude name="ExcessivePublicCount" />
    </rule>
    <rule ref="rulesets/codesize.xml/ExcessiveMethodLength">
        <properties>
            <property name="ignore-whitespace" value="true"/>
        </properties>
    </rule>
    <rule ref="rulesets/codesize.xml/ExcessivePublicCount">
        <properties>
            <property name="maxmethods" value="30"/>
            <property name="ignorepattern" value="(^(__call|__get|__destruct|__construct))i"/>
        </properties>
    </rule>

    <rule ref="rulesets/controversial.xml">
        <exclude name="CamelCaseMethodName"/>
        <exclude name="CamelCasePropertyName"/>
        <exclude name="CamelCaseVariableName"/>
        <exclude name="CamelCaseParameterName"/>
    </rule>

    <rule ref="rulesets/design.xml">
        <exclude name="CouplingBetweenObjects"/>
        <exclude name="ExitExpression" />
        <exclude name="EvalExpression" />
    </rule>
    <rule ref="rulesets/design.xml/CouplingBetweenObjects">
        <properties>
            <property name="minimum" value="25"/>
        </properties>
    </rule>

    <rule ref="rulesets/naming.xml">
        <exclude name="LongVariable" />
        <exclude name="ShortVariable" />
        <exclude name="ShortMethodName" />
    </rule>
    <rule ref="rulesets/naming.xml/LongVariable">
        <properties>
            <property name="maximum" value="30"/>
        </properties>
    </rule>
    <rule ref="rulesets/naming.xml/ShortVariable"
          since="0.2"
          message="Avoid variables with short names like {0}. Configured minimum length is {1}."
          class="PHPMD\Rule\Naming\ShortVariable"
          externalInfoUrl="http://phpmd.org/rules/naming.html#shortvariable">
        <priority>3</priority>
        <properties>
            <property name="minimum" description="Minimum length for a variable, property or parameter name" value="3"/>
            <property name="exceptions" value="id,ip,pk,i,j,e,k,n,q" />
        </properties>
    </rule>
    <rule ref="rulesets/naming.xml/ShortMethodName">
        <priority>1</priority>
        <properties>
            <property name="exceptions" value="id,ip,pk" />
        </properties>
    </rule>

    <rule ref="rulesets/unusedcode.xml">
        <exclude name="UnusedLocalVariable" />
        <exclude name="UnusedFormalParameter" />
    </rule>
    <rule ref="rulesets/unusedcode.xml/UnusedLocalVariable">
        <properties>
            <property name="allow-unused-foreach-variables" value="true"/>
        </properties>
    </rule>
</ruleset>