summaryrefslogtreecommitdiff
path: root/buildscripts/phing/classes/phing/input/DefaultInputHandler.php
blob: 8ce76cddaac68f2a90450eb9a765c70a33dd7666 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
<?php

/*
 *  $Id: DefaultInputHandler.php,v 1.6 2004/02/27 18:49:13 hlellelid Exp $
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * This software consists of voluntary contributions made by many individuals
 * and is licensed under the LGPL. For more information please see
 * <http://phing.info>.
 */
 
require_once 'phing/input/InputHandler.php';
include_once 'phing/system/io/ConsoleReader.php';

/**
 * Prompts using print(); reads input from Console.
 *
 * @author Hans Lellelid <hans@xmpl.org> (Phing)
 * @author Stefan Bodewig <stefan.bodewig@epost.de> (Ant)
 * @version $Revision: 1.6 $
 * @package phing.input
 */
class DefaultInputHandler implements InputHandler {
    
    /**
     * Prompts and requests input.  May loop until a valid input has
     * been entered.
     * @throws BuildException 
     */
    public function handleInput(InputRequest $request) {
        $prompt = $this->getPrompt($request);
        $in = new ConsoleReader();           
        do {
            print $prompt;
            try {
                $input = $in->readLine();
                if ($input === "" && ($request->getDefaultValue() !== null) ) {
                    $input = $request->getDefaultValue();
                }
                $request->setInput($input);
            } catch (Exception $e) {
                throw new BuildException("Failed to read input from Console.", $e);
            }
        } while (!$request->isInputValid());
    }

    /**
     * Constructs user prompt from a request.
     *
     * <p>This implementation adds (choice1,choice2,choice3,...) to the
     * prompt for <code>MultipleChoiceInputRequest</code>s.</p>
     *
     * @param $request the request to construct the prompt for.
     *                Must not be <code>null</code>.
     */
    protected function getPrompt(InputRequest $request) {
        $prompt = $request->getPrompt();
        
        // use is_a() to avoid needing the class to be loaded
        if (is_a($request, 'YesNoInputRequest')) { // (yes/no)
            $prompt .= '(' . implode('/', $request->getChoices()) .')';
        } elseif (is_a($request, 'MultipleChoiceInputRequest')) { // (a,b,c,d)
            $prompt .= '(' . implode(',', $request->getChoices()) . ')';            
        }
        if ($request->getDefaultValue() !== null) {
            $prompt .= ' ['.$request->getDefaultValue().']';
        }
        $pchar = $request->getPromptChar();        
        return $prompt . ($pchar ? $pchar . ' ' : ' ');
    } 
}