Task

Extends \ProjectComponent

The base class for all Tasks.

Use \Project#createTask to register a new Task.

author

Andreas Aderhold andi@binarycloud.com

copyright

2001,2002 THYRELL. All rights reserved

version

$Id: 02ca39be55adc06cf8fd0fa4d3a6c6cc391ea604 $

see
package

phing

Methods

Returns the textual description of the task

getDescription() : string

Response

string

The text description of the task

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

getLocation() : \Location

Response

\Location

The location object describing the position of this

             task within the buildfile.

Returns the owning target of this task.

getOwningTarget() : \Target

Response

\Target

The target object that owns this task

Returns a reference to current project

getProject() : \Project
inherited

Response

\Project

Reference to current porject object

Returns a name

getRegisterSlot(string $slotName) 

Arguments

$slotName

string

Returns the wrapper object for runtime configuration

getRuntimeConfigurableWrapper() : \RuntimeConfigurable

Response

\RuntimeConfigurable

The wrapper object used by this task

Returns the name of task, used only for log messages

getTaskName() : string

Response

string

Name of this task

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

getTaskType() : string

Response

string

The type of this task (XML Tag)

Called by the parser to let the task initialize properly.

init() 

Should throw a BuildException if something goes wrong with the build

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

throws

Logs a message with the given priority.

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

Arguments

$msg

string

The message to be logged.

$level

integer

The message's priority at this message should have

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 <em>phing target1 target2</em> will run all tasks in target3 twice.

main() 
abstract

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

Perfrom this task

perform() 

Sets a textual description of the task

setDescription(string $desc) 

Arguments

$desc

string

The text describing the task

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

setLocation(\Location $location) 

Arguments

$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) 

Arguments

$target

\Target

References the project to the current component.

setProject(\Project $project) 
inherited

Arguments

$project

\Project

The reference to the current project

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

setRuntimeConfigurableWrapper(\RuntimeConfigurable $wrapper) 

Arguments

$wrapper

\RuntimeConfigurable

The wrapper object this task should use

Sets the name of this task for log messages

setTaskName(string $name) : string

Arguments

$name

string

Response

string

A string representing the name of this task for log

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

setTaskType( $name) 

Arguments

$name

Properties

Owning Target object

target : \Target
var

Type(s)

\Target

Description of the task

description : string
var

Type(s)

string

Internal taskname (req)

taskType : string
var

Type(s)

string

Taskname for logger

taskName : string
var

Type(s)

string

Stored buildfile location

location : \Location
var

Type(s)

\Location

Wrapper of the task

wrapper : \RuntimeConfigurable
var

Type(s)

\RuntimeConfigurable

Holds a reference to the project that a project component (a task, a target, etc.) belongs to

project : \Project
inherited
var

A reference to the current project instance

Type(s)

\Project