Class RemoteCoverageRecorder

Description

A Coverage recorder extension for remote Coverage measurement.

Located in /remote/RemoteCoverageRecorder.php (line 23)

CoverageRecorder
   |
   --RemoteCoverageRecorder
Variable Summary
Method Summary
RemoteCoverageRecorder __construct ([mixed $includePaths = array(".")], [mixed $excludePaths = array()], [mixed $reporter = "new HtmlCoverageReporter()"])
Boolean cleanCoverageFile ()
void generateReport ($xml $xml)
String getCoverageXml ()
void getTmpDir ()
void parseCoverageXml ($xml $xml)
String prepareCoverageXml ()
Boolean saveCoverageXml ()
void setCoverageFileName (mixed $covFileName)
void setTmpDir (mixed $tmpTraceDir)
void setTraceFilePath (mixed $traceFilePath)
Variables
mixed $coverageFileName = "phpcoverage.coverage.xml" (line 30)
  • access: protected
mixed $tmpDir = "/tmp" (line 28)
  • access: protected
mixed $tmpTraceFilename = "phpcoverage.xdebug.trace" (line 29)
  • access: protected
mixed $traceFilePath (line 26)
  • access: protected
mixed $xdebugTraceReader (line 27)
  • access: protected
mixed $xmlEnd = "</spike-phpcoverage>" (line 33)
  • access: protected
mixed $xmlStart = "<?xml version=\"1.0\" encoding=\"utf-8\" ?><spike-phpcoverage>" (line 32)
  • access: protected

Inherited Variables

Inherited from CoverageRecorder

CoverageRecorder::$coverageData
CoverageRecorder::$excludePaths
CoverageRecorder::$includePaths
CoverageRecorder::$isRemote
CoverageRecorder::$phpCoverageFiles
CoverageRecorder::$phpExtensions
CoverageRecorder::$reporter
CoverageRecorder::$stripped
Methods
Constructor __construct (line 43)

Constructor

  • access: public
RemoteCoverageRecorder __construct ([mixed $includePaths = array(".")], [mixed $excludePaths = array()], [mixed $reporter = "new HtmlCoverageReporter()"])

Redefinition of:
CoverageRecorder::__construct()
Constructor (PHP5 only)
cleanCoverageFile (line 87)

Deletes a coverage data file if one exists.

  • return: True on success, False on failure.
  • access: public
Boolean cleanCoverageFile ()
generateReport (line 216)

Generate report from the xml coverage data

  • access: public
void generateReport ($xml $xml)
  • $xml $xml: XML String of coverage data

Redefinition of:
CoverageRecorder::generateReport()
Generate the code coverage report
getCoverageFileName (line 70)
  • access: public
void getCoverageFileName ()
getCoverageXml (line 156)

Returns the coverage data in XML form

  • return: Coverage XML
  • access: public
String getCoverageXml ()
getTmpDir (line 62)
  • access: public
void getTmpDir ()
getTraceFilePath (line 54)
  • access: public
void getTraceFilePath ()
parseCoverageXml (line 140)

Parse coverage XML to regenerate the Coverage data array.

  • access: protected
void parseCoverageXml ($xml $xml)
  • $xml $xml: XML String of the coverage data
prepareCoverageXml (line 111)

Convert the Coverage data into an XML.

  • return: XML generated from Coverage data
  • access: protected
String prepareCoverageXml ()
saveCoverageXml (line 177)

Append coverage xml to a xml data file.

  • return: True on success, False on error
  • access: public
Boolean saveCoverageXml ()
setCoverageFileName (line 74)
  • access: public
void setCoverageFileName (mixed $covFileName)
setTmpDir (line 66)
  • access: public
void setTmpDir (mixed $tmpTraceDir)
setTraceFilePath (line 58)
  • access: public
void setTraceFilePath (mixed $traceFilePath)

Inherited Methods

Inherited From CoverageRecorder

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

Documentation generated on Mon, 16 May 2005 10:01:27 -0700 by phpDocumentor 1.3.0RC3