Copy Page

You are not logged in. Any changes you make will be marked as anonymous. You may want to Log In if you already have an account. You can also Sign Up for a new account.

<table class="wysiwyg-macro" data-macro-name="info" data-macro-parameters="icon=false|title=Table of Contents" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2luZm86aWNvbj1mYWxzZXx0aXRsZT1UYWJsZSBvZiBDb250ZW50c30&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="RICH_TEXT"><tr><td class="wysiwyg-macro-body"><p><img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e3RvY30&amp;locale=en_GB&amp;version=2" data-macro-name="toc"></p></td></tr></table><p>To understand how rules extension works in Sonar, please refer to the <a class="confluence-link" href="/display/SONAR/Extending+Coding+Rules" data-linked-resource-id="183205932" data-linked-resource-type="page" data-linked-resource-default-alias="Extending Coding Rules" data-base-url="http://docs.codehaus.org">Extending Coding Rules</a> documentation.</p><h1>Extending PHP_Codesniffer Rules</h1><p>PHP_CodeSniffer is built on an extensible architecture where you can define you own rules.</p><p>To do so, you just have to create your own rules.xml file following the below format:</p><table class="wysiwyg-macro" data-macro-name="code" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2NvZGV9&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>&lt;?xml version="1.0" encoding="ISO-8859-1"?>
&lt;rules>
  &lt;rule key="PEAR.Commenting.FileComment.TagIndent" priority="MAJOR">
    &lt;category name="Maintainability" />
    &lt;name>Tag comment incorrectly indented&lt;/name>
    &lt;configKey>TAG_INDENT&lt;/configKey>
    &lt;description>@category tag comment incorrectly indented&lt;/description>
  &lt;/rule>
&lt;/rules>
</pre></td></tr></table><p>This file must be copied in the directory $SONAR_HOME/extensions/rules/<strong>php_codesniffer_rules</strong>/. You have to restart your Sonar server to make it available for PHP profiles.</p><p>The value of the &quot;key&quot; attribute is a combination of different elements: <strong><code>&lt;standard_folder&gt;.&lt;sniff_subfolder&gt;.&lt;sniff_file_without_Sniff_suffix&gt;.&lt;error_name&gt;</code></strong>. <br />For instance, for the given key above (&quot;<code>PEAR.Commenting.FileComment.TagIndent</code>&quot;):</p><ul><li>&quot;<code>PEAR</code>&quot; is the folder found in the &quot;Standards&quot; directory of PHPCodeSniffer install directory</li><li>&quot;<code>Commenting</code>&quot; is the folder found in the &quot;Sniffs&quot; directory of the &quot;PEAR&quot; folder</li><li>&quot;<code>FileComment</code>&quot; is the name of the PHP file &quot;FileCommentSniff.php&quot; for which &quot;Sniff.php&quot; was removed</li><li>&quot;<code>TagIndent</code>&quot; is the name of the error that can be found in &quot;FileCommentSniff.php&quot; file</li></ul><h1>Extending PHPMD Rules</h1><p>Extending PHPMD works the same way as PHP_CodeSniffer, except that you have to copy your file containing your custom violations in $SONAR_HOME/extensions/rules/<strong>phppmd_rules</strong>/</p><p>This XML file must look like the following example:</p><table class="wysiwyg-macro" data-macro-name="code" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2NvZGV9&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>&lt;?xml version="1.0" encoding="ISO-8859-1"?>
&lt;rules>
  &lt;rule key="Code Size Rules/CyclomaticComplexity" priority="CRITICAL">
    &lt;name>&lt;![CDATA[Class cyclomatic complexity exceed maximum]]&gt;&lt;/name>
    &lt;configKey>rulesets/codesize.xml/CyclomaticComplexity&lt;/configKey>
    &lt;category name="Maintainability"/>
    &lt;description>&lt;![CDATA[Class cyclomatic complexity exceed maximum]]&gt;&lt;/description>
    &lt;param key="maximum" type="i">
      &lt;description>&lt;![CDATA[The maximum cyclomatic complexity threshold. Default is 10.]]&gt;&lt;/description>
    &lt;/param>
  &lt;/rule>
&lt;!-- other rules ... -->
&lt;/rules>
</pre></td></tr></table>