classes/phing/input/InputRequest.php

Encapsulates an input request.

author
Hans Lellelid (Phing)
author
Stefan Bodewig (Ant)
package
phing.input
version
$Revision: 526 $

\InputRequest

Encapsulates an input request.

author
Hans Lellelid (Phing)
author
Stefan Bodewig (Ant)
package
phing.input
version
$Revision: 526 $

Properties

Propertyprotected  $defaultValue= ''
Details
Type
Propertyprotected  $input= ''
Details
Type
Propertyprotected  $prompt= ''
Details
Type
Propertyprotected  $promptChar= ''
Details
Type

Methods

methodpublic  __construct( string $prompt ) :
Parameters
Name Type Description
$prompt string The prompt to show to the user. Must not be null.
methodpublic  getDefaultValue( ) : mixed
Return the default value to use.
Returns
Type Description
mixed
methodpublic  getInput( ) :
Retrieves the user input.
methodpublic  getPrompt( ) :
Retrieves the prompt text.
methodpublic  getPromptChar( ) : string
Return the default value to use.
Returns
Type Description
string
methodpublic  isInputValid( ) :
Is the user input valid?
methodpublic  setDefaultValue( mixed $v ) :
Set the default value to use.
Parameters
Name Type Description
$v mixed
methodpublic  setInput(  $input ) :
Sets the user provided input.
Parameters
Name Type Description
$input
methodpublic  setPromptChar( string $c ) :
Set the default value to use.
Parameters
Name Type Description
$c string
Documentation was generated by DocBlox 0.13.1.