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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
|
<?php
/*
* $Id: d2de9371732599b179facb97ef937b2cfbfbead2 $
*
* 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/Task.php';
include_once 'phing/system/io/ConsoleReader.php';
/**
* Deprecated task that uses console to prompt user for property values.
*
* This class is very slightly simpler than the InputTask, but lacks the ability
* to use a non-console input handler. You should, therefore, use InputTask. This
* class can serve as a reference, but will be removed in the future.
*
* @author Hans Lellelid <hans@xmpl.org> (Phing)
* @author Anthony J. Young-Garner <ajyoung@alum.mit.edu> (Ant)
* @version $Id$
* @package phing.tasks.system
* @deprecated - in favor of the more capable InputTask
*/
class PropertyPromptTask extends Task {
/**
* The property name to set with the output.
* @var string
*/
private $propertyName; // required
/**
* The default value to use if no input is entered.
* @var string
*/
private $defaultValue;
/**
* The entered value.
* @var string
*/
private $proposedValue;
/**
* The text to use for the prompt.
* @var string
*/
private $promptText;
/**
* The character to put after the text.
* @var string
*/
private $promptCharacter;
/**
*
*/
private $useExistingValue;
/**
* Run the PropertyPrompt task.
* @throws BuildException
*/
public function main() {
$this->proposedValue = $this->project->getProperty($this->propertyName);
$currentValue = $this->defaultValue;
if ($currentValue == "" && $this->proposedValue !== null) {
$currentValue = $this->proposedValue;
}
if ($this->useExistingValue !== true || $this->proposedValue === null) {
$this->log("Prompting user for " . $this->propertyName . ". " . $this->getDefaultMessage(), Project::MSG_VERBOSE);
print "\n" . $this->promptText . " [" . $currentValue . "] " . $this->promptCharacter . " ";
/** future version should probably have hooks for validation of user input.*/
$reader = new ConsoleReader();
try {
$this->proposedValue = $reader->readLine();
} catch (IOException $e) {
$this->log("Prompt failed. Using default. (Failure reason: " . $e->getMessage().")");
$this->proposedValue = $this->defaultValue;
}
if ($this->proposedValue === "") {
$this->log("No value specified, using default.", Project::MSG_VERBOSE);
$this->proposedValue = $this->defaultValue;
}
if (isset($this->proposedValue)) {
$this->project->setProperty($this->propertyName, $this->proposedValue);
}
}
}
/**
* Returns a string to be inserted in the log message
* indicating whether a default response was specified
* in the build file.
*/
private function getDefaultMessage() {
if ($this->defaultValue == "") {
return "No default response specified.";
} else return "Default response is " . $this->defaultValue . ".";
}
/**
* Returns defaultValue specified
* in this task for the Property
* being set.
* @return string
*/
public function getDefaultValue() {
return $this->defaultValue;
}
/**
* Returns the terminating character used to
* punctuate the prompt text.
* @return string
*/
public function getPromptCharacter() {
return $this->promptCharacter;
}
/**
* Returns text of the prompt.
* @return java.lang.String
*/
public function getPromptText() {
return $this->promptText;
}
/**
* Returns name of the Ant Project Property
* being set by this task.
* @return string
*/
public function getPropertyName() {
return $this->propertyName;
}
/**
* Initializes this task.
*/
public function init() {
parent::init();
$this->defaultValue = "";
$this->promptCharacter = "?";
$this->useExistingValue = false;
}
/**
* Insert the method's description here.
* Creation date: (12/10/2001 8:16:16 AM)
* @return boolean
*/
public function isUseExistingValue() {
return $this->useExistingValue;
}
/**
* Sets defaultValue for the Property
* being set by this task.
* @param string $newDefaultvalue
*/
public function setDefaultvalue($newDefaultvalue) {
$this->defaultValue = $newDefaultvalue;
}
/**
* Sets the terminating character used to
* punctuate the prompt text (default is "?").
* @param string $newPromptcharacter
*/
public function setPromptCharacter($newPromptcharacter) {
$this->promptCharacter = $newPromptcharacter;
}
/**
* Sets text of the prompt.
* @param string $newPrompttext
*/
public function setPromptText($newPrompttext) {
$this->promptText = $newPrompttext;
}
/**
* Specifies the Phing Project Property
* being set by this task.
* @param newPropertyname java.lang.String
*/
public function setPropertyName($newPropertyname) {
$this->propertyName = $newPropertyname;
}
/**
*
* @param boolean $newUseExistingValue
*/
public function setUseExistingValue($newUseExistingValue) {
$this->useExistingValue = $newUseExistingValue;
}
/**
* Sets the prompt text that will be presented to the user.
* @param string $prompt
* @return void
*/
public function addText($prompt) {
$this->setPromptText($prompt);
}
}
|
