[ Index ]

PHP Cross Reference of Limb3

title

Body

[close]

/tests_runner/lib/spikephpcoverage/src/ -> CoverageRecorder.php (summary)

(no description)

File Size: 446 lines (15 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 3 files
 tests_runner/lib/spikephpcoverage/src/util/Utility.php
 tests_runner/lib/spikephpcoverage/src/reporter/CoverageReporter.php
 tests_runner/lib/spikephpcoverage/src/conf/phpcoverage.conf.php

Defines 1 class

CoverageRecorder:: (22 methods):
  __construct()
  startInstrumentation()
  stopInstrumentation()
  generateReport()
  removeAbsentPaths()
  processSourcePaths()
  getFilesAndDirs()
  addFiles()
  stripCoverageData()
  unixifyCoverageData()
  getErrors()
  logErrors()
  getIncludePaths()
  setIncludePaths()
  getExcludePaths()
  setExcludePaths()
  getReporter()
  setReporter()
  getPhpExtensions()
  setPhpExtensions()
  getVersion()
  excludeCoverageDir()


Class: CoverageRecorder  - X-Ref

The Coverage Recorder utility

This is the main class for the CoverageRecorder. User should
instantiate this class and set various parameters of it.
The startInstrumentation and stopInstrumentation methods will
switch code coverage recording on and off respectively.

The code coverage is recorded using XDebug Zend Extension. Therefore,
it is required to install that extension on the system where
code coverage measurement is going to take place. See
{@link http://www.xdebug.org www.xdebug.org} for more
information.

__construct($includePaths=array(".")   X-Ref
Constructor (PHP5 only)

param: $includePaths Directories to be included in code coverage report
param: $excludePaths Directories to be excluded from code coverage report
param: $reporter Instance of a Reporter subclass

startInstrumentation()   X-Ref
Starts the code coverage recording


stopInstrumentation()   X-Ref
Stops code coverage recording


generateReport()   X-Ref
Generate the code coverage report


removeAbsentPaths(&$dirs)   X-Ref
Remove the directories that do not exist from the input array

param: &$dirs Array of directory names

processSourcePaths()   X-Ref
Processes and validates the source directories


getFilesAndDirs($dir, &$files)   X-Ref
Get the list of files that match the extensions in $this->phpExtensions

param: $dir Root directory
param: &$files Array of filenames to append to

addFiles()   X-Ref
Add all source files to the list of files that need to be parsed.


stripCoverageData()   X-Ref
Removes the unwanted coverage data from the recordings

return: Processed coverage data

unixifyCoverageData()   X-Ref
Convert filepaths in coverage data to forward slash separated
paths.


getErrors()   X-Ref
Returns the errors array containing all error encountered so far.

return: Array of error messages

logErrors()   X-Ref
Writes all error messages to error log


getIncludePaths()   X-Ref
No description

setIncludePaths($includePaths)   X-Ref
No description

getExcludePaths()   X-Ref
No description

setExcludePaths($excludePaths)   X-Ref
No description

getReporter()   X-Ref
No description

setReporter(&$reporter)   X-Ref
No description

getPhpExtensions()   X-Ref
No description

setPhpExtensions(&$extensions)   X-Ref
No description

getVersion()   X-Ref
No description

excludeCoverageDir()   X-Ref
Exclude the directory containing the coverage measurement code.




Generated: Tue Oct 7 05:02:03 2008 Cross-referenced by PHPXref 0.7