InputRequest

Encapsulates an input request.

author

Hans Lellelid [email protected] (Phing)

author

Stefan Bodewig [email protected] (Ant)

version

$Id: 3f481cbc61091254b573f22bda2c8b9326a7211e $

package

phing.input

Methods

__construct

__construct(string $prompt) 
Throws
\BuildException

Arguments

$prompt

string

The prompt to show to the user. Must not be null.

Return the default value to use.

getDefaultValue() : mixed

Response

mixed

Retrieves the user input.

getInput() 

Retrieves the prompt text.

getPrompt() 

Return the default value to use.

getPromptChar() : string

Response

string

isHidden

isHidden() : boolean

Response

boolean

Is the user input valid?

isInputValid() 

Set the default value to use.

setDefaultValue(mixed $v) 

Arguments

$v

mixed

setHidden

setHidden(boolean $hidden) 

Arguments

$hidden

boolean

Sets the user provided input.

setInput( $input) 

Arguments

$input

Set the default value to use.

setPromptChar(string $c) 

Arguments

$c

string

Properties

prompt

prompt : string
var

Type(s)

string

input

input : string
var

Type(s)

string

defaultValue

defaultValue : string
var

Type(s)

string

promptChar

promptChar : string
var

Type(s)

string

hidden

hidden : boolean
var

Type(s)

boolean