tasks/ext/phpunit/PHPUnitTask.php

Show: inherited
Table of Contents

\PHPUnitTask

Package: phing\tasks\ext\phpunit

Runs PHPUnit tests.

Use {@link Project#createTask} to register a new Task.

Parent(s)
\Task < \ProjectComponent
See
\BatchTest  
Author
Michiel Rook  
Copyright
2001,2002 THYRELL. All rights reserved  
Since
2.1.0  
Version
$Id: 4554fdd642b6ef7774cbb89c537ccba90f3ca972 $  

Properties

Propertyprivate  $batchtests= 'array()'
Default valuearray()Details
Type
n/a
Propertyprivate  $bootstrap= '""'
Default value""Details
Type
n/a
Propertyprivate  $codecoverage= 'null'
Default valuenullDetails
Type
n/a
Propertyprotectedstring  $description= ''
inherited

Description of the task

Inherited from: \Task::$$description
Details
Type
string
Inherited_from
\Task::$$description  
Propertyprivate  $errorproperty= ''
Details
Type
n/a
Propertyprivate  $excludeGroups= 'array()'
Default valuearray()Details
Type
n/a
Propertyprivate  $failureproperty= ''
Details
Type
n/a
Propertyprivate  $formatters= 'array()'
Default valuearray()Details
Type
n/a
Propertyprivate  $groups= 'array()'
Default valuearray()Details
Type
n/a
Propertyprivate  $haltonerror= 'false'
Default valuefalseDetails
Type
n/a
Propertyprivate  $haltonfailure= 'false'
Default valuefalseDetails
Type
n/a
Propertyprivate  $haltonincomplete= 'false'
Default valuefalseDetails
Type
n/a
Propertyprivate  $haltonskipped= 'false'
Default valuefalseDetails
Type
n/a
Propertyprivate  $incompleteproperty= ''
Details
Type
n/a
Propertyprotected\Location  $location= ''
inherited

Stored buildfile location

Inherited from: \Task::$$location
Details
Type
\Location
Inherited_from
\Task::$$location  
Propertyprivate  $printsummary= 'false'
Default valuefalseDetails
Type
n/a
Propertyprivate  $processIsolation= 'false'
Default valuefalseDetails
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  
Propertyprivate  $skippedproperty= ''
Details
Type
n/a
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  $testfailed= 'false'
Default valuefalseDetails
Type
n/a
Propertyprivate  $testfailuremessage= '""'
Default value""Details
Type
n/a
Propertyprivate  $usecustomerrorhandler= 'true'
Default valuetrueDetails
Type
n/a
Propertyprotected\RuntimeConfigurable  $wrapper= ''
inherited

Wrapper of the task

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

Methods

methodpublicaddFormatter( \FormatterElement $fe ) : void

Add a new formatter to all tests of this task.

Parameters
Name Type Description
$fe \FormatterElement

formatter element

methodpubliccreateBatchTest( ) : \BatchTest

Adds a set of tests based on pattern matching.

Returns
Type Description
\BatchTest a new instance of a batch test.
methodprotectedexecute(  $suite ) : void

Parameters
Name Type Description
$suite
Throws
Exception Description
\BuildException
methodprotectedgetDefaultOutput( ) : void

methodpublicgetDescription( ) : string
inherited

Returns the textual description of the task

Inherited from: \Task::getDescription()
Returns
Type Description
string The text description of the task
methodpublicgetHaltonfailure( ) : void

methodpublicgetHaltonincomplete( ) : void

methodpublicgetHaltonskipped( ) : void

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
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
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)
methodpublicinit( ) : void

Initialize Task.

This method includes any necessary PHPUnit libraries and triggers appropriate error if they cannot be found. This is not done in header because we may want this class to be loaded w/o triggering an error.

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

The main entry point

Should throw a BuildException if someting goes wrong with the build

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

Throws
Exception Description
\BuildException
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()
methodpublicsetBootstrap( string $bootstrap ) : void

Sets the name of a bootstrap file that is run before executing the tests

Parameters
Name Type Description
$bootstrap string

the name of the bootstrap file

methodpublicsetCodecoverage(  $codecoverage ) : void

Parameters
Name Type Description
$codecoverage
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

methodpublicsetErrorproperty(  $value ) : void

Parameters
Name Type Description
$value
methodpublicsetExcludeGroups(  $excludeGroups ) : void

Parameters
Name Type Description
$excludeGroups
methodpublicsetFailureproperty(  $value ) : void

Parameters
Name Type Description
$value
methodpublicsetGroups(  $groups ) : void

Parameters
Name Type Description
$groups
methodpublicsetHaltonerror(  $value ) : void

Parameters
Name Type Description
$value
methodpublicsetHaltonfailure(  $value ) : void

Parameters
Name Type Description
$value
methodpublicsetHaltonincomplete(  $value ) : void

Parameters
Name Type Description
$value
methodpublicsetHaltonskipped(  $value ) : void

Parameters
Name Type Description
$value
methodpublicsetIncompleteproperty(  $value ) : void

Parameters
Name Type Description
$value
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.

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

methodpublicsetPrintsummary(  $printsummary ) : void

Parameters
Name Type Description
$printsummary
methodpublicsetProcessIsolation(  $processIsolation ) : void

Parameters
Name Type Description
$processIsolation
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

methodpublicsetSkippedproperty(  $value ) : void

Parameters
Name Type Description
$value
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)

methodpublicsetUseCustomErrorHandler(  $usecustomerrorhandler ) : void

Parameters
Name Type Description
$usecustomerrorhandler
Documentation was generated by DocBlox 0.18.1.