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="unmigrated-inline-wiki-markup" data-macro-parameters="atlassian-macro-output-type=BLOCK" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e3VubWlncmF0ZWQtaW5saW5lLXdpa2ktbWFya3VwOmF0bGFzc2lhbi1tYWNyby1vdXRwdXQtdHlwZT1CTE9DS30&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>{iframe:src=http://update.sonarsource.org/plugins/php.html|width=700|height=250|frameborder=0}
Your browser does not support iframes.
{iframe}</pre></td></tr></table><table class="wysiwyg-macro" data-macro-name="tip" data-macro-parameters="title=Live example" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e3RpcDp0aXRsZT1MaXZlIGV4YW1wbGV9&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="RICH_TEXT"><tr><td class="wysiwyg-macro-body"><p>If you want to see a live example of the capabilities of the PHP plugin, you can have a look at the analysis of the <a href="http://nemo.sonarsource.org/dashboard/index/net.php.pear.phpcodesniffer">PHP CodeSniffer project on Nemo</a>.</p></td></tr></table><h1>Description / Features</h1><p>The plugin enables analysis of PHP projects within Sonar.</p><p>I<span>t is compatible with </span><span>the </span><a href="http://docs.codehaus.org/display/SONAR/Issues+Report+Plugin">Issues Report plugin</a><span> to run pre-commit local analysis.</span></p><p>It relies on well-known external tools: PHPUnit, PHP Depend, PHPMD and PHP_CodeSniffer.</p><h1>Installation</h1><ol><li>Install the <a class="confluence-link" href="/display/SONAR/Installing+PHP+Environment" data-linked-resource-id="227053268" data-linked-resource-type="page" data-linked-resource-default-alias="Installing PHP Environment" data-base-url="http://docs.codehaus.org">PHP Environment</a></li><li>Install the Sonar PHP plugin through the <a href="http://docs.codehaus.org/display/SONAR/Update+Center">Update Center</a> or download it into the SONAR_HOME/extensions/plugins directory</li><li>Restart the Sonar server</li></ol><h1>Usage</h1><h3>Run a Sonar Analysis with the Sonar Runner (Recommended Way)</h3><p>To launch a Sonar analysis of your PHP project, use the <a href="http://docs.codehaus.org/display/SONAR/Analyzing+with+Sonar+Runner" rel="nofollow">Sonar Runner</a>.</p><p>Sample projects are available on GitHub that can be <a class="external-link" href="https://github.com/SonarSource/sonar-examples" rel="nofollow">browsed</a> or <a class="external-link" href="https://github.com/SonarSource/sonar-examples/zipball/master" rel="nofollow">downloaded</a>: /projects/languages/php.</p><h3>Run a Sonar Analysis with the other Analyzers</h3><p><a href="http://docs.codehaus.org/display/SONAR/Analyzing+with+Maven" rel="nofollow">Maven</a> and <a href="http://docs.codehaus.org/display/SONAR/Analyzing+with+Ant+Task" rel="nofollow">Ant</a> can also be used to launch analysis on PHP projects.</p><h3>Advanced Settings</h3><h4>Disabling or enabling external tools on demand</h4><p>It is possible to disable each external tool. By default, all the external tools are enabled.</p><table class="wysiwyg-macro" data-macro-name="code" data-macro-parameters="lang=xml|language=bash" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2NvZGU6bGFuZ3VhZ2U9YmFzaHxsYW5nPXhtbH0&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>sonar.phpPmd.skip=true
sonar.phpCodesniffer.skip=true
sonar.phpDepend.skip=true    # Deactiving the PHP Depend plugin is highly discouraged since all the basic metrics rely on it.
sonar.phpUnit.skip=true
sonar.phpUnit.coverage.skip=true</pre></td></tr></table><h4>Configuring PHPUnit to be run by Sonar</h4><p>To configure the execution of PHPUnit, it is recommended to create a configuration file and set the path to this file with the <strong>sonar.phpUnit.configuration</strong> property.</p><p>If a configuration file is not used, the following property can be set to configure the execution of PHPUnit:</p><table class="confluenceTable"><tbody><tr><th class="confluenceTh"><p>Key</p></th><th class="confluenceTh"><p>Default value</p></th><th class="confluenceTh"><p>Description</p></th></tr><tr><td class="confluenceTd"><p>sonar.phpUnit.ignore.configuration</p></td><td class="confluenceTd"><p> false</p></td><td class="confluenceTd"><p>If true, PHPUnit will ignore any phpunit.xml file for launching the unit tests. <br class="atl-forced-newline" />If false, PHPUnit will use any existing phpunit.xml file in the running directory.</p></td></tr><tr><td class="confluenceTd"><p>sonar.phpUnit.mainTestClass</p></td><td class="confluenceTd"><p> </p></td><td class="confluenceTd"><p>The project main test file including the relative path, ie: &quot;/source/tests/AllTests.php&quot;. If not present, PHPUnit will look for phpunit.xml file in the test directory.</p></td></tr><tr><td class="confluenceTd"><p>sonar.phpUnit.filter</p></td><td class="confluenceTd"><p> </p></td><td class="confluenceTd"><p>Ignore the unit tests files matching this pattern.</p></td></tr><tr><td class="confluenceTd"><p>sonar.phpUnit.bootstrap</p></td><td class="confluenceTd"><p> </p></td><td class="confluenceTd"><p>Use this bootsrap file to initialize the unit tests.</p></td></tr><tr><td class="confluenceTd"><p>sonar.phpUnit.analyze.test.directory</p></td><td class="confluenceTd"><p> true</p></td><td class="confluenceTd"><p>If true, Sonar PHP will append test directory to PHPUnit. This will make PHPUnit look for test cases inside this directory. If several directories are defined as test directories, a phpunitRANDOM.xml file will be generated and passed to phpunit --configuration=. This generated file will contain all files inside the test directories.</p></td></tr><tr><td colspan="1" class="confluenceTd">sonar.phpUnit.group</td><td colspan="1" class="confluenceTd"> </td><td colspan="1" class="confluenceTd">Only runs tests from the specified group(s).</td></tr><tr><td colspan="1" class="confluenceTd">sonar.phpUnit.loader</td><td colspan="1" class="confluenceTd"> </td><td colspan="1" class="confluenceTd">To specify which TestSuiteLoader implementation to use.</td></tr></tbody></table><h4>Reusing existing reports</h4><p>To reuse existing reports from PHP Depend, PHPUnit, etc.:</p><ol><li>Set the property 'sonar.&lt;external_tool&gt;.analyzeOnly' to 'true'</li><li>Set the 'sonar.&lt;external_tool&gt;.reportFileName' to the name of the report</li><li>Set the 'sonar.&lt;external_tool&gt;.reportFileRelativePath' to the path where the report has been placed</li></ol><table class="wysiwyg-macro" data-macro-name="code" data-macro-parameters="lang=xml|language=bash" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2NvZGU6bGFuZ3VhZ2U9YmFzaHxsYW5nPXhtbH0&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>#PHPMD
sonar.phpPmd.analyzeOnly=true
sonar.phpPmd.reportFileName=myPmdReport.xml 
#default is logs; parent is $PROJECT_HOME/.sonar/target when the analysis is triggered with the Sonar Runner, $PROJECT_HOME/target when triggered with Maven
sonar.phpPmd.reportFileRelativePath=&lt;relative_path_from_parent_to_xml_report>

#PHP_CodeSniffer
sonar.phpCodesniffer.analyzeOnly=true
sonar.phpCodesniffer.reportFileName=myCodeSnifferReport.xml    #default is codesniffer.xml
#default is logs; parent is $PROJECT_HOME/.sonar/target when the analysis is triggered with the Sonar Runner, $PROJECT_HOME/target when triggered with Maven
sonar.phpCodesniffer.reportFileRelativePath=&lt;relative_path_from_parent_to_xml_report>
 
#PHP Depend
sonar.phpDepend.analyzeOnly=true
sonar.phpDepend.reportFileName=myPhpDependReport.xml    #default is pdepend.xml
#default is logs; parent is $PROJECT_HOME/.sonar/target when the analysis is triggered with the Sonar Runner, $PROJECT_HOME/target when triggered with Maven
sonar.phpDepend.reportFileRelativePath=&lt;relative_path_from_parent_to_xml_report>
sonar.phpDepend.reportType=summary-xml    #Type of report generated by PHP Depend. Valid values: summary-xml, phpunit-xml (default value, deprecated)
 
#PHPUnit
sonar.phpUnit.analyzeOnly=true
sonar.phpUnit.reportFileName=myPhpUnitReport.xml    #default is phpunit.xml
#default is logs; parent is $PROJECT_HOME/.sonar/target when the analysis is triggered with the Sonar Runner, $PROJECT_HOME/target when triggered with Maven
sonar.phpUnit.reportFileRelativePath=&lt;relative_path_from_parent_to_xml_report>

sonar.phpUnit.coverage.analyzeOnly=true
sonar.phpUnit.coverageReportFile=myCoverageReport.xml    #default is phpunit.coverage.xml
#Same path as sonar.phpUnit.reportFileRelativePath</pre></td></tr></table><table class="wysiwyg-macro" data-macro-name="info" data-macro-parameters="title=Note" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2luZm86dGl0bGU9Tm90ZX0&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="RICH_TEXT"><tr><td class="wysiwyg-macro-body"><p>Note that the reports should be generated with the <a href="http://docs.codehaus.org/display/SONAR/Installing+PHP+Environment#InstallingPHPEnvironment-ExternalToolsVersions">recommended version of each tool</a>. Otherwise you may face some incompatibility issues.</p></td></tr></table><h3>FAQ and Troubleshooting</h3><ul><li><a class="confluence-link" href="/display/SONAR/PHP+Plugin+FAQ" data-linked-resource-id="189169712" data-linked-resource-type="page" data-linked-resource-default-alias="PHP Plugin FAQ" data-base-url="http://docs.codehaus.org">PHP Plugin FAQ</a></li><li><a class="confluence-link" href="/display/SONAR/PHP+Plugin+Troubleshooting" data-linked-resource-id="228177816" data-linked-resource-type="page" data-linked-resource-default-alias="PHP Plugin Troubleshooting" data-base-url="http://docs.codehaus.org">PHP Plugin Troubleshooting</a></li></ul><h1>Metrics</h1><p>See <a class="confluence-link" href="/display/SONAR/Metric+definitions" data-linked-resource-id="230397406" data-linked-resource-type="page" data-linked-resource-default-alias="Metric definitions" data-base-url="http://docs.codehaus.org">Metrics documentation page</a>.</p><h1>Extending Coding Rules</h1><p>See the <a class="confluence-link" href="/display/SONAR/Extending+PHP+Coding+Rules" data-linked-resource-id="201719816" data-linked-resource-type="page" data-linked-resource-default-alias="Extending PHP Coding Rules" data-base-url="http://docs.codehaus.org">tutorial</a> to extend coding rules with PHP_CodeSniffer and/or PHPMD.</p><h1>Roadmap</h1><ol><li><strong>PHP 1.2 - short-term activity</strong> <em>(see the <a href="http://jira.codehaus.org/browse/SONARPLUGINS/fixforversion/18523">JIRA open tickets</a>)</em><ol><li>Improve the PHP CodeSniffer rule repository (adding missing parameters, descriptions, ...)</li><li>Work on the &quot;Sonar Way&quot;, PEAR and Zend profiles (&lt;= for PHP gurus! <img class="emoticon emoticon-wink" data-emoticon-name="wink" border="0" src="/s/en_GB/3278/15/_/images/icons/emoticons/wink.png" alt="(wink)" title="(wink)" /> )</li></ol></li><li><strong>PHP 2.0 - mid-term activity</strong><ol><li>Handle multiple files with the same name</li><li>Consider root folders as &quot;Projects&quot;</li><li>Non structured PHP files</li><li>If it turns out that those tickets are technically difficult/long to implement, then they can be postponed</li></ol></li></ol><h1>Change Log</h1><p><img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e2ppcmFpc3N1ZXM6YW5vbnltb3VzPXRydWV8dGl0bGU9UmVsZWFzZSAxLjF8aGVpZ2h0PTExMHxyZW5kZXJNb2RlPXN0YXRpY3x3aWR0aD05MDB8Y29sdW1ucz10eXBlO2tleTtzdW1tYXJ5O3ByaW9yaXR5fHVybD1odHRwOi8vamlyYS5jb2RlaGF1cy5vcmcvc3IvamlyYS5pc3N1ZXZpZXdzOnNlYXJjaHJlcXVlc3QteG1sL3RlbXAvU2VhcmNoUmVxdWVzdC54bWw_anFsUXVlcnk9cHJvamVjdCslM0QrU09OQVJQTFVHSU5TK0FORCtmaXhWZXJzaW9uKyUzRCsiUEhQLTEuMSIrQU5EK2NvbXBvbmVudCslM0QrUEhQK0FORCtzdGF0dXMrJTNEK0Nsb3NlZCtPUkRFUitCWStwcmlvcml0eStERVNDJnRlbXBNYXg9MTAwMH0&amp;locale=en_GB&amp;version=2" data-macro-name="jiraissues" data-macro-parameters="anonymous=true|columns=type;key;summary;priority|height=110|renderMode=static|title=Release 1.1|url=http://jira.codehaus.org/sr/jira.issueviews:searchrequest-xml/temp/SearchRequest.xml?jqlQuery\=project+%3D+SONARPLUGINS+AND+fixVersion+%3D+&quot;PHP-1.1&quot;+AND+component+%3D+PHP+AND+status+%3D+Closed+ORDER+BY+priority+DESC&amp;tempMax\=1000|width=900"></p><p> </p><p><img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e2ppcmFpc3N1ZXM6YW5vbnltb3VzPXRydWV8dGl0bGU9UmVsZWFzZSAxLjB8aGVpZ2h0PTExMHxyZW5kZXJNb2RlPXN0YXRpY3x3aWR0aD05MDB8Y29sdW1ucz10eXBlO2tleTtzdW1tYXJ5O3ByaW9yaXR5fHVybD1odHRwOi8vamlyYS5jb2RlaGF1cy5vcmcvc3IvamlyYS5pc3N1ZXZpZXdzOnNlYXJjaHJlcXVlc3QteG1sL3RlbXAvU2VhcmNoUmVxdWVzdC54bWw_anFsUXVlcnk9cHJvamVjdCslM0QrU09OQVJQTFVHSU5TK0FORCtmaXhWZXJzaW9uKyUzRCsiUEhQLTEuMCIrQU5EK2NvbXBvbmVudCslM0QrUEhQK0FORCtzdGF0dXMrJTNEK0Nsb3NlZCtPUkRFUitCWStwcmlvcml0eStERVNDJnRlbXBNYXg9MTAwMH0&amp;locale=en_GB&amp;version=2" data-macro-name="jiraissues" data-macro-parameters="anonymous=true|columns=type;key;summary;priority|height=110|renderMode=static|title=Release 1.0|url=http://jira.codehaus.org/sr/jira.issueviews:searchrequest-xml/temp/SearchRequest.xml?jqlQuery\=project+%3D+SONARPLUGINS+AND+fixVersion+%3D+&quot;PHP-1.0&quot;+AND+component+%3D+PHP+AND+status+%3D+Closed+ORDER+BY+priority+DESC&amp;tempMax\=1000|width=900"></p><p> </p><p><img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e2ppcmFpc3N1ZXM6YW5vbnltb3VzPXRydWV8dGl0bGU9UmVsZWFzZSAwLjZ8aGVpZ2h0PTExMHxyZW5kZXJNb2RlPXN0YXRpY3x3aWR0aD05MDB8Y29sdW1ucz10eXBlO2tleTtzdW1tYXJ5O3ByaW9yaXR5fHVybD1odHRwOi8vamlyYS5jb2RlaGF1cy5vcmcvc3IvamlyYS5pc3N1ZXZpZXdzOnNlYXJjaHJlcXVlc3QteG1sL3RlbXAvU2VhcmNoUmVxdWVzdC54bWw_anFsUXVlcnk9cHJvamVjdCslM0QrU09OQVJQTFVHSU5TK0FORCtmaXhWZXJzaW9uKyUzRCsxNzg1MytBTkQrY29tcG9uZW50KyUzRCtQSFArQU5EK3N0YXR1cyslM0QrQ2xvc2VkK09SREVSK0JZK3ByaW9yaXR5K0RFU0MmdGVtcE1heD0xMDAwfQ&amp;locale=en_GB&amp;version=2" data-macro-name="jiraissues" data-macro-parameters="anonymous=true|columns=type;key;summary;priority|height=110|renderMode=static|title=Release 0.6|url=http://jira.codehaus.org/sr/jira.issueviews:searchrequest-xml/temp/SearchRequest.xml?jqlQuery\=project+%3D+SONARPLUGINS+AND+fixVersion+%3D+17853+AND+component+%3D+PHP+AND+status+%3D+Closed+ORDER+BY+priority+DESC&amp;tempMax\=1000|width=900"></p><p> </p><p><img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e2ppcmFpc3N1ZXM6YW5vbnltb3VzPXRydWV8dGl0bGU9UmVsZWFzZSAwLjV8aGVpZ2h0PTExMHxyZW5kZXJNb2RlPXN0YXRpY3x3aWR0aD05MDB8Y29sdW1ucz10eXBlO2tleTtzdW1tYXJ5O3ByaW9yaXR5fHVybD1odHRwOi8vamlyYS5jb2RlaGF1cy5vcmcvc3IvamlyYS5pc3N1ZXZpZXdzOnNlYXJjaHJlcXVlc3QteG1sL3RlbXAvU2VhcmNoUmVxdWVzdC54bWw_Zml4Zm9yPTE3Mjk4JnBpZD0xMTkxMSZzb3J0ZXIvZmllbGQ9aXNzdWVrZXkmc29ydGVyL29yZGVyPURFU0MmdGVtcE1heD0xMDAwfQ&amp;locale=en_GB&amp;version=2" data-macro-name="jiraissues" data-macro-parameters="anonymous=true|columns=type;key;summary;priority|height=110|renderMode=static|title=Release 0.5|url=http://jira.codehaus.org/sr/jira.issueviews:searchrequest-xml/temp/SearchRequest.xml?fixfor\=17298&amp;pid\=11911&amp;sorter/field\=issuekey&amp;sorter/order\=DESC&amp;tempMax\=1000|width=900"></p><p> </p><p><img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e2ppcmFpc3N1ZXM6YW5vbnltb3VzPXRydWV8dGl0bGU9UmVsZWFzZSAwLjR8aGVpZ2h0PTExMHxyZW5kZXJNb2RlPXN0YXRpY3x3aWR0aD05MDB8Y29sdW1ucz10eXBlO2tleTtzdW1tYXJ5O3ByaW9yaXR5fHVybD1odHRwOi8vamlyYS5jb2RlaGF1cy5vcmcvc3IvamlyYS5pc3N1ZXZpZXdzOnNlYXJjaHJlcXVlc3QteG1sL3RlbXAvU2VhcmNoUmVxdWVzdC54bWw_Zml4Zm9yPTE2Njk2JnBpZD0xMTkxMSZzb3J0ZXIvZmllbGQ9aXNzdWVrZXkmc29ydGVyL29yZGVyPURFU0MmdGVtcE1heD0xMDAwfQ&amp;locale=en_GB&amp;version=2" data-macro-name="jiraissues" data-macro-parameters="anonymous=true|columns=type;key;summary;priority|height=110|renderMode=static|title=Release 0.4|url=http://jira.codehaus.org/sr/jira.issueviews:searchrequest-xml/temp/SearchRequest.xml?fixfor\=16696&amp;pid\=11911&amp;sorter/field\=issuekey&amp;sorter/order\=DESC&amp;tempMax\=1000|width=900"></p><p> </p><p><img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e2ppcmFpc3N1ZXM6YW5vbnltb3VzPXRydWV8dGl0bGU9UmVsZWFzZSAwLjN8aGVpZ2h0PTExMHxyZW5kZXJNb2RlPXN0YXRpY3x3aWR0aD05MDB8Y29sdW1ucz10eXBlO2tleTtzdW1tYXJ5O3ByaW9yaXR5fHVybD1odHRwOi8vamlyYS5jb2RlaGF1cy5vcmcvc3IvamlyYS5pc3N1ZXZpZXdzOnNlYXJjaHJlcXVlc3QteG1sL3RlbXAvU2VhcmNoUmVxdWVzdC54bWw_Zml4Zm9yPTE2NTIyJnBpZD0xMTkxMSZzb3J0ZXIvZmllbGQ9aXNzdWVrZXkmc29ydGVyL29yZGVyPURFU0MmdGVtcE1heD0xMDAwfQ&amp;locale=en_GB&amp;version=2" data-macro-name="jiraissues" data-macro-parameters="anonymous=true|columns=type;key;summary;priority|height=110|renderMode=static|title=Release 0.3|url=http://jira.codehaus.org/sr/jira.issueviews:searchrequest-xml/temp/SearchRequest.xml?fixfor\=16522&amp;pid\=11911&amp;sorter/field\=issuekey&amp;sorter/order\=DESC&amp;tempMax\=1000|width=900"></p><p> </p><p><img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e2ppcmFpc3N1ZXM6YW5vbnltb3VzPXRydWV8dGl0bGU9UmVsZWFzZSAwLjJ8aGVpZ2h0PTExMHxyZW5kZXJNb2RlPXN0YXRpY3x3aWR0aD05MDB8Y29sdW1ucz10eXBlO2tleTtzdW1tYXJ5O3ByaW9yaXR5fHVybD1odHRwOi8vamlyYS5jb2RlaGF1cy5vcmcvc3IvamlyYS5pc3N1ZXZpZXdzOnNlYXJjaHJlcXVlc3QteG1sL3RlbXAvU2VhcmNoUmVxdWVzdC54bWw_Zml4Zm9yPTE2NDMyJnBpZD0xMTkxMSZzb3J0ZXIvZmllbGQ9aXNzdWVrZXkmc29ydGVyL29yZGVyPURFU0MmdGVtcE1heD0xMDAwfQ&amp;locale=en_GB&amp;version=2" data-macro-name="jiraissues" data-macro-parameters="anonymous=true|columns=type;key;summary;priority|height=110|renderMode=static|title=Release 0.2|url=http://jira.codehaus.org/sr/jira.issueviews:searchrequest-xml/temp/SearchRequest.xml?fixfor\=16432&amp;pid\=11911&amp;sorter/field\=issuekey&amp;sorter/order\=DESC&amp;tempMax\=1000|width=900"></p>