tasks/system/PropertyPromptTask.php

Show: inherited
Table of Contents

Deprecated task that uses console to prompt user for property values.

This class is very slightly simpler than the InputTask, but lacks the ability to use a non-console input handler. You should, therefore, use InputTask. This class can serve as a reference, but will be removed in the future.

Author
Hans Lellelid (Phing)  
Author
Anthony J. Young-Garner (Ant)  
Deprecated
- in favor of the more capable InputTask  
Package
phing.tasks.system  
Version
$Id$  

\PropertyPromptTask

Package: phing\tasks\system

Deprecated task that uses console to prompt user for property values.

This class is very slightly simpler than the InputTask, but lacks the ability to use a non-console input handler. You should, therefore, use InputTask. This class can serve as a reference, but will be removed in the future.

Parent(s)
\Task < \ProjectComponent
Author
Hans Lellelid (Phing)  
Author
Anthony J. Young-Garner (Ant)  
Copyright
2001,2002 THYRELL. All rights reserved  
Deprecated
- in favor of the more capable InputTask  
Version
$Id$  

Properties

Propertyprivatestring  $defaultValue= ''

The default value to use if no input is entered.

Details
Type
string
Propertyprotectedstring  $description= ''
inherited

Description of the task

Inherited from: \Task::$$description
Details
Type
string
Inherited_from
\Task::$$description  
Propertyprotected\Location  $location= ''
inherited

Stored buildfile location

Inherited from: \Task::$$location
Details
Type
\Location
Inherited_from
\Task::$$location  
Propertyprotected\Project  $project= 'null'
inherited

Holds a reference to the project that a project component (a task, a target, etc.) belongs to

A reference to the current project instanceInherited from: \ProjectComponent::$$project\Task::$$project
Default valuenullDetails
Type
\Project
Inherited_from
\ProjectComponent::$$project  
Inherited_from
\Task::$$project  
Propertyprivatestring  $promptCharacter= ''

The character to put after the text.

Details
Type
string
Propertyprivatestring  $promptText= ''

The text to use for the prompt.

Details
Type
string
Propertyprivatestring  $propertyName= ''

The property name to set with the output.

Details
Type
string
Propertyprivatestring  $proposedValue= ''

The entered value.

Details
Type
string
Propertyprotected\Target  $target= ''
inherited

Owning Target object

Inherited from: \Task::$$target
Details
Type
\Target
Inherited_from
\Task::$$target  
Propertyprotectedstring  $taskName= ''
inherited

Taskname for logger

Inherited from: \Task::$$taskName
Details
Type
string
Inherited_from
\Task::$$taskName  
Propertyprotectedstring  $taskType= ''
inherited

Internal taskname (req)

Inherited from: \Task::$$taskType
Details
Type
string
Inherited_from
\Task::$$taskType  
Propertyprivate  $useExistingValue= ''

Details
Type
n/a
Propertyprotected\RuntimeConfigurable  $wrapper= ''
inherited

Wrapper of the task

Inherited from: \Task::$$wrapper
Details
Type
\RuntimeConfigurable
Inherited_from
\Task::$$wrapper  

Methods

methodpublicaddText( string $prompt ) : void

Sets the prompt text that will be presented to the user.

Parameters
Name Type Description
$prompt string
methodprivategetDefaultMessage( ) : void

Returns a string to be inserted in the log message indicating whether a default response was specified in the build file.

methodpublicgetDefaultValue( ) : string

Returns defaultValue specified in this task for the Property being set.

Returns
Type Description
string
methodpublicgetDescription( ) : string
inherited

Returns the textual description of the task

Inherited from: \Task::getDescription()
Returns
Type Description
string The text description of the task
methodpublicgetLocation( ) : \Location
inherited

Returns the location within the buildfile this task occurs. Used by {@link BuildException} to give detailed error messages.

Inherited from: \Task::getLocation()
Returns
Type Description
\Location The location object describing the position of this task within the buildfile.
methodpublicgetOwningTarget( ) : \Target
inherited

Returns the owning target of this task.

Inherited from: \Task::getOwningTarget()
Returns
Type Description
\Target The target object that owns this task
methodpublicgetProject( ) : \Project
inherited

Returns a reference to current project

Inherited from: \ProjectComponent::getProject()\Task::getProject()
Returns
Type Description
\Project Reference to current porject object
methodpublicgetPromptCharacter( ) : string

Returns the terminating character used to punctuate the prompt text.

Returns
Type Description
string
methodpublicgetPromptText( ) : \java.lang.String

Returns text of the prompt.

Returns
Type Description
\java.lang.String
methodpublicgetPropertyName( ) : string

Returns name of the Ant Project Property being set by this task.

