phing-input
[ class tree: phing-input ] [ index: phing-input ] [ all elements ]

Class: MultipleChoiceInputRequest

Source Location: /input/MultipleChoiceInputRequest.php

Class Overview

InputRequest
   |
   --MultipleChoiceInputRequest

Encapsulates an input request.


Author(s):

Version:

  • $Revision: 526 $

Variables

Methods


Child classes:

YesNoInputRequest
Encapsulates an input request that returns a boolean (yes/no).

Inherited Variables

Inherited Methods

Class: InputRequest

InputRequest::__construct()
InputRequest::getDefaultValue()
Return the default value to use.
InputRequest::getInput()
Retrieves the user input.
InputRequest::getPrompt()
Retrieves the prompt text.
InputRequest::getPromptChar()
Return the default value to use.
InputRequest::isInputValid()
Is the user input valid?
InputRequest::setDefaultValue()
Set the default value to use.
InputRequest::setInput()
Sets the user provided input.
InputRequest::setPromptChar()
Set the default value to use.

Class Details

[line 31]
Encapsulates an input request.



Tags:

author:  Stefan Bodewig <stefan.bodewig@epost.de>
version:  $Revision: 526 $


[ Top ]


Class Variables

$choices = array()

[line 33]



Tags:

access:  protected

Type:   mixed


[ Top ]



Class Methods


constructor __construct [line 40]

MultipleChoiceInputRequest __construct( string $prompt, array $choices)



Tags:

access:  public


Overrides InputRequest::__construct() (parent method not documented)

Parameters:

string   $prompt   The prompt to show to the user. Must not be null.
array   $choices   holds all input values that are allowed. Must not be null.

[ Top ]

method getChoices [line 48]

The getChoices( )



Tags:

return:  possible values.
access:  public


[ Top ]

method isInputValid [line 55]

true isInputValid( )



Tags:

return:  if the input is one of the allowed values.
access:  public


Overridden in child classes as:

YesNoInputRequest::isInputValid()

Overrides InputRequest::isInputValid() (Is the user input valid?)

[ Top ]


Documentation generated on Mon, 19 Oct 2009 10:51:18 +0200 by phpDocumentor 1.4.3