phing-tasks-system

# Class: PhingCallTask Source Location: /tasks/system/PhingCallTask.php
### Class Overview
    ProjectComponent
       |
       --Task
          |
          --PhingCallTask
Call another target in the same project. #### Author(s): Andreas Aderhold <andi@binarycloud.com> #### Version: $Revision: 552 $ #### Copyright: 2001,2002 THYRELL. All rights reserved | ### Methods createParam createProperty init main setInheritAll setInheritRefs setTarget
### Inherited Variables #### Class: Task Task::$description Task::$location Task::$target Task::$taskName Task::$taskType Task::$wrapper #### Class: ProjectComponent ProjectComponent::$project | ### Inherited Methods #### Class: Task Task::getDescription() Returns the textual description of the task Task::getLocation() Returns the location within the buildfile this task occurs. Used by BuildException to give detailed error messages. Task::getOwningTarget() Returns the owning target of this task. Task::getRegisterSlot() Returns a name Task::getRuntimeConfigurableWrapper() Returns the wrapper object for runtime configuration Task::getTaskName() Returns the name of task, used only for log messages Task::getTaskType() Returns the name of the task under which it was invoked, usually the XML tagname Task::init() Called by the parser to let the task initialize properly. Task::log() Provides a project level log event to the task. Task::main() Called by the project to let the task do it's work. This method may be called more than once, if the task is invoked more than once. For example, if target1 and target2 both depend on target3, then running <em>phing target1 target2</em> will run all tasks in target3 twice. Task::maybeConfigure() Configure this task if it hasn't been done already. Task::perform() Perfrom this task Task::setDescription() Sets a textual description of the task Task::setLocation() Sets the location within the buildfile this task occurs. Called by the parser to set location information. Task::setOwningTarget() Sets the owning target this task belongs to. Task::setRuntimeConfigurableWrapper() Sets the wrapper object this task should use for runtime configurable elements. Task::setTaskName() Sets the name of this task for log messages Task::setTaskType() Sets the type of the task. Usually this is the name of the XML tag #### Class: ProjectComponent ProjectComponent::getProject() Returns a reference to current project ProjectComponent::log() Logs a message with the given priority. ProjectComponent::setProject() References the project to the current component.
### Class Details [line 48] Call another target in the same project. `<target name="foo"> <phingcall target="bar"> <property name="property1" value="aaaaa" /> <property name="foo" value="baz" /> </phingcall> </target> <target name="bar" depends="init"> <echo message="prop is ${property1} ${foo}" /> </target>` This only works as expected if neither property1 nor foo are defined in the project itself. #### Tags:
author: | Andreas Aderhold <andi@binarycloud.com>
version: | $Revision: 552 $
copyright: | 2001,2002 THYRELL. All rights reserved
access: | public
[ Top ] ### Class Methods ### method createParam [line 101]
`void createParam( )`
Alias for createProperty #### Tags:
see: | PhingCallTask::createProperty()
[ Top ] ### method createProperty [line 111]
`void createProperty( )`
Property to pass to the invoked target. [ Top ] ### method init [line 129]
`void init( )`
init this task by creating new instance of the phing task and configuring it's by calling its own init method. Overrides Task::init() (Called by the parser to let the task initialize properly.) [ Top ] ### method main [line 143]
`void main( )`
hand off the work to the phing task of ours, after setting it up #### Tags:
throws: | BuildException on validation failure or if the target didn't execute
Overrides Task::main() (Called by the project to let the task do it's work. This method may be called more than once, if the task is invoked more than once. For example, if target1 and target2 both depend on target3, then running <em>phing target1 target2</em> will run all tasks in target3 twice.) [ Top ] ### method setInheritAll [line 83]
`void setInheritAll( boolean $inherit)`
If true, pass all properties to the new Phing project. Defaults to true. Future use. #### Parameters:
boolean | $inherit | new value
[ Top ] ### method setInheritRefs [line 93]
`void setInheritRefs( boolean $inheritRefs)`
If true, pass all references to the new Phing project. Defaults to false. Future use. #### Parameters:
boolean | $inheritRefs | new value
[ Top ] ### method setTarget [line 121]
`void setTarget( $target)`
Target to execute, required. #### Parameters:
| $target |
[ Top ] Documentation generated on Mon, 19 Oct 2009 10:51:33 +0200 by phpDocumentor 1.4.3