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 PHP CodeSniffer project on Nemo.
Description / Features
The plugin enables analysis of PHP projects within Sonar.
It relies on well-known external tools: PHPUnit, PHP Depend, PHPMD and PHP_CodeSniffer.
- Install the PHP Environment
- Install the Sonar PHP plugin through the Update Center or download it into the SONAR_HOME/extensions/plugins directory
- Restart the Sonar server
Run a Sonar Analysis with the Sonar Runner (Recommended Way)
To launch a Sonar analysis of your PHP project, use the Sonar Runner.
Run a Sonar Analysis with the other Analyzers
Disabling or enabling tool on demand
One important thing is the ability to run or disable each php tool individually.To do so, simply add the following properties to your pom.xml .
Use existing files to generate dashboard
Another interesting feature is the ability to use already generated files from pdepend, phpmd, phpunit and to get the sonar dashboard working. To do so, you have to be sure that log files for these tools are located inside $PROJECT_HOME/target/logs/. Filename must be: pdepend.xml, pmd.xml, codesniffer.xml, php-cpd.xml, phpunit.xml and phpunit-coverage.xml . If you generate you files from another tool (like ant), be sure to make a copy of these files inside target/logs directory. Also, you have to stick to the required version of tools supported from you version of Sonar PHP Plugin. Because sonar php plugin uses files located on the file system to make them match with violations, you have to be sure that your source directories and test directories are correctly referenced in your pom.xml even your project is not build with maven.
Here is an example:
Have some questions or problems?
Here's the path you should follow in this case:
- First check the plugin's FAQ or Troubleshooting sections.
- See if there is any open issues that may be linked to your question/problem
- Eventually send a mail on the user mailing list (firstname.lastname@example.org) to ask for help
- 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