tasks/ext/coverage/CoverageReportTask.php
\CoverageReportTask
Transforms information in a code coverage database to XML
Use {@link Project#createTask} to register a new Task.
- Parent(s)
- \Task < \ProjectComponent
- Author
- Michiel Rook
- Copyright
- 2001,2002 THYRELL. All rights reserved
- Since
- 2.1.0
- Version
- $Id: 564bbde3ec5084ed2db570958548af2b9d1c1127 $
Properties


$geshilanguagespath= '""'
the path to the GeSHi language files (optional)
""
Details- Type
- n/a


\Project
$project= 'null'
Holds a reference to the project that a project component (a task, a target, etc.) belongs to
A reference to the current project instanceInherited from: \ProjectComponent::$$project\Task::$$projectnull
Details- Type
- \Project
- Inherited_from
- \ProjectComponent::$$project
- Inherited_from
- \Task::$$project
Methods


addClassToPackage(
$classname, $element
)
:
void
Name | Type | Description |
---|---|---|
$classname | ||
$element |


addClassToSubpackage(
string $classname, \DOMNode $element
)
:
void
Adds 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
)
:
void
Adds 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


getLocation(
)
:
\Location
Returns the location within the buildfile this task occurs. Used by {@link BuildException} to give detailed error messages.
Inherited from: \Task::getLocation()Type | Description |
---|---|
\Location | The location object describing the position of this task within the buildfile. |


getProject(
)
:
\Project
Returns a reference to current project
Inherited from: \ProjectComponent::getProject()\Task::getProject()Type | Description |
---|---|
\Project | Reference to current porject object |


getRuntimeConfigurableWrapper(
)
:
\RuntimeConfigurable
Returns the wrapper object for runtime configuration
Inherited from: \Task::getRuntimeConfigurableWrapper()Type | Description |
---|---|
\RuntimeConfigurable | The wrapper object used by this task |


getSubpackageElement(
string $subpackageName
)
:
\DOMNode | null
Returns the subpackage element
Name | Type | Description |
---|---|---|
$subpackageName | string | The name of the subpackage |
Type | Description |
---|---|
\DOMNode | null | null when no DOMNode with the given name exists |
- Author
- Benjamin Schultz


getTaskType(
)
:
string
Returns the name of the task under which it was invoked, usually the XML tagname
Inherited from: \Task::getTaskType()Type | Description |
---|---|
string | The type of this task (XML Tag) |


init(
)
:
void
Should throw a BuildException if something goes wrong with the build
This is abstract here, but may not be overloaded by subclasses.
Exception | Description |
---|---|
\BuildException |


log(
string $msg, integer $level
=
Project::MSG_INFO
)
:
void
Name | Type | Description |
---|---|---|
$msg | string | The message to log |
$level | integer | The priority of the message |
- See
- \BuildEvent
- See
- \BuildListener


main(
)
:
void
Called by the project to let the task do it's work. This method may be called more than once, if the task is invoked more than once. For example, if target1 and target2 both depend on target3, then running phing target1 target2 will run all tasks in target3 twice.
Should throw a BuildException if someting goes wrong with the build
This is abstract here. Must be overloaded by real tasks.


maybeConfigure(
)
:
void
Configure this task if it hasn't been done already.
Inherited from: \Task::maybeConfigure()

setDescription(
string $desc
)
:
void
Name | Type | Description |
---|---|---|
$desc | string | The text describing the task |


setLocation(
\Location $location
)
:
void
Sets the location within the buildfile this task occurs. Called by the parser to set location information.
Inherited from: \Task::setLocation()Name | Type | Description |
---|---|---|
$location | \Location | The location object describing the position of this task within the buildfile. |


setOwningTarget(
\Target $target
)
:
void
Name | Type | Description |
---|---|---|
$target | \Target | Reference to owning target |


setProject(
\Project $project
)
:
void
References the project to the current component.
Inherited from: \ProjectComponent::setProject()\Task::setProject()Name | Type | Description |
---|---|---|
$project | \Project | The reference to the current project |


setRuntimeConfigurableWrapper(
\RuntimeConfigurable $wrapper
)
:
void
Sets the wrapper object this task should use for runtime configurable elements.
Inherited from: \Task::setRuntimeConfigurableWrapper()Name | Type | Description |
---|---|---|
$wrapper | \RuntimeConfigurable | The wrapper object this task should use |


setTaskName(
string $name
)
:
string
Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
string | A string representing the name of this task for log |


setTaskType(
string $name
)
:
void
Sets the type of the task. Usually this is the name of the XML tag
Inherited from: \Task::setTaskType()Name | Type | Description |
---|---|---|
$name | string | The type of this task (XML Tag) |


transformCoverageInformation(
string $filename, array $coverageInformation
)
:
void
Transforms the coverage information
Name | Type | Description |
---|---|---|
$filename | string | The filename |
$coverageInformation | array | Array with covergae information |
- Author
- Michiel Rook
- Author
- Benjamin Schultz