classes/phing/tasks/system/InputTask.php
Classes
\InputTask
Reads input from the InputHandler.
Use {@link Project#createTask} to register a new Task.
- Extends from
- \Task
- see
- \Project::getInputHandler()
- author
- Hans Lellelid
- author
- Ulrich Schmidt
- author
- Stefan Bodewig
- copyright
- 2001,2002 THYRELL. All rights reserved
- package
- phing.tasks.system
- version
- $Revision: 526 $
Properties
$defaultValue= ''
Details
- Type
$message= ''
Details
- Type
$promptChar= ''
Details
- Type
$propertyName= ''
Details
- Type
$validargs= ''
Details
- Type
Methods
addText(
$msg
)
:
Set a multiline message.
| Name | Type | Description |
|---|---|---|
| $msg |
main(
)
:
Actual method executed by phing.
- throws
setDefaultValue(
string $v
)
:
Add a default value.
| Name | Type | Description |
|---|---|---|
| $v | string |
setMessage(
\message $message
)
:
Sets the Message which gets displayed to the user during the build run.
| Name | Type | Description |
|---|---|---|
| $message | \message | The message to be displayed. |
setPromptChar(
string $c
)
:
Set the character/string to use for the prompt.
| Name | Type | Description |
|---|---|---|
| $c | string |
setPropertyName(
string $name
)
:
Defines the name of a property to be set from input.
| Name | Type | Description |
|---|---|---|
| $name | string | Name for the property to be set from input |
setValidargs(
\validargs $validargs
)
:
Defines 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.
| Name | Type | Description |
|---|---|---|
| $validargs | \validargs | A comma separated String defining valid input args. |