The Phing project class. Represents a completely configured Phing project.
The class defines the project and all tasks/targets. It also contains methods to start a build as well as some properties and FileSystem abstraction.
author |
Andreas Aderhold andi@binarycloud.com |
---|---|
author |
Hans Lellelid hans@xmpl.org |
package |
phing |
__construct()
_makeCircularException(string $end, array $stk) : \BuildException
_topoSort(string $root, array &$targets) : array
throws |
---|
string
is the (String) name of the root Target. The sort is created in such a way that the sequence of Targets until the root target is the minimum possible such sequence.
array
is a array representing a "name to Target" mapping
array
of Strings with the names of the targets in sorted order.
_tsort( $root, &$targets, &$state, &$visiting, &$ret)
throws | |
---|---|
addDataTypeDefinition(string $typeName, string $typeClass, string $classpath = null)
string
Name of the type.
string
The class to use.
string
The classpath to use.
addOrReplaceTarget(string $targetName, \Target &$target)
addReference(string $name, object $object)
string
object
addTarget(string $targetName, \Target $target)
addTaskDefinition(string $name, string $class, string $classpath = null)
string
Name of tag.
string
The class path to use.
string
The classpat to use.
copyInheritedProperties(\Project $other)
To copy all "user" properties, you will also have to call \#copyUserProperties.
since |
phing 2.0 |
---|---|
copyUserProperties(\Project $other) : void
To copy all "user" properties, you will also have to call \#copyInheritedProperties.
since |
phing 2.0 |
---|
createCondition(string $conditionType) : \Condition
createDataType(string $typeName) : object
throws |
Exception |
---|
string
Type name
object
A datatype object
createTask(string $taskType) : \Task
This is kinda error prone, because if no reference exists to the variable it is destroyed just like leaving the local scope with primitive vars. There's no central place where the instance is stored as in other OOP like languages.
[HL] Well, ZE2 is here now, and this is still working. We'll leave this alone unless there's any good reason not to.
throws |
Exception |
---|
string
Task name
\Task
A task object
executeTarget(string $targetName) : void
throws |
---|
string
Name of Target to execute
executeTargets(array $targetNames) : void
throws |
---|
array
List of target names to execute
fireBuildFinished(\Exception $exception)
\Exception
fireBuildStarted()
fireMessageLogged( $object, $message, $priority)
fireMessageLoggedEvent( $event, $message, $priority)
fireTargetFinished( $target, $exception)
fireTargetStarted( $target)
fireTaskFinished( $task, $exception)
fireTaskStarted( $task)
getBasedir() : \PhingFile
getBuildListeners() : array
array
getDataTypeDefinitions() : array
array
getDefaultTarget() : string
string
getDescription() : string|null
string|null
getGlobalFilterSet()
getName() : string
author |
Andreas Aderhold, andi@binarycloud.com |
---|---|
string
projectname
getPhingVersion() : string
string
getProperties() : array
array
A hashtable containing all properties (including user properties).
getProperty(string $name) : string
string
The name of the property.
May be null
, in which case
the return value is also null
.
string
The property value, or null
for no match
or if a null
name is provided.
getReference(string $key) : object
string
The reference id/key.
object
Reference or null if not defined
getReferences() : array
array
getTargets() : array
array
getTaskDefinitions() : array
array
getUserProperties() : array
array
a hashtable containing just the user properties
getUserProperty(string $name) : string
string
The name of the property.
May be null
, in which case
the return value is also null
.
string
The property value, or null
for no match
or if a null
name is provided.
init()
isKeepGoingMode() : boolean
boolean
"keep-going" mode
log(string $msg, integer $level = \Project::MSG_INFO)
string
integer
logObject( $obj, $msg, $level)
removeBuildListener(\BuildListener $listener)
replaceProperties(string $value) : string
exception |
BuildException if the given value has an unclosed
property name, e.g. |
---|
string
The value string to be scanned for property references.
May be null
.
string
the given string with embedded property names replaced
by values, or null
if the given string is
null
.
resolveFile( $fileName, null $rootDir = null) : \PhingFile
setBasedir(\PhingFile|string $dir)
setDefaultTarget(string $targetName)
string
setDescription(string $description)
string
setInheritedProperty(string $name, string $value)
see | \#setProperty() |
---|---|
string
The name of property to set.
Must not be null
.
string
The new value of the property.
Must not be null
.
setKeepGoingMode( $keepGoingMode)
setName(string $name) : void
author |
Andreas Aderhold, andi@binarycloud.com |
---|
string
name of project
setNewProperty(string $name, string $value)
since | 2.0 |
---|---|
string
The name of property to set.
Must not be null
.
string
The new value of the property.
Must not be null
.
setPhingVersion(string $version)
string
setProperty(string $name, string $value) : void
string
The name of property to set.
Must not be null
.
string
The new value of the property.
Must not be null
.
setPropertyInternal(string $name, string $value)
string
The name of the property.
Must not be null
.
string
The property value. Must not be null
.
setSystemProperties() : void
setUserProperty(string $name, string $value)
see | \#setProperty() |
---|---|
string
The name of property to set.
Must not be null
.
string
The new value of the property.
Must not be null
.
MSG_DEBUG
MSG_VERBOSE
MSG_INFO
MSG_WARN
MSG_ERR
targets :
globalFilterSet :
globalFilters :
properties :
userProperties :
Note that these key/value pairs are also always put into the project properties, so only the project properties need to be queried. Mapping is String to String.
inheritedProperties :
Mapping is String to String.
taskdefs :
typedefs :
references :
inputHandler :
basedir :
defaultTarget :
name :
description :
phingVersion :
fileUtils :
listeners :
keepGoingMode :