Library that provides collection, processing, and rendering functionality for PHP code coverage information.
PHP CSS
Clone or download
Pull request Compare This branch is 711 commits behind sebastianbergmann:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
PHP
Tests
build
scripts
.gitattributes
.gitignore
.travis.yml
CONTRIBUTING.md
LICENSE
README.markdown
build.xml
composer.json
package.xml
phpunit.xml.dist

README.markdown

PHP_CodeCoverage

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

Requirements

  • PHP_CodeCoverage 1.3 requires PHP 5.4.7 (or later).
  • Xdebug 2.2.1 (or later) is required.

Installation

You can use the PEAR Installer or Composer to download and install PHP_CodeCoverage as well as its dependencies

PEAR Installer

Depending on your OS distribution and/or your PHP environment, you may need to install PEAR or update your existing PEAR installation before you can proceed with the following instructions. sudo pear upgrade PEAR usually suffices to upgrade an existing PEAR installation. The PEAR Manual explains how to perform a fresh installation of PEAR.

The following two commands (which you may have to run as root) are all that is required to install PHP_CodeCoverage using the PEAR Installer:

pear config-set auto_discover 1
pear install pear.phpunit.de/PHP_CodeCoverage

After the installation you can find the PHP_CodeCoverage source files inside your local PEAR directory; the path is usually /usr/lib/php/PHP/CodeCoverage.

Composer

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:

{
    "require": {
        "phpunit/php-code-coverage": ">=1.2.10,<1.3.0"
    }
}

Using the PHP_CodeCoverage API

<?php
require 'PHP/CodeCoverage/Autoload.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');