tasks/ext/coverage/CoverageReportTask.php

Show: inherited
Table of Contents

\CoverageReportTask

Package: phing\tasks\ext\coverage

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

Propertyprivate  $classpath= 'NULL'

the classpath to use (optional)

Default valueNULLDetails
Type
n/a
Propertyprotectedstring  $description= ''
inherited

Description of the task

Inherited from: \Task::$$description
Details
Type
string
Inherited_from
\Task::$$description  
Propertyprivate  $geshilanguagespath= '""'

the path to the GeSHi language files (optional)

Default value""Details
Type
n/a
Propertyprivate  $geshipath= '""'

the path to the GeSHi library (optional)

Default value""Details
Type
n/a
Propertyprotected\Location  $location= ''
inherited

Stored buildfile location

Inherited from: \Task::$$location
Details
Type
\Location
Inherited_from
\Task::$$location  
Propertyprivate  $outfile= '"coverage.xml"'
Default value"coverage.xml"Details
Type
n/a
Propertyprotected\Project  $project= 'null'
inherited

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::$$project
Default valuenullDetails
Type
\Project
Inherited_from
\ProjectComponent::$$project  
Inherited_from
\Task::$$project  
Propertyprotected\Target  $target= ''
inherited

Owning Target object

Inherited from: \Task::$$target
Details
Type
\Target
Inherited_from
\Task::$$target  
Propertyprotectedstring  $taskName= ''
inherited

Taskname for logger

Inherited from: \Task::$$taskName
Details
Type
string
Inherited_from
\Task::$$taskName  
Propertyprotectedstring  $taskType= ''
inherited

Internal taskname (req)

Inherited from: \Task::$$taskType
Details
Type
string
Inherited_from
\Task::$$taskType  
Propertyprivate  $transformers= 'array()'
Default valuearray()Details
Type
n/a
Propertyprotected\RuntimeConfigurable  $wrapper= ''
inherited

Wrapper of the task

Inherited from: \Task::$$wrapper
Details
Type
\RuntimeConfigurable
Inherited_from
\Task::$$wrapper  

Methods

methodpublic__construct( ) : void

methodprotectedaddClassToPackage(  $classname,  $element ) : void

Parameters
Name Type Description
$classname
$element
methodprotectedaddClassToSubpackage( string $classname, \DOMNode $element ) : void

Adds a class to their subpackage

Parameters
Name Type Description
$classname string

The name of the class

$element \DOMNode

The dom node to append to the subpackage element

Details
Author
Benjamin Schultz  
methodprotectedaddSubpackageToPackage( string $packageName, string $subpackageName ) : void

Adds a subpackage to their package

Parameters
Name Type Description
$packageName string

The name of the package

$subpackageName string

The name of the subpackage

Details
Author
Benjamin Schultz  
methodprotectedcalculateStatistics( ) : void

methodpubliccreateClasspath( ) : void

methodpubliccreateReport( ) : void

Generate a report based on the XML created by this task

methodpublicgetDescription( ) : string
inherited

Returns the textual description of the task

Inherited from: \Task::getDescription()
Returns
Type Description
string The text description of the task
methodpublicgetLocation( ) : \Location
inherited

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

Inherited from: \Task::getLocation()
Returns
Type Description
\Location The location object describing the position of this task within the buildfile.
methodpublicgetOwningTarget( ) : \Target
inherited

Returns the owning target of this task.

Inherited from: \Task::getOwningTarget()
Returns
Type Description
\Target The target object that owns this task
methodprotectedgetPackageElement(  $packageName ) : void

Parameters
Name Type Description
$packageName
methodpublicgetProject( ) : \Project
inherited

Returns a reference to current project

Inherited from: \ProjectComponent::getProject()\Task::getProject()
Returns
Type Description
\Project Reference to current porject object
methodprotectedgetRegisterSlot( string $slotName ) : void
inherited

Returns a name

Inherited from: \Task::getRegisterSlot()
Parameters
Name Type Description
$slotName string
methodpublicgetRuntimeConfigurableWrapper( ) : \RuntimeConfigurable
inherited

Returns the wrapper object for runtime configuration

