tasks/system/PropertyPromptTask.php
inherited
Classes
\PropertyPromptTask
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
- Author
- Anthony J. Young-Garner
- Deprecated
- - in favor of the more capable InputTask
- Version
- $Revision: 1074 $
Properties
string
$defaultValue= ''
The default value to use if no input is entered.
- Type
- string
string
$promptCharacter= ''
The character to put after the text.
- Type
- string
string
$promptText= ''
The text to use for the prompt.
- Type
- string
string
$propertyName= ''
The property name to set with the output.
- Type
- string
string
$proposedValue= ''
The entered value.
- Type
- string
$useExistingValue= ''
- Type
- n/a
Methods
addText(
string $prompt
)
:
voidSets the prompt text that will be presented to the user.
| Name | Type | Description |
|---|---|---|
| $prompt | string |
getDefaultMessage(
)
:
voidReturns a string to be inserted in the log message indicating whether a default response was specified in the build file.
getDefaultValue(
)
:
stringReturns defaultValue specified in this task for the Property being set.
| Type | Description |
|---|---|
| string |
getDescription(
)
:
voidgetLocation(
)
:
voidgetOwningTarget(
)
:
voidgetProject(
)
:
voidgetPromptCharacter(
)
:
stringReturns the terminating character used to punctuate the prompt text.
| Type | Description |
|---|---|
| string |
getPromptText(
)
:
\java.lang.StringReturns text of the prompt.
| Type | Description |
|---|---|
| \java.lang.String |
getPropertyName(
)
:
stringReturns name of the Ant Project Property being set by this task.
| Type | Description |
|---|---|
| string |
getRegisterSlot(
)
:
voidgetRuntimeConfigurableWrapper(
)
:
voidgetTaskName(
)
:
voidgetTaskType(
)
:
voidinit(
)
:
voidInitializes this task.
isUseExistingValue(
)
:
booleanInsert the method's description here.
Creation date: (12/10/2001 8:16:16 AM)
| Type | Description |
|---|---|
| boolean |
log(
)
:
voidmaybeConfigure(
)
:
voidperform(
)
:
voidsetDefaultvalue(
string $newDefaultvalue
)
:
voidSets defaultValue for the Property being set by this task.
| Name | Type | Description |
|---|---|---|
| $newDefaultvalue | string |
setDescription(
)
:
voidsetLocation(
)
:
voidsetOwningTarget(
)
:
voidsetProject(
)
:
voidsetPromptCharacter(
string $newPromptcharacter
)
:
voidSets the terminating character used to punctuate the prompt text (default is "?").
| Name | Type | Description |
|---|---|---|
| $newPromptcharacter | string |
setPromptText(
string $newPrompttext
)
:
voidSets text of the prompt.
| Name | Type | Description |
|---|---|---|
| $newPrompttext | string |
setPropertyName(
\newPropertyname $newPropertyname
)
:
voidSpecifies the Phing Project Property being set by this task.
| Name | Type | Description |
|---|---|---|
| $newPropertyname | \newPropertyname | java.lang.String |
setRuntimeConfigurableWrapper(
)
:
voidsetTaskName(
)
:
voidsetTaskType(
)
:
voidsetUseExistingValue(
boolean $newUseExistingValue
)
:
void| Name | Type | Description |
|---|---|---|
| $newUseExistingValue | boolean |