classes/phing/tasks/ext/coverage/CoverageReportTask.php
Classes
\CoverageReportTask
Transforms information in a code coverage database to XML
Use {@link Project#createTask} to register a new Task.
- Extends from
- \Task
- author
- Michiel Rook
- copyright
- 2001,2002 THYRELL. All rights reserved
- package
- phing.tasks.ext.coverage
- since
- 2.1.0
- version
- $Id: CoverageReportTask.php 1267 2011-08-13 16:19:47Z mrook $
Properties
$classpath= 'NULL'
the classpath to use (optional)
NULLDetails- Type
$geshilanguagespath= ''
the path to the GeSHi language files (optional)
- Type
$geshipath= ''
the path to the GeSHi library (optional)
- Type
$outfile= 'coverage.xml'
Default value
coverage.xmlDetails- Type
$transformers= 'array'
Default value
arrayDetails- Type
Methods
__construct(
)
:
addClassToPackage(
$classname, $element
)
:
Parameters
| Name | Type | Description |
|---|---|---|
| $classname | ||
| $element |
addClassToSubpackage(
string $classname, \DOMNode $element
)
:
voidAdds a class to their subpackage
| Name | Type | Description |
|---|---|---|
| $classname | string | The name of the class |
| $element | \DOMNode | The dom node to append to the subpackage element |
- author
- Benjamin Schultz
addSubpackageToPackage(
string $packageName, string $subpackageName
)
:
voidAdds a subpackage to their package
| Name | Type | Description |
|---|---|---|
| $packageName | string | The name of the package |
| $subpackageName | string | The name of the subpackage |
- author
- Benjamin Schultz
calculateStatistics(
)
:
createClasspath(
)
:
createReport(
)
:
Generate a report based on the XML created by this task
getPackageElement(
$packageName
)
:
Parameters
| Name | Type | Description |
|---|---|---|
| $packageName |
getSubpackageElement(
string $subpackageName
)
:
\DOMNode|nullReturns the subpackage element
| Name | Type | Description |
|---|---|---|
| $subpackageName | string | The name of the subpackage |
| Type | Description |
|---|---|
| \DOMNodenull |
- author
- Benjamin Schultz
highlightSourceFile(
$filename
)
:
Parameters
| Name | Type | Description |
|---|---|---|
| $filename |
main(
)
:
setClasspath(
$classpath
)
:
Parameters
| Name | Type | Description |
|---|---|---|
| $classpath |
setGeshiLanguagesPath(
$path
)
:
Parameters
| Name | Type | Description |
|---|---|---|
| $path |
setGeshiPath(
$path
)
:
Parameters
| Name | Type | Description |
|---|---|---|
| $path |
setOutfile(
$outfile
)
:
Parameters
| Name | Type | Description |
|---|---|---|
| $outfile |
stripDiv(
$source
)
:
Parameters
| Name | Type | Description |
|---|---|---|
| $source |
transformCoverageInformation(
string $filename, array $coverageInformation
)
:
voidTransforms the coverage information
| Name | Type | Description |
|---|---|---|
| $filename | string | The filename |
| $coverageInformation | array | Array with covergae information |
- author
- Michiel Rook
- author
- Benjamin Schultz
transformSourceFile(
$filename, $coverageInformation, $classStartLine
=
1
)
:
Parameters
| Name | Type | Description |
|---|---|---|
| $filename | ||
| $coverageInformation | ||
| $classStartLine |