phpmd.xml

<?xml version="1.0"?>

<!-- see https://phpmd.org/rules/index.html -->

<ruleset
    name="Claroline distribution 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>Code checks</description>

    <rule ref="rulesets/cleancode.xml/IfStatementAssignment">
        <priority>1</priority>
    </rule>
    <rule ref="rulesets/cleancode.xml/DuplicatedArrayKey">
        <priority>1</priority>
    </rule>
    <rule ref="rulesets/cleancode.xml/ErrorControlOperator">
        <priority>1</priority>
    </rule>
    <rule ref="rulesets/cleancode.xml/UndefinedVariable">
        <priority>1</priority>
    </rule>
    <rule ref="rulesets/unusedcode.xml/UnusedPrivateField">
        <priority>1</priority>
    </rule>
    <rule ref="rulesets/unusedcode.xml/UnusedPrivateMethod">
        <priority>1</priority>
    </rule>
    <rule ref="rulesets/unusedcode.xml/UnusedLocalVariable">
        <priority>1</priority>
    </rule>
    <rule ref="rulesets/design.xml/ExitExpression">
        <priority>1</priority>
    </rule>
    <rule ref="rulesets/design.xml/EvalExpression">
        <priority>1</priority>
    </rule>
    <rule ref="rulesets/design.xml/GotoStatement">
        <priority>1</priority>
    </rule>
    <rule ref="rulesets/design.xml/DevelopmentCodeFragment">
        <priority>1</priority>
    </rule>
    <rule ref="rulesets/naming.xml/ConstantNamingConventions">
        <priority>1</priority>
    </rule>
    <rule ref="rulesets/controversial.xml/Superglobals">
        <priority>1</priority>
    </rule>
    <rule ref="rulesets/controversial.xml/CamelCaseClassName">
        <priority>1</priority>
    </rule>
    <rule ref="rulesets/controversial.xml/CamelCasePropertyName">
        <priority>1</priority>
    </rule>
    <rule ref="rulesets/controversial.xml/CamelCaseMethodName">
        <priority>1</priority>
    </rule>
    <rule ref="rulesets/controversial.xml/CamelCaseParameterName">
        <priority>1</priority>
    </rule>
    <rule ref="rulesets/controversial.xml/CamelCaseVariableName">
        <priority>1</priority>
    </rule>

    <!-- These rules are not checked in the CI because it will need too many work to have them all -->
    <rule ref="rulesets/unusedcode.xml/UnusedFormalParameter">
        <!-- It also throws an error when params are declared to follow the parent method's prototype -->
        <priority>2</priority>
    </rule>
    <rule ref="rulesets/codesize.xml/ExcessiveMethodLength">
        <priority>2</priority>
    </rule>
    <rule ref="rulesets/codesize.xml/ExcessiveParameterList">
        <priority>2</priority>
    </rule>
    <rule ref="rulesets/codesize.xml/ExcessivePublicCount">
        <priority>2</priority>
    </rule>

    <rule ref="rulesets/naming.xml/BooleanGetMethodName">
        <priority>2</priority>
    </rule>
</ruleset>