input/MultipleChoiceInputRequest.php
Show:
inherited
inherited
Classes
Encapsulates an input request.
- Author
- Stefan Bodewig
- Package
- phing.input
- Version
- $Id$
\MultipleChoiceInputRequest
Package: phing\input
Encapsulates an input request.
- Parent(s)
- \InputRequest
- Children
- \YesNoInputRequest
- Author
- Stefan Bodewig
- Version
- $Id$
Properties
$choices= 'array()'
Default value
array()Details- Type
- n/a
$defaultValue= ''
inheritedInherited from:
\InputRequest::$$defaultValue
Details
- Type
- n/a
- Inherited_from
- \InputRequest::$$defaultValue
$input= ''
inheritedInherited from:
\InputRequest::$$input
Details
- Type
- n/a
- Inherited_from
- \InputRequest::$$input
$prompt= ''
inheritedInherited from:
\InputRequest::$$prompt
Details
- Type
- n/a
- Inherited_from
- \InputRequest::$$prompt
$promptChar= ''
inheritedInherited from:
\InputRequest::$$promptChar
Details
- Type
- n/a
- Inherited_from
- \InputRequest::$$promptChar
Methods
__construct(
string $prompt, array $choices
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $prompt | string | The prompt to show to the user. Must not be null. |
| $choices | array | holds all input values that are allowed. Must not be null. |
getChoices(
)
:
\The
Returns
| Type | Description |
|---|---|
| \The | possible values. |
getDefaultValue(
)
:
mixed
Returns
| Type | Description |
|---|---|
| mixed |
getPromptChar(
)
:
string
Returns
| Type | Description |
|---|---|
| string |
isInputValid(
)
:
trueIs the user input valid?
Returns
| Type | Description |
|---|---|
| true | if the input is one of the allowed values. |
setDefaultValue(
mixed $v
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $v | mixed |
setInput(
$input
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $input |
setPromptChar(
string $c
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $c | string |