README.md (1405B)
1 [](https://packagist.org/packages/phpunit/php-code-coverage) 2 [](https://travis-ci.org/sebastianbergmann/php-code-coverage) 3 4 # PHP_CodeCoverage 5 6 **PHP_CodeCoverage** is a library that provides collection, processing, and rendering functionality for PHP code coverage information. 7 8 ## Requirements 9 10 * PHP 5.3.3 is required but using the latest version of PHP is highly recommended 11 * [Xdebug](http://xdebug.org/) 2.1.3 is required but using the latest version of Xdebug is highly recommended 12 13 ## Installation 14 15 To add PHP_CodeCoverage as a local, per-project dependency to your project, simply add a dependency on `phpunit/php-code-coverage` to your project's `composer.json` file. Here is a minimal example of a `composer.json` file that just defines a dependency on PHP_CodeCoverage 1.2: 16 17 { 18 "require": { 19 "phpunit/php-code-coverage": "1.2.*" 20 } 21 } 22 23 ## Using the PHP_CodeCoverage API 24 25 ```php 26 <?php 27 $coverage = new PHP_CodeCoverage; 28 $coverage->start('<name of test>'); 29 30 // ... 31 32 $coverage->stop(); 33 34 $writer = new PHP_CodeCoverage_Report_Clover; 35 $writer->process($coverage, '/tmp/clover.xml'); 36 37 $writer = new PHP_CodeCoverage_Report_HTML; 38 $writer->process($coverage, '/tmp/code-coverage-report'); 39 ``` 40