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: e25b4d62e56e9dad7e7e776ef7214a9557e0f18d $ |
package |
phing.tasks.system |
__construct(\FileParserFactoryInterface $fileParserFactory = null)
addProperties( $props)
throws | |
---|---|
addProperty(string $name, string $value)
string
name of property
string
value to set
createFilterChain() : object
object
The created filterchain object
getDescription() : string
string
The text description of the task
getEnvironment()
getFallback()
getFile()
getLocation() : \Location
getLogoutput() : boolean
boolean
getName()
getOverride() : boolean
boolean
getOwningTarget() : \Target
getPrefix() : string
since | 2.0 |
---|---|
string
getProject() : \Project
getRefid()
getRegisterSlot(string $slotName) : \RegisterSlot
getRuntimeConfigurableWrapper() : \RuntimeConfigurable
getTaskName() : string
string
Name of this task
getTaskType() : string
string
The type of this task (XML Tag)
getUserProperty() : boolean
boolean
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) : void
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.
throws | |
---|---|
string
The string to be scanned for property references
perform()
throws | |
---|---|
resolveAllProperties(\Properties $props) : void
setDescription(string $desc)
string
The text describing the task
setFile( $file)
setLocation(\Location $location)
setLogoutput( $logOutput)
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) : void
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() : string
string
name :
value :
reference :
env :
file :
ref :
prefix :
fallback :
override :
userProperty :
filterChains :
logOutput :
fileParserFactory : \FileParserFactoryInterface
description : string
var |
---|
string
taskType : string
var |
---|
string
taskName : string
var |
---|
string
project : \Project