# input/InputRequest.php

Encapsulates an input request.

Author
  Hans Lellelid (Phing)
Author
  Stefan Bodewig (Ant)
Package
  phing.input
Version
  $Revision: 526 $

## \InputRequest
jump to top

Package: phing\input

Encapsulates an input request.

Children
  \MultipleChoiceInputRequest
Author
  Hans Lellelid (Phing)
Author
  Stefan Bodewig (Ant)
Version
  $Revision: 526 $

### Properties

`$defaultValue= ''`
Details

Type
  n/a

`$input= ''`
Details

Type
  n/a

`$prompt= ''`
Details

Type
  n/a

`$promptChar= ''`
Details

Type
  n/a

### Methods

`__construct( string $prompt ) : void`

Parameters

Name | Type | Description
--- | --- | ---
$prompt | string | The prompt to show to the user. Must not be null.

`getDefaultValue( ) : mixed`

Return the default value to use.

Returns

Type | Description
--- | ---
mixed |

`getInput( ) : void`

Retrieves the user input.

`getPrompt( ) : void`

Retrieves the prompt text.

`getPromptChar( ) : string`

Return the default value to use.

Returns

Type | Description
--- | ---
string |

`isInputValid( ) : void`

Is the user input valid?

`setDefaultValue( mixed $v ) : void`

Set the default value to use.

Parameters

Name | Type | Description
--- | --- | ---
$v | mixed |

`setInput( $input ) : void`

Sets the user provided input.

Parameters

Name | Type | Description
--- | --- | ---
$input |  |

`setPromptChar( string $c ) : void`

Set the default value to use.

Parameters

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

Documentation was generated by DocBlox 0.17.1.