tasks/system/TaskdefTask.php
inherited
Classes
\TaskdefTask
Register a task for use within a buildfile.
This is for registering your own tasks -- or any non-core Task -- for use within a buildfile. If you find that you are using a particular class frequently, you may want to edit the phing/tasks/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 TypeDefTask (right now these are just too simple to really justify creating an abstract class)
- Parent(s)
- \Task < \ProjectComponent
- Author
- Hans Lellelid
- Version
- $Revision: 1224 $
Properties
string
$classname= ''
Classname of task to register.
This can be a dot-path -- relative to a location on PHP include_path. E.g. path.to.MyClass -> path/to/MyClass.php
- Type
- string
\Path
$classpath= ''
Path to add to PHP include_path to aid in finding specified class.
- Type
- \Path
$classpathId= ''
Refid to already defined classpath
- Type
- n/a
$name= ''
Tag name for task that will be used in XML
- Type
- n/a
string
$typeFile= ''
Name of file to load multiple definitions from.
- Type
- string
Methods
createClasspath(
)
:
\PathCreate the classpath to be used when searching for component being defined
| Type | Description |
|---|---|
| \Path |
getDescription(
)
:
voidgetLocation(
)
:
voidgetOwningTarget(
)
:
voidgetProject(
)
:
voidgetRegisterSlot(
)
:
voidgetRuntimeConfigurableWrapper(
)
:
voidgetTaskName(
)
:
voidgetTaskType(
)
:
voidinit(
)
:
voidlog(
)
:
voidmain(
)
:
voidMain entry point
maybeConfigure(
)
:
voidperform(
)
:
voidsetClassname(
string $class
)
:
voidSets the class name / dotpath to use.
| Name | Type | Description |
|---|---|---|
| $class | string |
setClasspath(
\Path $classpath
)
:
voidSet the classpath to be used when searching for component being defined
| Name | Type | Description |
|---|---|---|
| $classpath | \Path | A Path object containing the classpath. |
setClasspathRef(
$r
)
:
voidReference to a classpath to use when loading the files.
| Name | Type | Description |
|---|---|---|
| $r |
setDescription(
)
:
voidsetFile(
string $file
)
:
voidSets the file of definitionas to use to use.
| Name | Type | Description |
|---|---|---|
| $file | string |
setLocation(
)
:
voidsetName(
string $name
)
:
voidSets the name that will be used in XML buildfile.
| Name | Type | Description |
|---|---|---|
| $name | string |
setOwningTarget(
)
:
voidsetProject(
)
:
voidsetRuntimeConfigurableWrapper(
)
:
voidsetTaskName(
)
:
voidsetTaskType(
)
:
void