Register a datatype for use within a buildfile.
This is for registering your own datatypes for use within a buildfile.
If you find that you are using a particular class frequently, you may want to edit the phing/types/defaults.properties file so that it is included by default. You may also want to submit it (if LGPL or compatible license) to be included in Phing distribution.
.
TODO: -- possibly refactor since this is almost the same as TaskDefTask
(right now these are just too simple to really justify creating an abstract class)
author |
Hans Lellelid hans@xmpl.org |
---|---|
version |
$Id: f91ebca00240cc8f22e642115e0aa0da140dc4a4 $ |
package |
phing.tasks.system |
createClasspath() : \Path
getDescription() : string
string
The text description of the task
getLocation() : \Location
getOwningTarget() : \Target
getProject() : \Project
getRegisterSlot(string $slotName) : \RegisterSlot
getRuntimeConfigurableWrapper() : \RuntimeConfigurable
getTaskName() : string
string
Name of this task
getTaskType() : string
string
The type of this task (XML Tag)
init()
Should throw a BuildException if something goes wrong with the build
This is abstract here, but may not be overloaded by subclasses.
throws | |
---|---|
log(string $msg, integer $level = \Project::MSG_INFO) : void
string
The message to be logged.
integer
The message's priority at this message should have
main()
Should throw a BuildException if someting goes wrong with the build
This is abstract here. Must be overloaded by real tasks.
maybeConfigure()
perform()
throws | |
---|---|
setClassname(string $class)
string
setClasspath(\Path $classpath)
setClasspathRef(\Reference $r)
setDescription(string $desc)
string
The text describing the task
setLocation(\Location $location)
setName(string $name)
string
setOwningTarget(\Target $target)
setProject(\Project $project) : void
setRuntimeConfigurableWrapper(\RuntimeConfigurable $wrapper)
setTaskName(string $name) : string
string
string
A string representing the name of this task for log
setTaskType( $name)
name :
classname : string
This can be a dot-path -- relative to a location on PHP include_path. E.g. path.to.MyClass -> path/to/MyClass.php
var |
---|
string
classpath : \Path
classpathId :
description : string
var |
---|
string
taskType : string
var |
---|
string
taskName : string
var |
---|
string
project : \Project