Description / Features
The plugin enables analysis of PHP projects within SonarQubeTM.
It is compatible with the Issues Report plugin to run pre-commit local analysis.
It relies on well-known external tools: PHPUnit, PHP Depend, PHPMD and PHP CodeSniffer.
- Install the PHP Environment
- Install the plugin through the Update Center or download it into the SONARQUBE_HOME/extensions/plugins directory
- Restart the SonarQubeTM server
Run anAnalysis with the SonarQubeTM Runner (Recommended Way)
To run an analysis of your PHP project, use the SonarQubeTM Runner.
You can also have a look at the SonarQubeTM Runner documentation page to define a multi-module PHP project.
Run an Analysis with the other Analyzers
Disabling or enabling external tools on demand
It is possible to disable each external tool. By default, all the external tools are enabled.
Configuring PHPUnit to be run by SonarQubeTM
To configure the execution of PHPUnit, it is recommended to create a configuration file and set the path to this file with the
If a configuration file is not used, the following property can be set to configure the execution of PHPUnit:
If true, PHPUnit will ignore any phpunit.xml file for launching the unit tests.
The project main test file including the relative path, ie: "/source/tests/AllTests.php". If not present, PHPUnit will look for phpunit.xml file in the test directory.
Ignore the unit tests files matching this pattern.
Use this bootsrap file to initialize the unit tests.
If true, it 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.
|sonar.phpUnit.group||Only runs tests from the specified group(s).|
|sonar.phpUnit.loader||To specify which TestSuiteLoader implementation to use.|
Reusing existing reports
To reuse existing reports from PHP Depend, PHPUnit, etc.:
- Set the
- Set the path to the report in
sonar.<external_tool>.reportPath. Path is relative to the base directory (where you for a mono-module project...
Most of the time, using the exclusion properties will be enough to exclude files from being reported by SonarQubeTM. However, there might be some cases where you really want to exclude files from being analyzed by an external tool (may it be PHP CodeSniffer, PHPMD or PHP Depend):
- a file is badly written and the tool is crashing when analyzing this file, thus preventing SonarQubeTM from completing the analysis
- a big number of files must be excluded and there's no need for the external tools to spend time analyzing files that won't be reported in SonarQubeTM
For these specific cases, you should use the
sonar.xxxx.argumentLine property of the external tool to manually define exclusions. For instance, for PHP CodeSniffer, you would add the following property:
This would tell PHP CodeSniffer to ignore every PHP file located in the Database folder.
See PHP FAQ.
Extending Coding Rules
See the tutorial to extend coding rules with PHP CodeSniffer and/or PHPMD.
- PHP 1.2 - short-term activity (see the JIRA open tickets)
- Improve the PHP CodeSniffer rule repository (adding missing parameters, descriptions, ...)
- Work on the "Sonar Way", PEAR and Zend profiles (<= for PHP gurus! )
- PHP 2.0 - mid-term activity
- Handle multiple files with the same name
- Consider root folders as "Projects"
- Non structured PHP files
- If it turns out that those tickets are technically difficult/long to implement, then they can be postponed