input/InputRequest.php

Show: inherited
Table of Contents

Encapsulates an input request.

Author
Hans Lellelid (Phing)  
Author
Stefan Bodewig (Ant)  
Package
phing.input  
Version
$Id$  

\InputRequest

Package: phing\input

Encapsulates an input request.

Children
\MultipleChoiceInputRequest
Author
Hans Lellelid (Phing)  
Author
Stefan Bodewig (Ant)  
Version
$Id$  

Properties

Propertyprotected  $defaultValue= ''
Details
Type
n/a
Propertyprotected  $input= ''
Details
Type
n/a
Propertyprotected  $prompt= ''
Details
Type
n/a
Propertyprotected  $promptChar= ''
Details
Type
n/a

Methods

methodpublic__construct( string $prompt ) : void

Parameters
Name Type Description
$prompt string

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

methodpublicgetDefaultValue( ) : mixed

Return the default value to use.

Returns
Type Description
mixed
methodpublicgetInput( ) : void

Retrieves the user input.

methodpublicgetPrompt( ) : void

Retrieves the prompt text.

methodpublicgetPromptChar( ) : string

Return the default value to use.

Returns
Type Description
string
methodpublicisInputValid( ) : void

Is the user input valid?

methodpublicsetDefaultValue( mixed $v ) : void

Set the default value to use.

Parameters
Name Type Description
$v mixed
methodpublicsetInput(  $input ) : void

Sets the user provided input.

Parameters
Name Type Description
$input
methodpublicsetPromptChar( string $c ) : void

Set the default value to use.

Parameters
Name Type Description
$c string
Documentation was generated by DocBlox 0.18.1.