Task for setting properties in buildfiles.
Use \Project#createTask to register a new Task.
author |
Andreas Aderhold andi@binarycloud.com |
---|---|
author |
Hans Lellelid hans@xmpl.org |
version |
$Id: 167cdf37f6ac30565e1ae60aa5194ad5f048fdfc $ |
package |
phing.tasks.system |
addProperties( $props)
addProperty(string $name, string $value)
string
name of property
string
value to set
addText( $value)
since | 2.2.0 |
---|---|
createFilterChain() : object
access |
public |
---|---|
object
The created filterchain object
getDescription() : string
string
The text description of the task
getEnvironment()
getFallback()
getFile()
getLocation() : \Location
getName()
getOverride()
getOwningTarget() : \Target
getPrefix() : string
since | 2.0 |
---|---|
string
getProject() : \Project
getRefid()
getRegisterSlot(string $slotName)
string
getRuntimeConfigurableWrapper() : \RuntimeConfigurable
getTaskName() : string
string
Name of this task
getTaskType() : string
string
The type of this task (XML Tag)
getUserProperty()
getValue()
init()
Should throw a BuildException if something goes wrong with the build
This is abstract here, but may not be overloaded by subclasses.
throws | |
---|---|
loadEnvironment(string $prefix)
string
prefix to place before them
log(string $msg, integer $level = \Project::MSG_INFO)
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()
parsePropertyString(string $value, &$fragments, &$propertyRefs)
This is slower than regex, but useful for this class, which has to handle multiple parsing passes for properties.
string
The string to be scanned for property references
perform()
resolveAllProperties(\Properties $props) : void
setDescription(string $desc)
string
The text describing the task
setEnvironment( $env)
Thus if you specify environment="myenv" you will be able to access OS-specific environment variables via property names "myenv.PATH" or "myenv.TERM".
Note that if you supply a property name with a final
"." it will not be doubled. ie environment="myenv." will still
allow access of environment variables through "myenv.PATH" and
"myenv.TERM". This functionality is currently only implemented
on select platforms. Feel free to send patches to increase the number of platforms
this functionality is supported on ;).
Note also that properties are case sensitive, even if the
environment variables on your operating system are not, e.g. it
will be ${env.Path} not ${env.PATH} on Windows 2000.
setFile( $file)
setLocation(\Location $location)
setName( $name)
setOverride( $v)
setOwningTarget(\Target $target)
setPrefix(string $prefix) : void
A "." is appended to the prefix if not specified.
since | 2.0 |
---|
string
prefix string
setProject(\Project $project)
setRuntimeConfigurableWrapper(\RuntimeConfigurable $wrapper)
setTaskName(string $name) : string
string
string
A string representing the name of this task for log
setTaskType( $name)
setUserProperty(boolean $v)
This is deprecated in Ant 1.5, but the userProperty attribute of the class is still being set via constructor, so Phing will allow this method to function.
boolean
setValue( $value)
toString()
name :
value :
reference :
env :
file :
ref :
prefix :
fallback :
override :
userProperty :
filterChains :
description : string
var |
---|
string
taskType : string
var |
---|
string
taskName : string
var |
---|
string
project : \Project