tasks/system/PropertyTask.php
inherited
Classes
\PropertyTask
Task for setting properties in buildfiles.
- Parent(s)
- \Task < \ProjectComponent
- Children
- \XmlPropertyTask
- Author
- Andreas Aderhold
- Author
- Hans Lellelid
- Version
- $Revision: 552 $
Properties
$env= ''
- Type
- n/a
$fallback= ''
- Type
- n/a
$file= ''
- Type
- n/a
$name= ''
name of the property
- Type
- n/a
$override= 'false'
Whether to force overwrite of existing property.
falseDetails- Type
- n/a
$prefix= ''
- Type
- n/a
$ref= ''
- Type
- n/a
$reference= ''
- Type
- n/a
$userProperty= 'false'
Whether property should be treated as "user" property.
falseDetails- Type
- n/a
$value= ''
value of the property
- Type
- n/a
Methods
addProperties(
$props
)
:
voiditerate through a set of properties, resolve them then assign them
| Name | Type | Description |
|---|---|---|
| $props |
addProperty(
string $name, string $value
)
:
voidadd a name value pair to the project property set
| Name | Type | Description |
|---|---|---|
| $name | string | name of property |
| $value | string | value to set |
addText(
$value
)
:
voidSets value of property to CDATA tag contents.
| Name | Type | Description |
|---|---|---|
| $value |
- Since
- 2.2.0
getDescription(
)
:
voidgetEnvironment(
)
:
voidgetFallback(
)
:
voidgetFile(
)
:
voidGet the PhingFile that is being used as property source.
getLocation(
)
:
voidgetName(
)
:
voidGet property component name.
getOverride(
)
:
voidgetOwningTarget(
)
:
voidgetPrefix(
)
:
string| Type | Description |
|---|---|
| string |
- Since
- 2.0
getProject(
)
:
voidgetRefid(
)
:
voidgetRegisterSlot(
)
:
voidgetRuntimeConfigurableWrapper(
)
:
voidgetTaskName(
)
:
voidgetTaskType(
)
:
voidgetUserProperty(
)
:
voidgetValue(
)
:
voidGet the value of current property component.
init(
)
:
voidloadEnvironment(
string $prefix
)
:
voidload the environment values
| Name | Type | Description |
|---|---|---|
| $prefix | string | prefix to place before them |
loadFile(
\PhingFile $file
)
:
voidload properties from a file.
| Name | Type | Description |
|---|---|---|
| $file | \PhingFile |
log(
)
:
voidmain(
)
:
voidset the property in the project to the value.
if the task was give a file or env attribute here is where it is loaded
maybeConfigure(
)
:
voidparsePropertyString(
string $value, array $fragments, array $propertyRefs
)
:
voidThis method will parse a string containing ${value} style property values into two lists. The first list is a collection of text fragments, while the other is a set of string property names null entries in the first list indicate a property reference from the second list.
This is slower than regex, but useful for this class, which has to handle multiple parsing passes for properties.
| Name | Type | Description |
|---|---|---|
| $value | string | The string to be scanned for property references |
| $fragments | array | &$fragments The found fragments |
| $propertyRefs | array | &$propertyRefs The found refs |
perform(
)
:
voidresolveAllProperties(
\Properties $props
)
:
voidGiven a Properties object, this method goes through and resolves any references to properties within the object.
| Name | Type | Description |
|---|---|---|
| $props | \Properties | The collection of Properties that need to be resolved. |
setDescription(
)
:
voidsetEnvironment(
\env $env
)
:
voidthe prefix to use when retrieving environment variables.
Thus if you specify environment="myenv" you will be able to access OS-specific environment variables via property names "myenv.PATH" or "myenv.TERM".
<
p>
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.
| Name | Type | Description |
|---|---|---|
| $env | \env | prefix |
setFile(
$file
)
:
voidSet a file to use as the source for properties.
| Name | Type | Description |
|---|---|---|
| $file |
setLocation(
)
:
voidsetName(
$name
)
:
voidSets a the name of current property component
| Name | Type | Description |
|---|---|---|
| $name |
setOverride(
$v
)
:
void| Name | Type | Description |
|---|---|---|
| $v |
setOwningTarget(
)
:
voidsetPrefix(
string $prefix
)
:
voidPrefix to apply to properties loaded using file.
A "." is appended to the prefix if not specified.
| Name | Type | Description |
|---|---|---|
| $prefix | string | prefix string |
- Since
- 2.0
setProject(
)
:
voidsetRefid(
$ref
)
:
void| Name | Type | Description |
|---|---|---|
| $ref |
setRuntimeConfigurableWrapper(
)
:
voidsetTaskName(
)
:
voidsetTaskType(
)
:
voidsetUserProperty(
boolean $v
)
:
voidSet whether this is a user property (ro).
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.
| Name | Type | Description |
|---|---|---|
| $v | boolean |
setValue(
mixed $value
)
:
voidSets a the value of current property component.
| Name | Type | Description |
|---|---|---|
| $value | mixed | Value of name, all scalars allowed |
toString(
)
:
void