phing-tasks-system

# Class: ExitTask Source Location: /tasks/system/ExitTask.php
### Class Overview
    ProjectComponent
       |
       --Task
          |
          --ExitTask
Exits the active build, giving an additional message if available. #### Author(s): Nico Seessle <nico@seessle.de> (Ant) Hans Lellelid <hans@xmpl.org> (Phing) #### Version: $Revision: 526 $ #### Copyright: � 2001,2002 THYRELL. All rights reserved | ### Methods addText main setIf setMessage setMsg setUnless
### 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 33] Exits the active build, giving an additional message if available. #### Tags:
author: | Nico Seessle <nico@seessle.de> (Ant)
author: | Hans Lellelid <hans@xmpl.org> (Phing)
version: | $Revision: 526 $
copyright: | � 2001,2002 THYRELL. All rights reserved
[ Top ] ### Class Methods ### method addText [line 90]
`void addText( $msg)`
Set a multiline message. #### Tags:
access: | public
#### Parameters:
| $msg |
[ Top ] ### method main [line 77]
`void main( )`
#### Tags:
throws: | BuildException
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 setIf [line 61]
`void setIf( c $c)`
Only fail if a property of the given name exists in the current project. #### Tags:
access: | public
#### Parameters:
c | $c | property name
[ Top ] ### method setMessage [line 53]
`void setMessage( value $value)`
A message giving further information on why the build exited. #### Tags:
access: | public
#### Parameters:
value | $value | message to output
[ Top ] ### method setMsg [line 44]
`void setMsg( string $value)`
A message giving further information on why the build exited. #### Tags:
access: | public
#### Parameters:
string | $value | message to output
[ Top ] ### method setUnless [line 70]
`void setUnless( c $c)`
Only fail if a property of the given name does not exist in the current project. #### Tags:
access: | public
#### Parameters:
c | $c | property name
[ Top ] Documentation generated on Mon, 19 Oct 2009 10:50:51 +0200 by phpDocumentor 1.4.3