tasks/ext/coverage/CoverageReportTask.php

Show:

inherited

Classes
- \CoverageReportTask

Table of Contents

$Id: CoverageReportTask.php 1289 2011-08-19 07:55:37Z mrook $

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.

\CoverageReportTask
jump to top

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: CoverageReportTask.php 1289 2011-08-19 07:55:37Z mrook $

Properties


                 $classpath= 'NULL'

the classpath to use (optional)

Default valueNULLDetails

Type

string
                 $description= ''

inherited

description of the taskInherited from: \Task::$description

Details

Type: string
Inherited_from: \Task::$description


                 $geshilanguagespath= '""'

the path to the GeSHi language files (optional)

Default value""Details

Type


                 $geshipath= '""'

the path to the GeSHi library (optional)

Default value""Details

Type

\Location
                 $location= ''

inherited

stored buildfile locationInherited from: \Task::$location

Details

Type: \Location
Inherited_from: \Task::$location


                 $outfile= '"coverage.xml"'

Default value"coverage.xml"Details

Type

\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

Default valuenullDetails

Type: \Project
Inherited_from: \ProjectComponent::$project

\Target
                 $target= ''

inherited

owning Target objectInherited from: \Task::$target

Details

Type: \Target
Inherited_from: \Task::$target

string
                 $taskName= ''

inherited

Taskname for loggerInherited from: \Task::$taskName

Details

Type: string
Inherited_from: \Task::$taskName

string
                 $taskType= ''

inherited

internal taskname (req)Inherited from: \Task::$taskType

Details

Type: string
Inherited_from: \Task::$taskType


                 $transformers= 'array()'

Default valuearray()Details

Type

\RuntimeConfigurable
                 $wrapper= ''

inherited

wrapper of the taskInherited from: \Task::$wrapper

Details

Type: \RuntimeConfigurable
Inherited_from: \Task::$wrapper

Methods

__construct(
          
          )
        
        :
          void

addClassToPackage(
           $classname,  $element
          )
        
        :
          void

Parameters

Name	Type	Description
$classname
$element

addClassToSubpackage(
          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

addSubpackageToPackage(
          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

calculateStatistics(
          
          )
        
        :
          void

createClasspath(
          
          )
        
        :
          void

createReport(
          
          )
        
        :
          void

Generate a report based on the XML created by this task

getDescription(
          
          )
        
        :
          string

inherited

Returns the textual description of the task

Inherited from: \Task::getDescription()

Returns

Type	Description
string	The text description of the task

getLocation(
          
          )
        
        :
          \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.

getOwningTarget(
          
          )
        
        :
          \Target

inherited

Returns the owning target of this task.

Inherited from: \Task::getOwningTarget()

Returns

Type	Description
\Target	The target object that owns this task

getPackageElement(
           $packageName
          )
        
        :
          void

Parameters

Name	Type	Description
$packageName

getProject(
          
          )
        
        :
          \Project

inherited

Returns a reference to current project

Inherited from: \ProjectComponent::getProject()

Returns

Type	Description
\Project	Reference to current porject object

getRegisterSlot(
           $slotName
          )
        
        :
          void

inherited

Returns a name

Inherited from: \Task::getRegisterSlot()

Parameters

Name	Type	Description
$slotName

getRuntimeConfigurableWrapper(
          
          )
        
        :
          \RuntimeConfigurable

inherited

Returns the wrapper object for runtime configuration

Inherited from: \Task::getRuntimeConfigurableWrapper()

Returns

Type	Description
\RuntimeConfigurable	The wrapper object used by this task

getSubpackageElement(
          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

getTaskName(
          
          )
        
        :
          string

inherited

Returns the name of task, used only for log messages

Inherited from: \Task::getTaskName()

Returns

Type	Description
string	Name of this task

getTaskType(
          
          )
        
        :
          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)

highlightSourceFile(
           $filename
          )
        
        :
          void

Parameters

Name	Type	Description
$filename

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

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

inherited

Provides a project level log event to the task.

Inherited from: \Task::log()

@param string $msg The message to be logged.

Parameters

Name	Type	Description
$msg	string	The message to log
$level	integer	The priority of the message

Details

See: \BuildEvent
See: \BuildListener

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

inherited

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

Inherited from: \Task::maybeConfigure()

perform(
          
          )
        
        :
          void

inherited

Perfrom this task

Inherited from: \Task::perform()

setClasspath(
           $classpath
          )
        
        :
          void

Parameters

Name	Type	Description
$classpath

setDescription(
          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

setGeshiLanguagesPath(
           $path
          )
        
        :
          void

Parameters

Name	Type	Description
$path

setGeshiPath(
           $path
          )
        
        :
          void

Parameters

Name	Type	Description
$path

setLocation(
          \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.

setOutfile(
           $outfile
          )
        
        :
          void

Parameters

Name	Type	Description
$outfile

setOwningTarget(
          \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

setProject(
          \Project $project
          )
        
        :
          void

inherited

References the project to the current component.

Inherited from: \ProjectComponent::setProject()

Parameters

Name	Type	Description
$project	\Project	The reference to the current project

setRuntimeConfigurableWrapper(
          \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

setTaskName(
           $name
          )
        
        :
          string

inherited

Sets the name of this task for log messages

Inherited from: \Task::setTaskName()

Parameters

Name	Type	Description
$name

Returns

Type	Description
string	A string representing the name of this task for log

setTaskType(
          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)

stripDiv(
           $source
          )
        
        :
          void

Parameters

Name	Type	Description
$source

transformCoverageInformation(
          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

transformSourceFile(
           $filename,  $coverageInformation,  $classStartLine
              =
              1
          )
        
        :
          void

Parameters

Name	Type	Description
$filename
$coverageInformation
$classStartLine

tasks/ext/coverage/CoverageReportTask.php

\CoverageReportTaskjump to top

Properties

Methods

\CoverageReportTask
jump to top