Class: Project
Source Location: /Project.php
The Phing project class. Represents a completely configured Phing project.
Author(s):
Version:
|
|
|
Class Details
Class Methods
constructor __construct [line 110]
Constructor, sets any default vars.
method addBuildListener [line 907]
method addDataTypeDefinition [line 540]
void addDataTypeDefinition(
$typeName,
$typeClass, [string
$classpath = null], string
$name, string
$class)
|
|
Adds a data type definition.
Parameters:
method addOrReplaceTarget [line 562]
void addOrReplaceTarget(
$targetName,
&$target)
|
|
Parameters:
method addReference [line 867]
void addReference(
$name,
$object)
|
|
Adds a reference to an 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
Parameters:
method addTarget [line 555]
void addTarget(
$targetName,
&$target)
|
|
add a new target to the project
Parameters:
method addTaskDefinition [line 516]
void addTaskDefinition(
string
$name, string
$class, [string
$classpath = null])
|
|
Adds a task definition.
Parameters:
method copyInheritedProperties [line 386]
void copyInheritedProperties(
Project
$other)
|
|
Copies all user properties that have not been set on the command line or a GUI tool from this instance to the Project instance given as the argument. To copy all "user" properties, you will also have to call #copyUserProperties.
Tags:
Parameters:
method copyUserProperties [line 365]
void copyUserProperties(
Project
$other)
|
|
Copies all user properties that have been set on the command line or a GUI tool from this instance to the Project instance given as the argument. To copy all "user" properties, you will also have to call #copyInheritedProperties.
Tags:
Parameters:
method createDataType [line 644]
object A createDataType(
string
$typeName)
|
|
Create a task instance and return reference to it See createTask() for explanation how this works
Tags:
Parameters:
method createTask [line 593]
Task createTask(
string
$taskType)
|
|
Create a new task instance and return reference to it. 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.
Tags:
Parameters:
method executeTarget [line 698]
void executeTarget(
string
$targetName)
|
|
Executes a target
Tags:
Parameters:
method executeTargets [line 685]
void executeTargets(
array
$targetNames)
|
|
Executes a list of targets
Tags:
Parameters:
method fireBuildFinished [line 932]
void fireBuildFinished(
$exception)
|
|
Parameters:
method fireBuildStarted [line 925]
method fireMessageLogged [line 977]
void fireMessageLogged(
$object,
$message,
$priority)
|
|
Parameters:
method fireMessageLoggedEvent [line 970]
void fireMessageLoggedEvent(
$event,
$message,
$priority)
|
|
Parameters:
method fireTargetFinished [line 947]
void fireTargetFinished(
$target,
$exception)
|
|
Parameters:
method fireTargetStarted [line 940]
void fireTargetStarted(
$target)
|
|
Parameters:
method fireTaskFinished [line 962]
void fireTaskFinished(
$task,
$exception)
|
|
Parameters:
method fireTaskStarted [line 955]
void fireTaskStarted(
$task)
|
|
Parameters:
method getBasedir [line 474]
Returns the basedir of this project
Tags:
method getBuildListeners [line 921]
void getBuildListeners(
)
|
|
method getDataTypeDefinitions [line 550]
void getDataTypeDefinitions(
)
|
|
method getDefaultTarget [line 404]
method getDescription [line 439]
return the description, null otherwise
method getGlobalFilterSet [line 177]
void getGlobalFilterSet(
)
|
|
returns the global filterset (future use)
method getInputHandler [line 125]
Retrieves the current input handler.
Tags:
method getName [line 429]
Returns the name of this project
Tags:
method getProperties [line 341]
Returns a copy of the properties table.
Tags:
method getProperty [line 287]
string getProperty(
string
$name)
|
|
Returns the value of a property, if it is set.
Tags:
Parameters:
method getReference [line 888]
Returns a specific reference.
Tags:
Parameters:
method getReferences [line 879]
Returns the references array.
method getTargets [line 572]
method getTaskDefinitions [line 530]
void &getTaskDefinitions(
)
|
|
method getUserProperties [line 349]
Returns a copy of the user property hashtable
Tags:
method getUserProperty [line 329]
string getUserProperty(
string
$name)
|
|
Returns the value of a user property, if it is set.
Tags:
Parameters:
method init [line 130]
inits the project, called from main app
method log [line 899]
void log(
$msg, [
$level = Project::MSG_INFO])
|
|
Abstracting and simplifyling Logger calls for project messages
Parameters:
method logObject [line 903]
void logObject(
$obj,
$msg,
$level)
|
|
Parameters:
method removeBuildListener [line 911]
method replaceProperties [line 316]
the replaceProperties(
value
$value)
|
|
Replaces ${} style constructions in the given value with the string value of the corresponding data types.
Tags:
Parameters:
method resolveFile [line 723]
void resolveFile(
$fileName, [
$rootDir = null])
|
|
Parameters:
method setBasedir [line 444]
Set basedir object from xml
Parameters:
method setDefaultTarget [line 400]
void setDefaultTarget(
$targetName)
|
|
Parameters:
method setDescription [line 434]
void setDescription(
$description)
|
|
Set the projects description
Parameters:
method setInheritedProperty [line 257]
void setInheritedProperty(
string
$name, string
$value)
|
|
Sets a user property, which cannot be overwritten by set/unset property calls. Any previous value is overwritten. Also marks these properties as properties that have not come from the command line.
Tags:
Parameters:
method setInputHandler [line 118]
void setInputHandler(
$handler)
|
|
Sets the input handler
Tags:
Parameters:
method setName [line 417]
void setName(
string
$name)
|
|
Sets the name of the current project
Tags:
Parameters:
method setNewProperty [line 221]
void setNewProperty(
string
$name, string
$value)
|
|
Sets a property if no value currently exists. If the property exists already, a message is logged and the method returns with no other effect.
Tags:
Parameters:
method setProperty [line 194]
void setProperty(
string
$name, string
$value)
|
|
Sets a property. Any existing property of the same name is overwritten, unless it is a user property.
Tags:
Parameters:
method setSystemProperties [line 490]
void setSystemProperties(
)
|
|
Sets system properties and the environment variables for this project.
method setUserProperty [line 239]
void setUserProperty(
string
$name, string
$value)
|
|
Sets a user property, which cannot be overwritten by set/unset property calls. Any previous value is overwritten.
Tags:
Parameters:
method _makeCircularException [line 853]
void _makeCircularException(
$end,
$stk)
|
|
Parameters:
method _topoSort [line 740]
An _topoSort(
$root
$root, $targets
&$targets)
|
|
Topologically sort a set of Targets.
Tags:
Parameters:
method _tsort [line 805]
void _tsort(
$root,
&$targets,
&$state,
&$visiting,
&$ret)
|
|
Parameters:
Class Constants
|
|