Stops the build if any of the specified coverage threshold was not reached

Use Project#createTask to register a new Task.

author Benjamin Schultz
version $Id: ed00d6f1d05bb5dc7c9967c9ec67fa6f958682ec $
package phing.tasks.ext.coverage
since 2.4.1
copyright 2001,2002 THYRELL. All rights reserved

 Methods

Create classpath object

createClasspath() : \Path

Returns

Create excludes object

createExcludes() : \Excludes

Returns

Returns the textual description of the task

getDescription() : string
Inherited
inherited_from \Task::getDescription()

Returns

stringThe text description of the task

Returns the location within the buildfile this task occurs.

getLocation() : \Location
Inherited

Used by BuildException to give detailed error messages.

inherited_from \Task::getLocation()

Returns

\LocationThe location object describing the position of this task within the buildfile.

Returns the owning target of this task.

getOwningTarget() : \Target
Inherited
inherited_from \Task::getOwningTarget()

Returns

\TargetThe target object that owns this task

Returns a reference to current project

getProject() : \Project
Inherited
inherited_from \ProjectComponent::getProject()
inherited_from \Task::getProject()

Returns

\ProjectReference to current porject object

Returns the wrapper object for runtime configuration

getRuntimeConfigurableWrapper() : \RuntimeConfigurable
Inherited
inherited_from \Task::getRuntimeConfigurableWrapper()

Returns

\RuntimeConfigurableThe wrapper object used by this task

Returns the name of task, used only for log messages

getTaskName() : string
Inherited
inherited_from \Task::getTaskName()

Returns

stringName of this task

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

getTaskType() : string
Inherited
inherited_from \Task::getTaskType()

Returns

stringThe type of this task (XML Tag)

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.

inherited_from \Task::init()

Exceptions

\BuildException

Provides a project level log event to the task.

log(string $msg, integer $level) 
Inherited
see \global\BuildEvent
see \global\BuildListener
inherited_from \Task::log()

Parameters

$msg

string

The message to log

$level

integer

The priority of the message

Called by the project to let the task do it's work.

main() 

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.

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

maybeConfigure() 
Inherited
inherited_from \Task::maybeConfigure()

Perfrom this task

perform() 
Inherited
inherited_from \Task::perform()

Sets an optional classpath

setClasspath(\Path $classpath) 

Parameters

$classpath

\Path

The classpath

Sets the optional coverage database to use

setDatabase(\PhingFile $database) 

Parameters

$database

\PhingFile

The database file

Sets a textual description of the task

setDescription(string $desc) 
Inherited
inherited_from \Task::setDescription()

Parameters

$desc

string

The text describing the task

Sets the location within the buildfile this task occurs.

setLocation(\Location $location) 
Inherited

Called by the parser to set location information.

inherited_from \Task::setLocation()

Parameters

$location

\Location

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

Sets the owning target this task belongs to.

setOwningTarget(\Target $target) 
Inherited
inherited_from \Task::setOwningTarget()

Parameters

$target

\Target

Reference to owning target

Sets the coverage threshold for any class

setPerClass(integer $threshold) 

Parameters

$threshold

integer

Coverage threshold for any class

Sets the coverage threshold for any method

setPerMethod(integer $threshold) 

Parameters

$threshold

integer

Coverage threshold for any method

Sets the coverage threshold for entire project

setPerProject(integer $threshold) 

Parameters

$threshold

integer

Coverage threshold for entire project

References the project to the current component.

setProject(\Project $project) 
Inherited
inherited_from \ProjectComponent::setProject()
inherited_from \Task::setProject()

Parameters

$project

\Project

The reference to the current project

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

setRuntimeConfigurableWrapper(\RuntimeConfigurable $wrapper) 
Inherited
inherited_from \Task::setRuntimeConfigurableWrapper()

Parameters

$wrapper

\RuntimeConfigurable

The wrapper object this task should use

Sets the name of this task for log messages

setTaskName(string $name) : string
Inherited
inherited_from \Task::setTaskName()

Parameters

$name

string

Returns

stringA string representing the name of this task for log

Sets the type of the task.

setTaskType(string $name) 
Inherited

Usually this is the name of the XML tag

inherited_from \Task::setTaskType()

Parameters

$name

string

The type of this task (XML Tag)

Sets whether to enable detailed logging or not

setVerbose(boolean $verbose) 

Parameters

$verbose

boolean

Calculates the coverage threshold

calculateCoverageThreshold(string $filename, array $coverageInformation) 

Parameters

$filename

string

The filename to analyse

$coverageInformation

array

Array with coverage information

Filter covered statements

filterCovered(integer $var) : boolean

Parameters

$var

integer

Coverage CODE/count

Returns

boolean

Returns a name

getRegisterSlot(string $slotName) 
Inherited
inherited_from \Task::getRegisterSlot()

Parameters

$slotName

string

 Properties

 

$description : string
Inherited
inherited_from \Task::$$description
 

$location : \Location
Inherited
inherited_from \Task::$$location
 

$project : \Project
Inherited
inherited_from \ProjectComponent::$$project
inherited_from \Task::$$project
 

$target : \Target
Inherited
inherited_from \Task::$$target
 

$taskName : string
Inherited
inherited_from \Task::$$taskName
 

$taskType : string
Inherited
inherited_from \Task::$$taskType
 

$wrapper : \RuntimeConfigurable
Inherited
inherited_from \Task::$$wrapper
 

$_classpath : \Path
 

$_database : \PhingFile
 

$_excludes : \Excludes
 

$_minClassCoverageFound : integer
 

$_minMethodCoverageFound : integer
 

$_perClass : integer
 

$_perMethod : integer
 

$_perProject : integer
 

$_projectStatementCount : integer
 

$_projectStatementsCovered : integer
 

$_verbose : boolean