CoverageReportTask

Extends \Task

Transforms information in a code coverage database to XML

Use \Project#createTask to register a new Task.

author

Michiel Rook mrook@php.net

version

$Id: 2f73afc3401097333c7f187eacb79de9e16a6f35 $

package

phing.tasks.ext.coverage

since 2.1.0

Methods

__construct

__construct() 

addClassToPackage

addClassToPackage( $packageName,  $element) 

Arguments

$packageName

$element

Adds a class to their subpackage

addClassToSubpackage(string $classname, \DOMNode $element) : void
author

Benjamin Schultz bschultz@proqrent.de

Arguments

$classname

string

The name of the class

$element

\DOMNode

The dom node to append to the subpackage element

Adds a subpackage to their package

addSubpackageToPackage(string $packageName, string $subpackageName) : void
author

Benjamin Schultz bschultz@proqrent.de

Arguments

$packageName

string

The name of the package

$subpackageName

string

The name of the subpackage

calculateStatistics

calculateStatistics() 

createClasspath

createClasspath() : null|\Path

Response

null|\Path

Generate a report based on the XML created by this task

createReport() 

Returns the textual description of the task

getDescription() : string
inherited

Response

string

The text description of the task

Returns the location within the buildfile this task occurs. Used by {@link BuildException} to give detailed error messages.

getLocation() : \Location
inherited

Response

\Location

The location object describing the position of this

             task within the buildfile.

Returns the owning target of this task.

getOwningTarget() : \Target
inherited

Response

\Target

The target object that owns this task

getPackageElement

getPackageElement( $packageName) : null

Arguments

$packageName

Response

null

Returns a reference to current project

getProject() : \Project
inherited

Response

\Project

Reference to current porject object

Returns a name

getRegisterSlot(string $slotName) : \RegisterSlot
inherited

Arguments

$slotName

string

Response

\RegisterSlot

Returns the wrapper object for runtime configuration

getRuntimeConfigurableWrapper() : \RuntimeConfigurable
inherited

Response

\RuntimeConfigurable

The wrapper object used by this task

Returns the subpackage element

getSubpackageElement(string $subpackageName) : \DOMNode|null
author

Benjamin Schultz bschultz@proqrent.de

Arguments

$subpackageName

string

The name of the subpackage

Response

\DOMNode|null

null when no DOMNode with the given name exists

Returns the name of task, used only for log messages

getTaskName() : string
inherited

Response

string

Name of this task

Returns the name of the task under which it was invoked, usually the XML tagname

getTaskType() : string
inherited

Response

string

The type of this task (XML Tag)

highlightSourceFile

highlightSourceFile( $filename) : array

Arguments

$filename

Response

array

Called by the parser to let the task initialize properly.

init() 
inherited

Should throw a BuildException if something goes wrong with the build

This is abstract here, but may not be overloaded by subclasses.

throws

Logs a message with the given priority.

log(string $msg, integer $level = \Project::MSG_INFO) : void
inherited

Arguments

$msg

string

The message to be logged.

$level

integer

The message's priority at this message should have

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 <em>phing target1 target2</em> will run all tasks in target3 twice.

main() 
inherited abstract

Should throw a BuildException if someting goes wrong with the build

This is abstract here. Must be overloaded by real tasks.

Configure this task if it hasn't been done already.

maybeConfigure() 
inherited

Perfrom this task

perform() 
inherited
throws

setClasspath

setClasspath(\Path $classpath) 

Arguments

$classpath

\Path

Sets a textual description of the task

setDescription(string $desc) 
inherited

Arguments

$desc

string

The text describing the task

setGeshiLanguagesPath

setGeshiLanguagesPath( $path) 

Arguments

$path

setGeshiPath

setGeshiPath( $path) 

Arguments

$path

Sets the location within the buildfile this task occurs. Called by the parser to set location information.

setLocation(\Location $location) 
inherited

Arguments

$location

\Location

The location object describing the position of this

                      task within the buildfile.

setOutfile

setOutfile( $outfile) 

Arguments

$outfile

Sets the owning target this task belongs to.

setOwningTarget(\Target $target) 
inherited

Arguments

$target

\Target

References the project to the current component.

setProject(\Project $project) : void
inherited

Arguments

$project

\Project

The reference to the current project

Sets the wrapper object this task should use for runtime configurable elements.

setRuntimeConfigurableWrapper(\RuntimeConfigurable $wrapper) 
inherited

Arguments

$wrapper

\RuntimeConfigurable

The wrapper object this task should use

Sets the name of this task for log messages

setTaskName(string $name) : string
inherited

Arguments

$name

string

Response

string

A string representing the name of this task for log

Sets the type of the task. Usually this is the name of the XML tag

setTaskType( $name) 
inherited

Arguments

$name

stripDiv

stripDiv( $source) : string

Arguments

$source

Response

string

Transforms the coverage information

transformCoverageInformation(string $filename, array $coverageInformation) : void
author

Michiel Rook mrook@php.net

Benjamin Schultz bschultz@proqrent.de

Arguments

$filename

string

The filename

$coverageInformation

array

Array with covergae information

transformSourceFile

transformSourceFile( $filename,  $coverageInformation, integer $classStartLine = 1) : \DOMElement

Arguments

$filename

$coverageInformation

$classStartLine

integer

Response

\DOMElement

Properties

outfile

outfile : 

Type(s)

transformers

transformers : 

Type(s)

the classpath to use (optional)

classpath : 

Type(s)

the path to the GeSHi library (optional)

geshipath : 

Type(s)

the path to the GeSHi language files (optional)

geshilanguagespath : 

Type(s)

Owning Target object

target : \Target
inherited
var

Type(s)

\Target

Description of the task

description : string
inherited
var

Type(s)

string

Internal taskname (req)

taskType : string
inherited
var

Type(s)

string

Taskname for logger

taskName : string
inherited
var

Type(s)

string

Stored buildfile location

location : \Location
inherited
var

Type(s)

\Location

Wrapper of the task

wrapper : \RuntimeConfigurable
inherited
var

Type(s)

\RuntimeConfigurable

Holds a reference to the project that a project component (a task, a target, etc.) belongs to

project : \Project
inherited
var

A reference to the current project instance

Type(s)

\Project