tasks/system/InputTask.php
Show:
inherited
inherited
Classes
\InputTask
Package: phing\tasks\system
Reads input from the InputHandler.
- Parent(s)
- \Task < \ProjectComponent
- See
- \Project::getInputHandler()
- Author
- Hans Lellelid
- Author
- Ulrich Schmidt
- Author
- Stefan Bodewig
- Version
- $Revision: 526 $
Properties
$defaultValue= ''
Details
- Type
- n/a
$message= '""'
Default value
""Details- Type
- n/a
$promptChar= ''
Details
- Type
- n/a
$propertyName= ''
Details
- Type
- n/a
$validargs= ''
Details
- Type
- n/a
Methods
addText(
$msg
)
:
voidSet a multiline message.
Parameters
| Name | Type | Description |
|---|---|---|
| $msg |
getDescription(
)
:
voidgetLocation(
)
:
voidgetOwningTarget(
)
:
voidgetProject(
)
:
voidgetRegisterSlot(
)
:
voidgetRuntimeConfigurableWrapper(
)
:
voidgetTaskName(
)
:
voidgetTaskType(
)
:
voidinit(
)
:
voidlog(
)
:
voidmaybeConfigure(
)
:
voidperform(
)
:
voidsetDefaultValue(
string $v
)
:
voidAdd a default value.
Parameters
| Name | Type | Description |
|---|---|---|
| $v | string |
setDescription(
)
:
voidsetLocation(
)
:
voidsetMessage(
\message $message
)
:
voidSets the Message which gets displayed to the user during the build run.
Parameters
| Name | Type | Description |
|---|---|---|
| $message | \message | The message to be displayed. |
setOwningTarget(
)
:
voidsetProject(
)
:
voidsetPromptChar(
string $c
)
:
voidSet the character/string to use for the prompt.
Parameters
| Name | Type | Description |
|---|---|---|
| $c | string |
setPropertyName(
string $name
)
:
voidDefines the name of a property to be set from input.
Parameters
| Name | Type | Description |
|---|---|---|
| $name | string | Name for the property to be set from input |
setRuntimeConfigurableWrapper(
)
:
voidsetTaskName(
)
:
voidsetTaskType(
)
:
voidsetValidargs(
\validargs $validargs
)
:
voidDefines valid input parameters as comma separated strings. If set, input task will reject any input not defined as accepted and requires the user to reenter it. Validargs are case sensitive. If you want 'a' and 'A' to be accepted you need to define both values as accepted arguments.
Parameters
| Name | Type | Description |
|---|---|---|
| $validargs | \validargs | A comma separated String defining valid input args. |