Returns
Type Description
string
methodprotectedgetRegisterSlot( string $slotName ) : void
inherited

Returns a name

Inherited from: \Task::getRegisterSlot()
Parameters
Name Type Description
$slotName string
methodpublicgetRuntimeConfigurableWrapper( ) : \RuntimeConfigurable
inherited

Returns the wrapper object for runtime configuration

Inherited from: \Task::getRuntimeConfigurableWrapper()
Returns
Type Description
\RuntimeConfigurable The wrapper object used by this task
methodpublicgetTaskName( ) : string
inherited

Returns the name of task, used only for log messages

Inherited from: \Task::getTaskName()
Returns
Type Description
string Name of this task
methodpublicgetTaskType( ) : string
inherited

Returns the name of the task under which it was invoked, usually the XML tagname

Inherited from: \Task::getTaskType()
Returns
Type Description
string The type of this task (XML Tag)
methodpublicinit( ) : void

Initializes this task.

Should throw a BuildException if something goes wrong with the build

This is abstract here, but may not be overloaded by subclasses.

Throws
Exception Description
\BuildException
methodpublicisUseExistingValue( ) : boolean

Insert the method's description here.

Creation date: (12/10/2001 8:16:16 AM)

Returns
Type Description
boolean
methodpubliclog( string $msg, integer $level = Project::MSG_INFO ) : void
inherited

Provides a project level log event to the task.

Inherited from: \Task::log()
Parameters
Name Type Description
$msg string

The message to log

$level integer

The priority of the message

Details
See
\BuildEvent  
See
\BuildListener  
methodpublicmain( ) : void

Run the PropertyPrompt task.

Should throw a BuildException if someting goes wrong with the build

This is abstract here. Must be overloaded by real tasks.

Throws
Exception Description
\BuildException
methodpublicmaybeConfigure( ) : void
inherited

Configure this task if it hasn't been done already.

Inherited from: \Task::maybeConfigure()
methodpublicperform( ) : void
inherited

Perfrom this task

Inherited from: \Task::perform()
methodpublicsetDefaultvalue( string $newDefaultvalue ) : void

Sets defaultValue for the Property being set by this task.

Parameters
Name Type Description
$newDefaultvalue string
methodpublicsetDescription( string $desc ) : void
inherited

Sets a textual description of the task

Inherited from: \Task::setDescription()
Parameters
Name Type Description
$desc string

The text describing the task

methodpublicsetLocation( \Location $location ) : void
inherited

Sets the location within the buildfile this task occurs. Called by the parser to set location information.

Inherited from: \Task::setLocation()
Parameters
Name Type Description
$location \Location

The location object describing the position of this task within the buildfile.

methodpublicsetOwningTarget( \Target $target ) : void
inherited

Sets the owning target this task belongs to.

Inherited from: \Task::setOwningTarget()
Parameters
Name Type Description
$target \Target

Reference to owning target

methodpublicsetProject( \Project $project ) : void
inherited

References the project to the current component.

Inherited from: \ProjectComponent::setProject()\Task::setProject()
Parameters
Name Type Description
$project \Project

The reference to the current project

methodpublicsetPromptCharacter( string $newPromptcharacter ) : void

Sets the terminating character used to punctuate the prompt text (default is "?").

Parameters
Name Type Description
$newPromptcharacter string
methodpublicsetPromptText( string $newPrompttext ) : void

Sets text of the prompt.

Parameters
Name Type Description
$newPrompttext string
methodpublicsetPropertyName( \newPropertyname $newPropertyname ) : void

Specifies the Phing Project Property being set by this task.

Parameters
Name Type Description
$newPropertyname \newPropertyname

java.lang.String

methodpublicsetRuntimeConfigurableWrapper( \RuntimeConfigurable $wrapper ) : void
inherited

Sets the wrapper object this task should use for runtime configurable elements.

Inherited from: \Task::setRuntimeConfigurableWrapper()
Parameters
Name Type Description
$wrapper \RuntimeConfigurable

The wrapper object this task should use

methodpublicsetTaskName( string $name ) : string
inherited

Sets the name of this task for log messages

Inherited from: \Task::setTaskName()
Parameters
Name Type Description
$name string
Returns
Type Description
string A string representing the name of this task for log
methodpublicsetTaskType( string $name ) : void
inherited

Sets the type of the task. Usually this is the name of the XML tag

Inherited from: \Task::setTaskType()
Parameters
Name Type Description
$name string

The type of this task (XML Tag)

methodpublicsetUseExistingValue( boolean $newUseExistingValue ) : void

Parameters
Name Type Description
$newUseExistingValue boolean
Documentation was generated by DocBlox 0.18.1.