tasks/ext/XmlPropertyTask.php
inherited
Classes
Task for setting properties from an XML file in buildfiles.
- Author
- Jonathan Bond-Caron
- Link
- http://ant.apache.org/manual/CoreTasks/xmlproperty.html
- Package
- phing.tasks.ext
- Since
- 2.4.0
- Version
- $Revision: 1110 $
\XmlPropertyTask
Task for setting properties from an XML file in buildfiles.
- Parent(s)
- \PropertyTask < \Task < \ProjectComponent
- Author
- Jonathan Bond-Caron
- Link
- http://ant.apache.org/manual/CoreTasks/xmlproperty.html
- Since
- 2.4.0
- Version
- $Revision: 1110 $
Properties
$_collapseAttr= 'false'
falseDetails- Type
- n/a
$_delimiter= '',''
','Details- Type
- n/a
$_keepRoot= 'true'
trueDetails- Type
- n/a
Methods
_addNode(
\SimpleXMLElement $node, array $path, \Properties $prop
)
:
voidAdds an XML node
| Name | Type | Description |
|---|---|---|
| $node | \SimpleXMLElement | |
| $path | array | Path to this node |
| $prop | \Properties | Properties will be added as they are found (by reference here) |
_getProperties(
string $filePath
)
:
\PropertiesParses an XML file and returns properties
| Name | Type | Description |
|---|---|---|
| $filePath | string |
| Type | Description |
|---|---|
| \Properties |
addProperties(
)
:
voidaddProperty(
)
:
voidaddText(
)
:
voidgetCollapseAttributes(
)
:
bool| Type | Description |
|---|---|
| bool |
getDelimiter(
)
:
string| Type | Description |
|---|---|
| string |
getDescription(
)
:
voidgetEnvironment(
)
:
voidgetFallback(
)
:
voidgetFile(
)
:
voidGet the PhingFile that is being used as property source.
getKeepRoot(
)
:
bool| Type | Description |
|---|---|
| bool |
getLocation(
)
:
voidgetName(
)
:
voidgetOverride(
)
:
voidgetOwningTarget(
)
:
voidgetPrefix(
)
:
string| Type | Description |
|---|---|
| string |
- Since
- 2.0
getProject(
)
:
voidgetRefid(
)
:
voidgetRegisterSlot(
)
:
voidgetRuntimeConfigurableWrapper(
)
:
voidgetTaskName(
)
:
voidgetTaskType(
)
:
voidgetUserProperty(
)
:
voidgetValue(
)
:
voidinit(
)
:
voidloadEnvironment(
)
:
voidloadFile(
\PhingFile $file
)
:
voidload properties from an XML 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(
)
:
voidperform(
)
:
voidresolveAllProperties(
)
:
voidsetCollapseAttributes(
bool $yesNo
)
:
voidTreat attributes as nested elements.
| Name | Type | Description |
|---|---|---|
| $yesNo | bool |
setDelimiter(
string $d
)
:
voidDelimiter for splitting multiple values.
| Name | Type | Description |
|---|---|---|
| $d | string |
setDescription(
)
:
voidsetEnvironment(
)
:
voidsetFallback(
)
:
voidsetFile(
$file
)
:
voidSet a file to use as the source for properties.
| Name | Type | Description |
|---|---|---|
| $file |
setKeepRoot(
bool $yesNo
)
:
voidKeep the xml root tag as the first value in the property name
| Name | Type | Description |
|---|---|---|
| $yesNo | bool |
setLocation(
)
:
voidsetName(
)
:
voidsetOverride(
)
:
voidsetOwningTarget(
)
:
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(
)
:
voidsetRuntimeConfigurableWrapper(
)
:
voidsetTaskName(
)
:
voidsetTaskType(
)
:
voidsetUserProperty(
)
:
voidsetValue(
)
:
voidtoString(
)
:
void