tasks/ext/coverage/CoverageThresholdTask.php

Show:

inherited

Classes
- \CoverageThresholdTask

Table of Contents

$Id: CoverageThresholdTask.php 1206 2011-07-03 22:46:44Z bschultz $

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

This software consists of voluntary contributions made by many individuals and is licensed under the LGPL. For more information please see http://phing.info.

\CoverageThresholdTask
jump to top

Package: phing\tasks\ext\coverage

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

Parent(s): \Task < \ProjectComponent
Author: Benjamin Schultz
Since: 2.4.1
Version: $Id: CoverageThresholdTask.php 1206 2011-07-03 22:46:44Z bschultz $

Properties

\Path
                 $_classpath= 'null'

Holds an optional classpath

Default valuenullDetails

Type: \Path

\PhingFile
                 $_database= 'null'

Holds an optional database file

Default valuenullDetails

Type: \PhingFile

\Excludes
                 $_excludes= 'null'

Holds the exclusions

Default valuenullDetails

Type: \Excludes

integer
                 $_minClassCoverageFound= 'null'

Holds the minimum found coverage value for a class

Default valuenullDetails

Type: integer

integer
                 $_minMethodCoverageFound= 'null'

Holds the minimum found coverage value for a method

Default valuenullDetails

Type: integer

integer
                 $_perClass= '25'

Holds the coverage threshold for any class

Default value25Details

Type: integer

integer
                 $_perMethod= '25'

Holds the coverage threshold for any method

Default value25Details

Type: integer

integer
                 $_perProject= '25'

Holds the coverage threshold for the entire project

Default value25Details

Type: integer

integer
                 $_projectStatementCount= '0'

Number of statements in the entire project

Default value0Details

Type: integer

integer
                 $_projectStatementsCovered= '0'

Number of covered statements in the entire project

Default value0Details

Type: integer

boolean
                 $_verbose= 'false'

Whether to enable detailed logging

Default valuefalseDetails

Type: boolean

Methods

calculateCoverageThreshold(
          string $filename, array $coverageInformation
          )
        
        :
          void

Calculates the coverage threshold

Parameters

Name	Type	Description
$filename	string	The filename to analyse
$coverageInformation	array	Array with coverage information

createClasspath(
          
          )
        
        :
          \Path

Create classpath object

Returns

Type	Description
\Path

createExcludes(
          
          )
        
        :
          \Excludes

Create excludes object

Returns

Type	Description
\Excludes

filterCovered(
          integer $var
          )
        
        :
          boolean

Filter covered statements

Parameters

Name	Type	Description
$var	integer	Coverage CODE/count

Returns

Type	Description
boolean

getDescription(
          
          )
        
        :
          void

getLocation(
          
          )
        
        :
          void

getOwningTarget(
          
          )
        
        :
          void

getProject(
          
          )
        
        :
          void

getRegisterSlot(
          
          )
        
        :
          void

getRuntimeConfigurableWrapper(
          
          )
        
        :
          void

getTaskName(
          
          )
        
        :
          void

getTaskType(
          
          )
        
        :
          void

maybeConfigure(
          
          )
        
        :
          void

perform(
          
          )
        
        :
          void

setClasspath(
          \Path $classpath
          )
        
        :
          void

Sets an optional classpath

Parameters

Name	Type	Description
$classpath	\Path	The classpath

setDatabase(
          \PhingFile $database
          )
        
        :
          void

Sets the optional coverage database to use

Parameters

Name	Type	Description
$database	\PhingFile	The database file

setDescription(
          
          )
        
        :
          void

setLocation(
          
          )
        
        :
          void

setOwningTarget(
          
          )
        
        :
          void

setPerClass(
          integer $threshold
          )
        
        :
          void

Sets the coverage threshold for any class

Parameters

Name	Type	Description
$threshold	integer	Coverage threshold for any class

setPerMethod(
          integer $threshold
          )
        
        :
          void

Sets the coverage threshold for any method

Parameters

Name	Type	Description
$threshold	integer	Coverage threshold for any method

setPerProject(
          integer $threshold
          )
        
        :
          void

Sets the coverage threshold for entire project

Parameters

Name	Type	Description
$threshold	integer	Coverage threshold for entire project

setProject(
          
          )
        
        :
          void

setRuntimeConfigurableWrapper(
          
          )
        
        :
          void

setTaskName(
          
          )
        
        :
          void

setTaskType(
          
          )
        
        :
          void

setVerbose(
          boolean $verbose
          )
        
        :
          void

Sets whether to enable detailed logging or not

Parameters

Name	Type	Description
$verbose	boolean