Class RemoteCoverageRecorder

Description
Description | Vars (details) | Methods (details)

A Coverage recorder extension for remote Coverage measurement.

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

CoverageRecorder
   |
   --RemoteCoverageRecorder
Variable Summary
Description | Vars (details) | Methods (details)
mixed $coverageFileName
mixed $tmpDir
mixed $tmpTraceFilename
mixed $traceFilePath
mixed $xdebugTraceReader
mixed $xmlEnd
mixed $xmlStart
Method Summary
Description | Vars (details) | Methods (details)
RemoteCoverageRecorder __construct ([mixed $includePaths = array(".")], [mixed $excludePaths = array()], [mixed $reporter = "new HtmlCoverageReporter()"])
True appendDataToFile ($newXml $newXml)
Boolean cleanCoverageFile ()
void generateReport ($xmlUrl $xmlUrl, [$stream=false $stream = false])
void getCoverageFileName ()
void getCoverageXml ()
void getTmpDir ()
void getTraceFilePath ()
void parseCoverageXml ($xml &$xml, [$stream=false $stream = false])
String prepareCoverageXml ()
Boolean saveCoverageXml ()
void setCoverageFileName (mixed $covFileName)
void setTmpDir (mixed $tmpTraceDir)
void setTraceFilePath (mixed $traceFilePath)
Variables
Description | Vars (details) | Methods (details)
mixed $coverageFileName = "phpcoverage.coverage.xml" (line 34)
  • access: protected
mixed $tmpDir (line 32)
  • access: protected
mixed $tmpTraceFilename = "phpcoverage.xdebug.trace" (line 33)
  • access: protected
mixed $traceFilePath (line 30)
  • access: protected
mixed $xdebugTraceReader (line 31)
  • access: protected
mixed $xmlEnd = "</spike-phpcoverage>" (line 37)
  • access: protected
mixed $xmlStart = "<?xml version=\"1.0\" encoding=\"utf-8\" ?><spike-phpcoverage>" (line 36)
  • access: protected

Inherited Variables

Inherited from CoverageRecorder

CoverageRecorder::$coverageData
 CoverageRecorder::$excludePaths
 CoverageRecorder::$includePaths
 CoverageRecorder::$isRemote
 CoverageRecorder::$logger
 CoverageRecorder::$phpCoverageFiles
 CoverageRecorder::$phpExtensions
 CoverageRecorder::$reporter
 CoverageRecorder::$stripped
 CoverageRecorder::$version
Methods
Description | Vars (details) Methods (details)
Constructor __construct (line 47)

Constructor

  • access: public
RemoteCoverageRecorder __construct ([mixed $includePaths = array(".")], [mixed $excludePaths = array()], [mixed $reporter = "new HtmlCoverageReporter()"])
Redefinition of:
CoverageRecorder::__construct()
Constructor (PHP5 only)
appendDataToFile (line 226)

Append coverage data to xml file

  • return: on success; false otherwise
  • access: protected
True appendDataToFile ($newXml $newXml)
  • $newXml $newXml: New xml recorded
cleanCoverageFile (line 99)

Deletes a coverage data file if one exists.

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

Generate report from the xml coverage data The preferred method for usage of this function is passing a stream of the XML data in. This is much more efficient and consumes less memory.

  • access: public
void generateReport ($xmlUrl $xmlUrl, [$stream=false $stream = false])
  • $xmlUrl $xmlUrl: Url where XML data is available or string
  • $stream=false $stream: Is the xml available as stream?
Redefinition of:
CoverageRecorder::generateReport()
Generate the code coverage report
getCoverageFileName (line 82)
  • access: public
void getCoverageFileName ()
getCoverageXml (line 192)

Dumps the coverage data in XML format

  • access: public
void getCoverageXml ()
getTmpDir (line 74)
  • access: public
void getTmpDir ()
getTraceFilePath (line 66)
  • access: public
void getTraceFilePath ()
parseCoverageXml (line 158)

Parse coverage XML to regenerate the Coverage data array.

  • access: protected
void parseCoverageXml ($xml &$xml, [$stream=false $stream = false])
  • $xml &$xml: XML String or URL of the coverage data
  • $stream=false $stream: Is the input a stream?
prepareCoverageXml (line 123)

Convert the Coverage data into an XML.

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

Append coverage xml to a xml data file.

  • return: True on success, False on error
  • access: public
Boolean saveCoverageXml ()
setCoverageFileName (line 86)
  • access: public
void setCoverageFileName (mixed $covFileName)
setTmpDir (line 78)
  • access: public
void setTmpDir (mixed $tmpTraceDir)
setTraceFilePath (line 70)
  • 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::getVersion()
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 Fri, 06 Jul 2007 12:51:39 -0700 by phpDocumentor 1.3.0RC3