Symfony 1.0.0 : Vue détaillée de Project.php

Classe: Project - X-Ref

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.

__construct() X-Ref

Constructor, sets any default vars.

setInputHandler(InputHandler $handler) X-Ref

Sets the input handler

getInputHandler() X-Ref

Retrieves the current input handler.

init() X-Ref

Pas de description

getGlobalFilterSet() X-Ref

Pas de description

setProperty($name, $value) X-Ref

Sets a property. Any existing property of the same name
is overwritten, unless it is a user property.

param: string $name The name of property to set.
param: string $value The new value of the property.
return: void

setNewProperty($name, $value) X-Ref

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.

param: string $name The name of property to set.
param: string $value The new value of the property.

setUserProperty($name, $value) X-Ref

Sets a user property, which cannot be overwritten by
set/unset property calls. Any previous value is overwritten.

param: string $name The name of property to set.
param: string $value The new value of the property.

setInheritedProperty($name, $value) X-Ref

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.

param: string $name The name of property to set.
param: string $value The new value of the property.

setPropertyInternal($name, $value) X-Ref

Sets a property unless it is already defined as a user property
(in which case the method returns silently).

param: name The name of the property.
param: value The property value. Must not be <code>null</code>.

getProperty($name) X-Ref

Returns the value of a property, if it is set.

param: string $name The name of the property.
return: string The property value, or <code>null</code> for no match

replaceProperties($value) X-Ref

Replaces ${} style constructions in the given value with the
string value of the corresponding data types.

param: value The string to be scanned for property references.
return: the given string with embedded property names replaced

getUserProperty($name) X-Ref

Returns the value of a user property, if it is set.

param: string $name The name of the property.
return: string The property value, or <code>null</code> for no match

getProperties() X-Ref

Returns a copy of the properties table.

return: array A hashtable containing all properties

getUserProperties() X-Ref

Returns a copy of the user property hashtable

return: a hashtable containing just the user properties

copyUserProperties(Project $other) X-Ref

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.

<p>To copy all "user" properties, you will also have to call
{@link #copyInheritedProperties copyInheritedProperties}.</p>

param: Project $other the project to copy the properties to. Must not be null.
return: void

copyInheritedProperties(Project $other) X-Ref

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.

<p>To copy all "user" properties, you will also have to call
{@link #copyUserProperties copyUserProperties}.</p>

param: other the project to copy the properties to. Must not be null.

setDefaultTarget($targetName) X-Ref

Pas de description

getDefaultTarget() X-Ref

Pas de description

setName($name) X-Ref

Sets the name of the current project

author: Andreas Aderhold, andi@binarycloud.com
param: string name of project
return: void

getName() X-Ref

Returns the name of this project

returns: string projectname
author: Andreas Aderhold, andi@binarycloud.com

setDescription($description) X-Ref

Pas de description

getDescription() X-Ref

Pas de description

setBasedir($dir) X-Ref

Pas de description

getBasedir() X-Ref

Returns the basedir of this project

returns: PhingFile Basedir PhingFile object
author: Andreas Aderhold, andi@binarycloud.com

setSystemProperties() X-Ref

Sets system properties and the environment variables for this project.

return: void

addTaskDefinition($name, $class, $classpath = null) X-Ref

Adds a task definition.

param: string $name Name of tag.
param: string $class The class path to use.
param: string $classpath The classpat to use.

getTaskDefinitions() X-Ref

Pas de description

addDataTypeDefinition($typeName, $typeClass, $classpath = null) X-Ref

Adds a data type definition.

param: string $name Name of tag.
param: string $class The class path to use.
param: string $classpath The classpat to use.

getDataTypeDefinitions() X-Ref

Pas de description

addTarget($targetName, &$target) X-Ref

Pas de description

addOrReplaceTarget($targetName, &$target) X-Ref

Pas de description

getTargets() X-Ref

Pas de description

createTask($taskType) X-Ref

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.

returns: Task                A task object
param: string    $taskType    Task name

createDataType($typeName) X-Ref

Create a task instance and return reference to it
See createTask() for explanation how this works

returns: object A datatype object
param: string Type name

executeTargets($targetNames) X-Ref

Executes a list of targets

returns: void
param: array List of target names to execute

executeTarget($targetName) X-Ref

Executes a target

returns: void
param: string Name of Target to execute

resolveFile($fileName, $rootDir = null) X-Ref

Pas de description

_topoSort($root, &$targets) X-Ref

Topologically sort a set of Targets.

param: $root is the (String) name of the root Target. The sort is
param: $targets is a array representing a "name to Target" mapping
return: An array of Strings with the names of the targets in

_tsort($root, &$targets, &$state, &$visiting, &$ret) X-Ref

Pas de description

_makeCircularException($end, $stk) X-Ref

Pas de description

addReference($name, $object) X-Ref

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

getReferences() X-Ref

Returns the references array.

return: array

getReference($key) X-Ref

Returns a specific reference.

param: string $key The reference id/key.
return: object or null if not defined

log($msg, $level = PROJECT_MSG_INFO) X-Ref

Abstracting and simplifyling Logger calls for project messages

logObject($obj, $msg, $level) X-Ref

Pas de description

addBuildListener(BuildListener $listener) X-Ref

Pas de description

removeBuildListener(BuildListener $listener) X-Ref

Pas de description