Inherited from: \Task::getRuntimeConfigurableWrapper()
Returns
Type Description
\RuntimeConfigurable The wrapper object used by this task
methodprotectedgetSubpackageElement( string $subpackageName ) : \DOMNode | null

Returns the subpackage element

Parameters
Name Type Description
$subpackageName string

The name of the subpackage

Returns
Type Description
\DOMNode | null null when no DOMNode with the given name exists
Details
Author
Benjamin Schultz  
methodpublicgetTaskName( ) : string
inherited

Returns the name of task, used only for log messages

Inherited from: \Task::getTaskName()
Returns
Type Description
string Name of this task
methodpublicgetTaskType( ) : string
inherited

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

Inherited from: \Task::getTaskType()
Returns
Type Description
string The type of this task (XML Tag)
methodprotectedhighlightSourceFile(  $filename ) : void

Parameters
Name Type Description
$filename
methodpublicinit( ) : void
inherited

Called by the parser to let the task initialize properly.

Inherited from: \Task::init()

Should throw a BuildException if something goes wrong with the build

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

Throws
Exception Description
\BuildException
methodpubliclog( string $msg, integer $level = Project::MSG_INFO ) : void
inherited

Provides a project level log event to the task.

Inherited from: \Task::log()
Parameters
Name Type Description
$msg string

The message to log

$level integer

The priority of the message

Details
See
\BuildEvent  
See
\BuildListener  
methodpublicmain( ) : 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.

methodpublicmaybeConfigure( ) : void
inherited

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

Inherited from: \Task::maybeConfigure()
methodpublicperform( ) : void
inherited

Perfrom this task

Inherited from: \Task::perform()
methodpublicsetClasspath(  $classpath ) : void

Parameters
Name Type Description
$classpath
methodpublicsetDescription( string $desc ) : void
inherited

Sets a textual description of the task

Inherited from: \Task::setDescription()
Parameters
Name Type Description
$desc string

The text describing the task

methodpublicsetGeshiLanguagesPath(  $path ) : void

Parameters
Name Type Description
$path
methodpublicsetGeshiPath(  $path ) : void

Parameters
Name Type Description
$path
methodpublicsetLocation( \Location $location ) : void
inherited

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

Inherited from: \Task::setLocation()
Parameters
Name Type Description
$location \Location

The location object describing the position of this task within the buildfile.

methodpublicsetOutfile(  $outfile ) : void

Parameters
Name Type Description
$outfile
methodpublicsetOwningTarget( \Target $target ) : void
inherited

Sets the owning target this task belongs to.

Inherited from: \Task::setOwningTarget()
Parameters
Name Type Description
$target \Target

Reference to owning target

methodpublicsetProject( \Project $project ) : void
inherited

References the project to the current component.

Inherited from: \ProjectComponent::setProject()\Task::setProject()
Parameters
Name Type Description
$project \Project

The reference to the current project

methodpublicsetRuntimeConfigurableWrapper( \RuntimeConfigurable $wrapper ) : void
inherited

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

Inherited from: \Task::setRuntimeConfigurableWrapper()
Parameters
Name Type Description
$wrapper \RuntimeConfigurable

The wrapper object this task should use

methodpublicsetTaskName( string $name ) : string
inherited

Sets the name of this task for log messages

Inherited from: \Task::setTaskName()
Parameters
Name Type Description
$name string
Returns
Type Description
string A string representing the name of this task for log
methodpublicsetTaskType( string $name ) : void
inherited

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

Inherited from: \Task::setTaskType()
Parameters
Name Type Description
$name string

The type of this task (XML Tag)

methodprotectedstripDiv(  $source ) : void

Parameters
Name Type Description
$source
methodprotectedtransformCoverageInformation( string $filename, array $coverageInformation ) : void

Transforms the coverage information

Parameters
Name Type Description
$filename string

The filename

$coverageInformation array

Array with covergae information

Details
Author
Michiel Rook  
Author
Benjamin Schultz  
methodprotectedtransformSourceFile(  $filename,  $coverageInformation,  $classStartLine = 1 ) : void

Parameters
Name Type Description
$filename
$coverageInformation
$classStartLine
Documentation was generated by DocBlox 0.18.1.