Phing API Documentation
Back to top  

XmlPropertyTask

Extends \PropertyTask

Task for setting properties from an XML file in buildfiles.

Use {@link Project#createTask} to register a new Task.

author

Jonathan Bond-Caron jbondc@openmv.com
version

$Id: c7a3e7eff0b94828f9ec634c3612d89f2740fead $
package

phing.tasks.ext
since 2.4.0
link

http://ant.apache.org/manual/CoreTasks/xmlproperty.html

Methods

Set a file to use as the source for properties.

setFile($file)
inherited

Arguments

$file

Get the PhingFile that is being used as property source.

getFile()
inherited

Prefix to apply to properties loaded using <code>file</code>.

setPrefix(string $prefix) : void
inherited

A "." is appended to the prefix if not specified.

since 2.0

Arguments

$prefix

string

prefix string

getPrefix

getPrefix() : string
inherited
since 2.0

Response

string

Keep the xml root tag as the first value in the property name

setKeepRoot(bool $yesNo)

Arguments

$yesNo

bool

getKeepRoot

getKeepRoot() : bool

Response

bool

Treat attributes as nested elements.

setCollapseAttributes(bool $yesNo)

Arguments

$yesNo

bool

getCollapseAttributes

getCollapseAttributes() : bool

Response

bool

Delimiter for splitting multiple values.

setDelimiter(string $d)

Arguments

$d

string

getDelimiter

getDelimiter() : string

Response

string

File required or not.

setRequired(string $d)

Arguments

$d

string

getRequired

getRequired() : string

Response

string

Called by the project to let the task do it's work. 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 <em>phing target1 target2</em> will run all tasks in target3 twice.

main()
inherited abstract

Should throw a BuildException if someting goes wrong with the build

This is abstract here. Must be overloaded by real tasks.

load properties from a file.

loadFile(\PhingFile $file)
inherited

Arguments

$file

\PhingFile

Parses an XML file and returns properties

_getProperties(string $filePath) : \Properties

Arguments

$filePath

string

Response

\Properties

Adds an XML node

_addNode(\SimpleXMLElement $node, array $path, \Properties $prop) : void

Arguments

$node

\SimpleXMLElement

$path

array

Path to this node

$prop

\Properties

Properties will be added as they are found (by reference here)

Sets a the name of current property component

setName($name)
inherited

Arguments

$name

Get property component name.

getName()
inherited

Sets a the value of current property component.

setValue($value)
inherited

Arguments

$value

Sets value of property to CDATA tag contents.

addText($value)
inherited
since 2.2.0

Arguments

$value

Get the value of current property component.

getValue()
inherited

setRefid

setRefid(\Reference $ref)
inherited

Arguments

$ref

\Reference

getRefid

getRefid()
inherited

the prefix to use when retrieving environment variables.

setEnvironment($env)
inherited

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.

Arguments

$env

getEnvironment

getEnvironment()
inherited

Set whether this is a user property (ro).

setUserProperty(boolean $v)
inherited

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.

Arguments

$v

boolean

getUserProperty

getUserProperty()
inherited

setOverride

setOverride($v)
inherited

Arguments

$v

getOverride

getOverride()
inherited

toString

toString()
inherited

setFallback

setFallback(\Project $p)
inherited

Arguments

$p

\Project

getFallback

getFallback()
inherited

Creates a filterchain

createFilterChain() : object
inherited
access

public

Response

object

The created filterchain object

load the environment values

loadEnvironment(string $prefix)
inherited

Arguments

$prefix

string

prefix to place before them

iterate through a set of properties, resolve them then assign them

addProperties($props)
inherited

Arguments

$props

add a name value pair to the project property set

addProperty(string $name, string $value)
inherited

Arguments

$name

string

name of property

$value

string

value to set

Given a Properties object, this method goes through and resolves any references to properties within the object.

resolveAllProperties(\Properties $props) : void
inherited

Arguments

$props

\Properties

The collection of Properties that need to be resolved.

This 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.

parsePropertyString(string $value, $fragments, $propertyRefs)
inherited

This is slower than regex, but useful for this class, which has to handle multiple parsing passes for properties.

Arguments

$value

string

The string to be scanned for property references

$fragments

$propertyRefs

Sets the owning target this task belongs to.

setOwningTarget(\Target $target)
inherited

Arguments

$target

\Target

Returns the owning target of this task.

getOwningTarget() : \Target
inherited

Response

\Target

The target object that owns this task

Returns the name of task, used only for log messages

getTaskName() : string
inherited

Response

string

Name of this task

Sets the name of this task for log messages

setTaskName(string $name) : string
inherited

Arguments

$name

string

Response

string

A string representing the name of this task for log

Returns the name of the task under which it was invoked, usually the XML tagname

getTaskType() : string
inherited

Response

string

The type of this task (XML Tag)

Sets the type of the task. Usually this is the name of the XML tag

setTaskType($name)
inherited

Arguments

$name

Returns a name

getRegisterSlot(string $slotName)
inherited

Arguments

$slotName

string

Logs a message with the given priority.

log(string $msg, integer $level = \Project::MSG_INFO)
inherited

Arguments

$msg

string

The message to be logged.

$level

integer

The message's priority at this message should have

Sets a textual description of the task

setDescription(string $desc)
inherited

Arguments

$desc

string

The text describing the task

Returns the textual description of the task

getDescription() : string
inherited

Response

string

The text description of the task

Called by the parser to let the task initialize properly.

init()
inherited

Should throw a BuildException if something goes wrong with the build

This is abstract here, but may not be overloaded by subclasses.

throws

Returns the location within the buildfile this task occurs. Used by {@link BuildException} to give detailed error messages.

getLocation() : \Location
inherited

Response

\Location

The location object describing the position of this task within the buildfile.

Sets the location within the buildfile this task occurs. Called by the parser to set location information.

setLocation(\Location $location)
inherited

Arguments

$location

\Location

The location object describing the position of this task within the buildfile.

Returns the wrapper object for runtime configuration

getRuntimeConfigurableWrapper() : \RuntimeConfigurable
inherited

Response

\RuntimeConfigurable

The wrapper object used by this task

Sets the wrapper object this task should use for runtime configurable elements.

setRuntimeConfigurableWrapper(\RuntimeConfigurable $wrapper)
inherited

Arguments

$wrapper

\RuntimeConfigurable

The wrapper object this task should use

Configure this task if it hasn't been done already.

maybeConfigure()
inherited

Perfrom this task

perform()
inherited

References the project to the current component.

setProject(\Project $project)
inherited

Arguments

$project

\Project

The reference to the current project

Returns a reference to current project

getProject() : \Project
inherited

Response

\Project

Reference to current porject object

Properties

_keepRoot

_keepRoot :

_collapseAttr

_collapseAttr :

_delimiter

_delimiter :

_required

_required :

name of the property

name :
inherited

value of the property

value :
inherited

reference

reference :
inherited

env

env :
inherited

file

file :
inherited

ref

ref :
inherited

prefix

prefix :
inherited

fallback

fallback :
inherited

Whether to force overwrite of existing property.

override :
inherited

Whether property should be treated as "user" property.

userProperty :
inherited

All filterchain objects assigned to this task

filterChains :
inherited

Owning Target object

target : \Target
inherited
var

Type(s)

\Target

Description of the task

description : string
inherited
var

Type(s)

string

Internal taskname (req)

taskType : string
inherited
var

Type(s)

string

Taskname for logger

taskName : string
inherited
var

Type(s)

string

Stored buildfile location

location : \Location
inherited
var

Type(s)

\Location

Wrapper of the task

wrapper : \RuntimeConfigurable
inherited
var

Type(s)

\RuntimeConfigurable

Holds a reference to the project that a project component (a task, a target, etc.) belongs to

project : \Project
inherited
var

A reference to the current project instance

Type(s)

\Project