ForeachTask

Extends \Task

<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 ",".

author	Jason Hines jason@greenhell.com
author	Hans Lellelid hans@xmpl.org
version	$Id: 70c954d4be94b47661fdf20450e77b9592e4f4b3 $
package	phing.tasks.system

Methods

Called by the parser to let the task initialize properly.

init()

inherited

Should throw a BuildException if something goes wrong with the build

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

throws

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

inherited abstract

Should throw a BuildException if someting goes wrong with the build

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

Processes a list of files & directories

process(\Task $callee, \PhingFile $fromDir, array $srcFiles, array $srcDirs)

Arguments

$callee

\Task

$fromDir

\PhingFile

$srcFiles

array

$srcDirs

array

setList

setList($list)

Arguments

$list

setTarget

setTarget($target)

Arguments

$target

setParam

setParam($param)

Arguments

$param

setAbsparam

setAbsparam($absparam)

Arguments

$absparam

setDelimiter

setDelimiter($delimiter)

Arguments

$delimiter

Nested creator, adds a set of files (nested fileset attribute).

createFileSet()

Nested creator, creates one Mapper for this task

createMapper() : object

access	public
throws

Response

object

The created Mapper type object

createProperty

createProperty() : \Property

Response

\Property

Supports embedded <filelist> element.

createFileList() : \FileList

Response

\FileList

Sets the owning target this task belongs to.

setOwningTarget(\Target $target)

inherited

Arguments

$target

\Target

Returns the owning target of this task.

getOwningTarget() : \Target

inherited

Response

\Target

The target object that owns this task

Returns the name of task, used only for log messages

getTaskName() : string

inherited

Response

string

Name of this task

Sets the name of this task for log messages

setTaskName(string $name) : string

inherited

Arguments

$name

string

Response

string

A string representing the name of this task for log

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

getTaskType() : string

inherited

Response

string

The type of this task (XML Tag)

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

setTaskType($name)

inherited

Arguments

$name

Returns a name

getRegisterSlot(string $slotName)

inherited

Arguments

$slotName

string

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

Sets a textual description of the task

setDescription(string $desc)

inherited

Arguments

$desc

string

The text describing the task

Returns the textual description of the task

getDescription() : string

inherited

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

inherited

Response

\Location

The location object describing the position of this task within the buildfile.

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

setLocation(\Location $location)

inherited

Arguments

$location

\Location

The location object describing the position of this task within the buildfile.

Returns the wrapper object for runtime configuration

getRuntimeConfigurableWrapper() : \RuntimeConfigurable

inherited

Response

\RuntimeConfigurable

The wrapper object used by this task

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

setRuntimeConfigurableWrapper(\RuntimeConfigurable $wrapper)

inherited

Arguments

$wrapper

\RuntimeConfigurable

The wrapper object this task should use

Configure this task if it hasn't been done already.

maybeConfigure()

inherited

Perfrom this task

perform()

inherited

References the project to the current component.

setProject(\Project $project)

inherited

Arguments

$project

\Project

The reference to the current project

Returns a reference to current project

getProject() : \Project

inherited

Response

\Project

Reference to current porject object

Properties

Delimter-separated list of values to process.

list :

Name of parameter to pass to callee

param :

Name of absolute path parameter to pass to callee

absparam :

Delimiter that separates items in $list

delimiter :

PhingCallTask that will be invoked w/ calleeTarget.

callee : \PhingCallTask

var

Type(s)

\PhingCallTask

Array of filesets

filesets :

Instance of mapper *

mapperElement :

Array of filelists

filelists : array

var

Type(s)

array

Target to execute.

calleeTarget : string

var

Type(s)

string

Total number of files processed

total_files : integer

var

Type(s)

integer

Total number of directories processed

total_dirs : integer

var

Type(s)

integer

Owning Target object

target : \Target

inherited

var

Type(s)

\Target

Description of the task

description : string

inherited

var

Type(s)

string

Internal taskname (req)

taskType : string

inherited

var

Type(s)

string

Taskname for logger

taskName : string

inherited

var

Type(s)

string

Stored buildfile location

location : \Location

inherited

var

Type(s)

\Location

Wrapper of the task

wrapper : \RuntimeConfigurable

inherited

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