Blame view

vendor/phpunit/php-code-coverage/README.md 1.75 KB
ad2e91f7   Mihail   move multyparser ...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
  [![Latest Stable Version](https://poser.pugx.org/phpunit/php-code-coverage/v/stable.png)](https://packagist.org/packages/phpunit/php-code-coverage)
  [![Build Status](https://travis-ci.org/sebastianbergmann/php-code-coverage.svg?branch=master)](https://travis-ci.org/sebastianbergmann/php-code-coverage)
  
  # PHP_CodeCoverage
  
  **PHP_CodeCoverage** is a library that provides collection, processing, and rendering functionality for PHP code coverage information.
  
  ## Requirements
  
  PHP 5.3.3 is required but using the latest version of PHP is highly recommended
  
  ### PHP 5
  
  [Xdebug](http://xdebug.org/) is the only source of raw code coverage data supported for PHP 5. Version 2.1.3 of Xdebug is required but using the latest version is highly recommended.
  
  ### PHP 7
  
  [phpdbg](http://phpdbg.com/docs) is currently the only source of raw code coverage data supported for PHP 7. Once Xdebug has been updated for PHP 7 it, too, will be supported.
  
  ### 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 2.0:
  
      {
          "require": {
              "phpunit/php-code-coverage": "^2"
          }
      }
  
  ## Using the PHP_CodeCoverage API
  
  ```php
  <?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');
  ```