phpunit/php-code-coverage

Library that provides collection, processing, and rendering functionality for PHP code coverage information.

Installs: 21 176 584

Dependents: 341

Suggesters: 6

Stars: 605

Watchers: 41

Forks: 182

Open Issues: 28


README

Latest Stable Version Build Status

PHP_CodeCoverage is a library that provides collection, processing, and rendering functionality for PHP code coverage information.

Requirements

PHP 5.6 is required but using the latest version of PHP is highly recommended.

PHP 5

Xdebug is the only source of raw code coverage data supported for PHP 5. Version 2.2.1 of Xdebug is required but using the latest version is highly recommended.

PHP 7

Version 2.4.0 (or later) of Xdebug as well as phpdbg are supported sources of raw code coverage data for PHP 7.

HHVM

A version of HHVM that implements the Xdebug API for code coverage (xdebug_*_code_coverage()) is required.

Installation

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 3.0:

{
    "require": {
        "phpunit/php-code-coverage": "^4"
    }
}

Using the PHP_CodeCoverage API

<?php
$coverage = new PHP_CodeCoverage;
$coverage->start('<name of test>');

// ...

$coverage->stop();

$writer = new PHP_CodeCoverage_Report_Clover;
$writer->process($coverage, '/tmp/clover.xml');

$writer = new PHP_CodeCoverage_Report_HTML;
$writer->process($coverage, '/tmp/code-coverage-report');