# tasks/system/InputTask.php

## \InputTask
jump to top

Package: phing\tasks\system

Reads input from the InputHandler.

Parent(s)
  \Task < \ProjectComponent
See
  \Project::getInputHandler()
Author
  Hans Lellelid (Phing)
Author
  Ulrich Schmidt (Ant)
Author
  Stefan Bodewig (Ant)
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 ) : void`

Set a multiline message.

Parameters

Name | Type | Description
--- | --- | ---
$msg |  |

`getDescription( ) : void`

`getLocation( ) : void`

`getOwningTarget( ) : void`

`getProject( ) : void`

`getRegisterSlot( ) : void`

`getRuntimeConfigurableWrapper( ) : void`

`getTaskName( ) : void`

`getTaskType( ) : void`

`init( ) : void`

`log( ) : void`

`main( ) : void`

Actual method executed by phing.

Throws

Exception | Description
--- | ---
\BuildException |

`maybeConfigure( ) : void`

`perform( ) : void`

`setDefaultValue( string $v ) : void`

Add a default value.

Parameters

Name | Type | Description
--- | --- | ---
$v | string |

`setDescription( ) : void`

`setLocation( ) : void`

`setMessage( \message $message ) : void`

Sets the Message which gets displayed to the user during the build run.

Parameters

Name | Type | Description
--- | --- | ---
$message | \message | The message to be displayed.

`setOwningTarget( ) : void`

`setProject( ) : void`

`setPromptChar( string $c ) : void`

Set the character/string to use for the prompt.

Parameters

Name | Type | Description
--- | --- | ---
$c | string |

`setPropertyName( string $name ) : void`

Defines 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( ) : void`

`setTaskName( ) : void`

`setTaskType( ) : void`

`setValidargs( \validargs $validargs ) : void`

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.

Parameters

Name | Type | Description
--- | --- | ---
$validargs | \validargs | A comma separated String defining valid input args.

Documentation was generated by DocBlox 0.17.1.