PropertyTask

Extends \Task

Task for setting properties in buildfiles.

Use \Project#createTask to register a new Task.

author

Andreas Aderhold [email protected]

author

Hans Lellelid [email protected]

version

$Id: c49d4edf66bb9cd1fb2d591f8433a1d1f0f46c49 $

package

phing.tasks.system

Methods

__construct

__construct() 
inherited

addFilterChain

addFilterChain(\FilterChain $filterChain) 
inherited

Arguments

$filterChain

\FilterChain

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

addProperties( $props) 
Throws
\BuildException

Arguments

$props

add a name value pair to the project property set

addProperty(string $name, string $value) 

Arguments

$name

string

name of property

$value

string

value to set

Returns the description of the current action.

getDescription() : string
inherited

Response

string

the description of the current action, or null if no description is available.

getEnvironment

getEnvironment() 

getFallback

getFallback() 

Get the PhingFile that is being used as property source.

getFile() 

getFilterChains

getFilterChains() : array<mixed,\FilterChain>
inherited

Response

array<mixed,\FilterChain>

Returns the file/location where this task was defined.

getLocation() : \Location
inherited

Response

\Location

the file/location where this task was defined. Should not return null.

getLogoutput

getLogoutput() : boolean

Response

boolean

Get property component name.

getName() 

getOverride

getOverride() : boolean

Response

boolean

Returns the owning target of this task.

getOwningTarget() : \Target
inherited

Response

\Target

The target object that owns this task

getPrefix

getPrefix() : string
since 2.0

Response

string

Returns a reference to current project

getProject() : \Project
inherited

Response

\Project

Reference to current porject object

getQuiet

getQuiet() : boolean

Response

boolean

getRefid

getRefid() 

Returns a name

getRegisterSlot(string $slotName) : \RegisterSlot
inherited

Arguments

$slotName

string

Response

\RegisterSlot

Returns the wrapper object for runtime configuration

getRuntimeConfigurableWrapper() : \RuntimeConfigurable
inherited

Response

\RuntimeConfigurable

The wrapper object used by this task

Returns the name of task, used only for log messages

getTaskName() : string
inherited

Response

string

Name of this task

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)

getUserProperty

getUserProperty() : boolean

Response

boolean

Get the value of current property component.

getValue() 

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
\BuildException

load the environment values

loadEnvironment(string $prefix) 

Arguments

$prefix

string

prefix to place before them

load properties from a file.

loadFile(\PhingFile $file) 
Throws
\BuildException

Arguments

$file

\PhingFile

Logs a message with the given priority.

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

Arguments

$msg

string

The message to be logged.

$level

integer

The message's priority at this message should have

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.

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

maybeConfigure() 
inherited

Perfrom this task

perform() : void
inherited
Throws
\BuildException
\Error

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

resolveAllProperties(\Properties $props) : void
Throws
\BuildException

Arguments

$props

\Properties

The collection of Properties that need to be resolved.

Sets a description of the current action. This may be used for logging purposes.

setDescription(string $desc) 
inherited

Arguments

$desc

string

Description of the current action. May be null, indicating that no description is available.

the prefix to use when retrieving environment variables.

setEnvironment(string $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.

Arguments

$env

string

setFallback

setFallback(\Project $p) 

Arguments

Set a file to use as the source for properties.

setFile( $file) 

Arguments

$file

Sets the file/location where this task was defined.

setLocation(\Location $location) 
inherited

Arguments

$location

\Location

The file/location where this task was defined. Should not be null

setLogoutput

setLogoutput( $logOutput) 

Arguments

$logOutput

Sets a the name of current property component

setName( $name) 

Arguments

$name

setOverride

setOverride( $v) 

Arguments

$v

Sets the owning target this task belongs to.

setOwningTarget(\Target $target) 
inherited

Arguments

$target

\Target

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

setPrefix(string $prefix) : void

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

since 2.0

Arguments

$prefix

string

prefix string

References the project to the current component.

setProject(\Project $project) : void
inherited

Arguments

$project

\Project

The reference to the current project

Set quiet mode, which suppresses warnings if chmod() fails.

setQuiet( $bool) 
see \setFailonerror()

Arguments

$bool

setRefid

setRefid(\Reference $ref) 

Arguments

$ref

\Reference

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

Sets the name of this task for log messages

setTaskName(string $name) 
inherited

Arguments

$name

string

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

setTaskType(string $name) 
inherited

Arguments

$name

string

The type of this task (XML Tag)

Set whether this is a user property (ro).

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.

Arguments

$v

boolean

Sets a the value of current property component.

setValue(mixed $value) 

Arguments

$value

mixed

Value of name, all scalars allowed

toString

toString() : string

Response

string

Properties

name of the property

name : string
var

name of the property

Type(s)

string

value of the property

value : mixed
var

value of the property

Type(s)

mixed

reference

reference : \Reference
var

Type(s)

\Reference

environment

env : string
var

environment

Type(s)

string

file

file : \PhingFile
var

Type(s)

\PhingFile

prefix

prefix : string
var

Type(s)

string

fallback

fallback : \Project
var

Type(s)

\Project

Whether to force overwrite of existing property.

override : 

Type(s)

Whether property should be treated as "user" property.

userProperty : 

Type(s)

Whether to log messages as INFO or VERBOSE

logOutput : 

Type(s)

fileParserFactory

fileParserFactory : \FileParserFactoryInterface

Whether a warning should be displayed when the property ismissing.

quiet : 

Type(s)

filterChains

filterChains : array<mixed,\FilterChain>
inherited
var

Type(s)

array<mixed,\FilterChain>

Owning Target object

target : \Target
inherited
var

Type(s)

\Target

Internal taskname (req)

taskType : string
inherited
var

Type(s)

string

Taskname for logger

taskName : string
inherited
var

Type(s)

string

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

location

location : \Location
inherited
var

Type(s)

\Location

description

description : string
inherited
var

Type(s)

string