classes/phing/parser/ProjectConfigurator.php
Classes
\ProjectConfigurator
The datatype handler class.
This class handles the occurance of registered datatype tags like FileSet
- access
- public
- author
- Andreas Aderhold
- copyright
- 2001,2002 THYRELL. All rights reserved
- package
- phing.parser
- version
- $Revision: 1000 $ $Date: 2010-11-24 11:28:55 +0100 (wo, 24 nov 2010) $
Properties
$buildFile= ''
Details
- Type
$buildFileParent= ''
Details
- Type
$currentProjectName= ''
Name of the current project
- Type
$currentTargets= ''
Targets in current file
- Type
$ignoreProjectTag= 'false'
Indicates whether the project tag attributes are to be ignored when processing a particular build file.
falseDetails- Type
$isParsing= 'true'
Default value
trueDetails- Type
$locator= ''
Details
- Type
$parseEndTarget= ''
Synthetic target that will be called at the end to the parse phase
- Type
$project= ''
Details
- Type
$propReplaceProject= ''
static
Details
- Type
$propReplaceProperties= ''
static
Details
- Type
Methods
__construct(
object $project, object $buildFile
)
:
Constructs a new ProjectConfigurator object
This constructor is private. Use a static call to
configureProject to configure a project.| Name | Type | Description |
|---|---|---|
| $project | object | the Project instance this configurator should use |
| $buildFile | object | the buildfile object the parser should use |
- access
- private
addText(
object $project, object $target, string $text
=
null
)
:
staticConfigures the #CDATA of an element.
| Name | Type | Description |
|---|---|---|
| $project | object | the project this element belongs to |
| $target | object | the element to configure |
| $text | string | the element's #CDATA |
- access
- public
configure(
object $target, array $attrs, object $project
)
:
staticConfigures an element and resolves eventually given properties.
| Name | Type | Description |
|---|---|---|
| $target | object | the element to configure |
| $attrs | array | the element's attributes |
| $project | object | the project this element belongs to |
- access
- public
- throws
- if arguments are not valid
- throws
- if attributes can not be configured
configureId(
object $target, array $attr
)
:
Scan Attributes for the id attribute and maybe add a reference to
project.
| Name | Type | Description |
|---|---|---|
| $target | object | the element's object |
| $attr | array | the element's attributes |
configureProject(
object $project, object $buildFile
)
:
staticStatic call to ProjectConfigurator. Use this to configure a
project. Do not use the new operator.
| Name | Type | Description |
|---|---|---|
| $project | object | the Project instance this configurator should use |
| $buildFile | object | the buildfile object the parser should use |
- access
- public
delayTaskUntilParseEnd(
\Task $task
)
:
Delay execution of a task until after the current parse phase has
completed.
| Name | Type | Description |
|---|---|---|
| $task | \Task | Task to execute after parse |
getBuildFile(
)
:
\thefind out the build file
| Type | Description |
|---|---|
| \the |
getBuildFileParent(
)
:
\thefind out the parent build file of this build file
| Type | Description |
|---|---|
| \the |
getCurrentProjectName(
)
:
\currentfind out the current project name
| Type | Description |
|---|---|
| \current |
getCurrentTargets(
)
:
isIgnoringProjectTag(
)
:
\whethertells whether the project tag is being ignored
| Type | Description |
|---|---|
| \whether |
isParsing(
)
:
parse(
)
:
Creates the ExpatParser, sets root handler and kick off parsing
process.
- access
- private
- throws
- if there is any kind of execption during the parsing process
replaceProperties(
object $project, string $value, array $keys
)
:
string
staticReplace ${} style constructions in the given value with the
string value of the corresponding data types. This method is
static.
| Name | Type | Description |
|---|---|---|
| $project | object | the project that should be used for property look-ups |
| $value | string | the string to be scanned for property references |
| $keys | array | proeprty keys |
| Type | Description |
|---|---|
| string |
replacePropertyCallback(
$matches
)
:
staticPrivate [static] function for use by preg_replace_callback to replace a single param.
This method makes use of a static variable to hold the
| Name | Type | Description |
|---|---|---|
| $matches |
setCurrentProjectName(
\name $name
)
:
set the name of the current project
| Name | Type | Description |
|---|---|---|
| $name | \name | name of the current project |
setIgnoreProjectTag(
\flag $flag
)
:
sets the flag to ignore the project tag
| Name | Type | Description |
|---|---|---|
| $flag | \flag | to ignore the project tag |
storeChild(
object $project, object $parent, object $child, string $tag
)
:
staticStores a configured child element into its parent object
| Name | Type | Description |
|---|---|---|
| $project | object | the project this element belongs to |
| $parent | object | the parent element |
| $child | object | the child element |
| $tag | string | the XML tagname |
- access
- public