Executes a command on the (filtered) file list/set.
(Loosely based on the "Ant Apply" task - http://ant.apache.org/manual/Tasks/apply.html)
| author | Utsav Handa <handautsav at hotmail dot com> |
|---|---|
| package | phing.tasks.system |
| todo | Add support for mapper, targetfile expressions |
| copyright | 2001,2002 THYRELL. All rights reserved |
| version | $Id$ |
createArg() : void
createSrcfile() : void
getDescription() : string
| inherited_from | \Task::getDescription() |
|---|
stringThe text description of the taskgetFilePath($filename, $basedir, $relative) : mixed
mixedprocessed filenamesgetLocation() : \Location
Used by BuildException to give detailed error messages.
| inherited_from | \Task::getLocation() |
|---|
\LocationThe location object describing the position of this
task within the buildfile.getProject() : \Project
| inherited_from | \ProjectComponent::getProject() |
|---|---|
| inherited_from | \Task::getProject() |
\ProjectReference to current porject objectgetRuntimeConfigurableWrapper() : \RuntimeConfigurable
| inherited_from | \Task::getRuntimeConfigurableWrapper() |
|---|
\RuntimeConfigurableThe wrapper object used by this taskgetTaskName() : string
| inherited_from | \Task::getTaskName() |
|---|
stringName of this taskgetTaskType() : string
| inherited_from | \Task::getTaskType() |
|---|
stringThe type of this task (XML Tag)init() : void
Should throw a BuildException if something goes wrong with the build
This is abstract here, but may not be overloaded by subclasses.
\BuildException |
|---|
log(string $msg, integer $level)
| see | \BuildEvent |
|---|---|
| see | \BuildListener |
| inherited_from | \Task::log() |
stringThe message to log
integerThe priority of the message
main()
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 phing target1 target2 will run all tasks in target3 twice.
Should throw a BuildException if someting goes wrong with the build
This is abstract here. Must be overloaded by real tasks.
\BuildException |
|---|
maybeConfigure()
| inherited_from | \Task::maybeConfigure() |
|---|
perform()
| inherited_from | \Task::perform() |
|---|
setAddsourcefile(Boolean $addsourcefile) : void
BooleanIdentifier for adding source file at the end of command
setAppend($append) : void
setCheckreturn($failonerror)
setDescription(string $desc)
| inherited_from | \Task::setDescription() |
|---|
stringThe text describing the task
setDir(\PhingFile $dir) : void
setError(\PhingFile $errorfile) : void
setEscape(boolean $escape) : void
booleanEscape command before execution
setExecutable(string $executable) : void
stringExecutable path
setFailonerror(boolean $failonerror) : void
booleanIndicator to fail on error
setForwardslash(boolean $forwardslash) : void
booleanIndicator to use forward-slash
setLocation(\Location $location)
Called by the parser to set location information.
| inherited_from | \Task::setLocation() |
|---|
setMaxparallel($max) : void
setOs(string $os) : void
stringOperating system string (e.g. "Linux")
setOutput(\PhingFile $outputfile) : void
setOutputProperty(string $propertyname) : void
stringProperty name
setOwningTarget(\Target $target)
setParallel(Boolean $parallel) : void
BooleanIdentifier for files as arguments appending
setPassthru(boolean $passthru) : void
booleanIf passthru shall be used
setProject(\Project $project)
| inherited_from | \ProjectComponent::setProject() |
|---|---|
| inherited_from | \Task::setProject() |
setRelative($relative) : void
setReturnProperty(string $propertyname) : void
stringProperty name
setRuntimeConfigurableWrapper(\RuntimeConfigurable $wrapper)
| inherited_from | \Task::setRuntimeConfigurableWrapper() |
|---|
setSpawn(boolean $spawn) : void
booleanIf the command is to be run as a background process
setTaskName(string $name) : string
| inherited_from | \Task::setTaskName() |
|---|
string
stringA string representing the name of this task for logsetTaskType(string $name)
Usually this is the name of the XML tag
| inherited_from | \Task::setTaskType() |
|---|
stringThe type of this task (XML Tag)
getRegisterSlot(string $slotName)
| inherited_from | \Task::getRegisterSlot() |
|---|
string
validateOS() : boolean
should be supported
booleanFalse if the exec command shall not be runbuildCommand() : void
cleanup() : void
executeCommand($command) : array
arrayarray(return code, array with output)initialize() : void
process($files, \#basedir $basedir) : void
File list for processing
\#basedirBase directory of the file list
throwBuildException($information) : void
Exception information
$addsourcefile : boolean
$appendoutput : boolean
$commandline : \commandline
$currentdirectory
$currentos
$description : string
| inherited_from | \Task::$$description |
|---|
$dir : \phingfile
$error : \phingfile
$escape : boolean
$failonerror : boolean
$filelists
$filesets : array
$forwardslash : boolean
$loglevel : integer
$maxparallel : integer
$os : string
$osvariant
$output : \phingfile
$outputProperty : string
$parallel : boolean
$passthru : boolean
$project : \Project
| inherited_from | \ProjectComponent::$$project |
|---|---|
| inherited_from | \Task::$$project |
$realCommand : string
$relative : boolean
$returnProperty : string
$spawn : boolean
$taskName : string
| inherited_from | \Task::$$taskName |
|---|
$taskType : string
| inherited_from | \Task::$$taskType |
|---|
SOURCEFILE_ID