tasks/system/ForeachTask.php
inherited
Classes
\ForeachTask
<foreach> task
Task definition for the foreach task. This task takes a list with delimited values, and executes a target with set param.
Usage:
Attributes: list --> The list of values to process, with the delimiter character, indicated by the "delimiter" attribute, separating each value. target --> The target to call for each token, passing the token as the parameter with the name indicated by the "param" attribute. param --> The name of the parameter to pass the tokens in as to the target. delimiter --> The delimiter string that separates the values in the "list" parameter. The default is ",".
- Parent(s)
- \Task < \ProjectComponent
- Author
- Jason Hines
- Author
- Hans Lellelid
- Version
- $Revision: 1331 $
Properties
$absparam= ''
Name of absolute path parameter to pass to callee
- Type
- n/a
\PhingCallTask
$callee= ''
PhingCallTask that will be invoked w/ calleeTarget.
- Type
- \PhingCallTask
string
$calleeTarget= ''
Target to execute.
- Type
- string
$delimiter= '',''
Delimiter that separates items in $list
','Details- Type
- n/a
array
$filelists= 'array()'
Array of filelists
array()Details- Type
- array
$filesets= 'array()'
Array of filesets
array()Details- Type
- n/a
$list= ''
Delimter-separated list of values to process.
- Type
- n/a
$mapperElement= ''
Instance of mapper *
- Type
- n/a
$param= ''
Name of parameter to pass to callee
- Type
- n/a
integer
$total_dirs= '0'
Total number of directories processed
0Details- Type
- integer
integer
$total_files= '0'
Total number of files processed
0Details- Type
- integer
Methods
createFileSet(
)
:
voidNested creator, adds a set of files (nested fileset attribute).
createMapper(
)
:
objectNested creator, creates one Mapper for this task
| Type | Description |
|---|---|
| object | The created Mapper type object |
| Exception | Description |
|---|---|
| \BuildException |
- Access
- public
createProperty(
)
:
\Property| Type | Description |
|---|---|
| \Property |
getDescription(
)
:
voidgetLocation(
)
:
voidgetOwningTarget(
)
:
voidgetProject(
)
:
voidgetRegisterSlot(
)
:
voidgetRuntimeConfigurableWrapper(
)
:
voidgetTaskName(
)
:
voidgetTaskType(
)
:
voidinit(
)
:
voidlog(
)
:
voidmain(
)
:
voidThis method does the work.
maybeConfigure(
)
:
voidperform(
)
:
voidprocess(
\Task $callee, \PhingFile $fromDir, array $srcFiles, array $srcDirs
)
:
voidProcesses a list of files & directories
| Name | Type | Description |
|---|---|---|
| $callee | \Task | |
| $fromDir | \PhingFile | |
| $srcFiles | array | |
| $srcDirs | array |
setAbsparam(
$absparam
)
:
void| Name | Type | Description |
|---|---|---|
| $absparam |
setDelimiter(
$delimiter
)
:
void| Name | Type | Description |
|---|---|---|
| $delimiter |
setDescription(
)
:
voidsetList(
$list
)
:
void| Name | Type | Description |
|---|---|---|
| $list |
setLocation(
)
:
voidsetOwningTarget(
)
:
voidsetParam(
$param
)
:
void| Name | Type | Description |
|---|---|---|
| $param |
setProject(
)
:
voidsetRuntimeConfigurableWrapper(
)
:
voidsetTarget(
$target
)
:
void| Name | Type | Description |
|---|---|---|
| $target |
setTaskName(
)
:
voidsetTaskType(
)
:
void