phpmd.xml

<?xml version="1.0" encoding="UTF-8"?>
<ruleset name="The GetCandy 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>This ruleset ensures that code follows expected quality requirements of GetCandy.</description>

    <rule ref="rulesets/cleancode.xml">
        <exclude name="StaticAccess" />
    </rule>
    <rule ref="rulesets/codesize.xml" />
    <rule ref="rulesets/controversial.xml" />
    <rule ref="rulesets/design.xml" />
    <rule ref="rulesets/naming.xml">
        <!-- some framework variables such as $to will trigger this, so the rule is excluded here and then manually specified below -->
        <exclude name="ShortVariable" />
        <!-- We want to increase this from the default 20, so exclude here and reinclude later on -->
        <exclude name="LongVariable"/>
        <!-- some framework variables such as up() will trigger this, so the rule is excluded here and then manually specified below -->
        <exclude name="ShortMethodName" />
    </rule>
    <rule ref="rulesets/unusedcode.xml">
        <!-- some framework variables such as $request and $notifiable will trigger this -->
        <exclude name="UnusedFormalParameter" />
    </rule>

    <rule ref="rulesets/naming.xml/ShortVariable">
        <properties>
            <property name="exceptions" value="to,e,I,id" />
        </properties>
    </rule>
    <rule ref="rulesets/naming.xml/LongVariable">
        <properties>
            <property name="maximum" value="27" />
        </properties>
    </rule>
    <rule ref="rulesets/naming.xml/ShortMethodName">
        <properties>
            <property name="exceptions" value="up" />
        </properties>
    </rule>
</ruleset>