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 |
---|---|
author | Hans Lellelid |
version | $Id: 7e67218e8e616860f9c746f9ab600f523089ea2e $ |
package | phing |
__construct()
_makeCircularException($end, $stk)
_topoSort(string $root, array $targets) : \An
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
\An
array of Strings with the names of the targets in
sorted order._tsort($root, $targets, $state, $visiting, $ret)
addBuildListener(\BuildListener $listener)
addDataTypeDefinition(string $typeName, string $typeClass, string $classpath)
string
Name of the type.
string
The class to use.
string
The classpath to use.
addReference(string $name, object $object)
This method is called when the parser detects a id="foo" attribute. It passes the id as $name and a reference to the object assigned to this id as $value
string
object
addTaskDefinition(string $name, string $class, string $classpath)
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
string
Type name
\BuildException |
Exception |
---|
object
A datatype objectcreateTask(string $taskType) : \Task
This method is sorta factory like. A local instance is created and a reference returned to that instance. Usually PHP destroys local variables when the function call ends. But not if you return a reference to that variable. 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.
string
Task name
\BuildException |
Exception |
---|
\Task
A task objectexecuteTarget(string $targetName) : void
executeTargets(array $targetNames) : void
fireBuildFinished($exception)
fireBuildStarted()
fireMessageLogged($object, $message, $priority)
fireMessageLoggedEvent($event, $message, $priority)
fireTargetFinished($target, $exception)
fireTargetStarted($target)
fireTaskFinished($task, $exception)
fireTaskStarted($task)
getBasedir() : \PhingFile
access | public |
---|---|
author | Andreas Aderhold, andi@binarycloud.com |
\BuildException |
---|
\PhingFile
Basedir PhingFile objectgetBuildListeners()
getDataTypeDefinitions() : array
array
getDefaultTarget() : string
string
getDescription() : string | null
string
null
getGlobalFilterSet()
getName() : string
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 definedgetReferences() : array
array
getTargets() : array
array
getTaskDefinitions() : array
array
getUserProperties() : \a
\a
hashtable containing just the user propertiesgetUserProperty(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()
log(string $msg, int $level)
string
int
logObject($obj, $msg, $level)
removeBuildListener(\BuildListener $listener)
replaceProperties(\value $value) : \the
exception | BuildException if the given value has an unclosed
property name, e.g. ${xxx |
---|
\value
The string to be scanned for property references. May be null
.
\the
given string with embedded property names replaced
by values, or null
if the given string is
null
.resolveFile($fileName, $rootDir)
setDefaultTarget(string $targetName)
string
setDescription(string $description)
string
setInheritedProperty(string $name, string $value)
Any previous value is overwritten. Also marks these properties as properties that have not come from the command line.
see | \global\#setProperty() |
---|
string
The name of property to set. Must not be null
.
string
The new value of the property. Must not be null
.
setName(string $name) : void
setNewProperty(string $name, string $value)
If the property exists already, a message is logged and the method returns with no other effect.
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
Any existing property of the same name is overwritten, unless it is a user property.
string
The name of property to set. Must not be null
.
string
The new value of the property. Must not be null
.
setSystemProperties() : void
setUserProperty(string $name, string $value)
Any previous value is overwritten.
see | \global\#setProperty() |
---|
string
The name of property to set. Must not be null
.
string
The new value of the property. Must not be null
.
setPropertyInternal(\name $name, \value $value)
\name
The name of the property. Must not be null
.
\value
The property value. Must not be null
.
$basedir
$defaultTarget
$description
$fileUtils
$globalFilterSet
$globalFilters
$inheritedProperties
Mapping is String to String.
$inputHandler
$listeners
$name
$phingVersion
$properties
$references
$targets
$taskdefs
$typedefs
$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.
MSG_DEBUG
MSG_ERR
MSG_INFO
MSG_VERBOSE
MSG_WARN