phing-tasks-system

# Class: ImportTask Source Location: /tasks/system/ImportTask.php
### Class Overview
    ProjectComponent
       |
       --Task
          |
          --ImportTask
Imports another build file into the current project. #### Author(s): Bryan Davis <bpd@keynetics.com> #### Version: $Revision: 526 $ #### Copyright: � 2001,2002 THYRELL. All rights reserved | ### Variables $file $fs $optional | ### Methods init main setFile setOptional
### 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 45] Imports another build file into the current project. Targets and properties of the imported file can be overrridden by targets and properties of the same name declared in the importing file. The imported file will have a new synthetic property of "phing.file.<projectname>" declared which gives the full path to the imported file. Additionally each target in the imported file will be declared twice: once with the normal name and once with "<projectname>." prepended. The "<projectname>.<targetname>" synthetic targets allow the importing file a mechanism to call the imported files targets as dependencies or via the <phing> or <phingcall> task mechanisms. #### Tags:
author: | Bryan Davis <bpd@keynetics.com>
version: | $Revision: 526 $
copyright: | � 2001,2002 THYRELL. All rights reserved
[ Top ] ### Class Variables #### $file = null [line 55] #### Tags:
access: | protected
Type: | PhingFile
[ Top ] #### $fs = [line 50] #### Tags:
access: | protected
Type: | FileSystem
[ Top ] #### $optional = false [line 60] #### Tags:
access: | protected
Type: | bool
[ Top ] ### Class Methods ### method init [line 66]
`void init( )`
Initialize task. #### Tags:
access: | public
Overrides Task::init() (Called by the parser to let the task initialize properly.) [ Top ] ### method main [line 96]
`void main( )`
Parse a Phing build file and copy the properties, tasks, data types and targets it defines into the current project. #### Tags:
access: | public
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 setFile [line 76]
`void setFile( string $f)`
Set the file to import. #### Tags:
access: | public
#### Parameters:
string | $f | Path to file
[ Top ] ### method setOptional [line 86]
`void setOptional( bool $opt)`
Is this include optional? #### Tags:
access: | public
#### Parameters:
bool | $opt | If true, do not stop the build if the file does not exist
[ Top ] Documentation generated on Mon, 19 Oct 2009 10:51:05 +0200 by phpDocumentor 1.4.3