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
<?php
/**
* @see https://github.com/laminas/laminas-console for the canonical source repository
* @copyright https://github.com/laminas/laminas-console/blob/master/COPYRIGHT.md
* @license https://github.com/laminas/laminas-console/blob/master/LICENSE.md New BSD License
*/
namespace Laminas\Console\Prompt;
use Laminas\Console\Exception;
class Select extends Char
{
/**
* @var string
*/
protected $promptText = 'Please select an option';
/**
* @var bool
*/
protected $ignoreCase = true;
/**
* @var array
*/
protected $options = [];
/**
* Ask the user to select one of pre-defined options
*
* @param string $promptText The prompt text to display in console
* @param array $options Allowed options
* @param bool $allowEmpty Allow empty (no) selection?
* @param bool $echo True to display selected option?
* @throws Exception\BadMethodCallException if no options available
*/
public function __construct(
$promptText = 'Please select one option',
$options = [],
$allowEmpty = false,
$echo = false
) {
if ($promptText !== null) {
$this->setPromptText($promptText);
}
if (! count($options)) {
throw new Exception\BadMethodCallException(
'Cannot construct a "select" prompt without any options'
);
}
$this->setOptions($options);
if ($allowEmpty !== null) {
$this->setAllowEmpty($allowEmpty);
}
if ($echo !== null) {
$this->setEcho($echo);
}
}
/**
* Show a list of options and prompt the user to select one of them.
*
* @return string Selected option
*/
public function show()
{
// Show prompt text and available options
$console = $this->getConsole();
$console->writeLine($this->promptText);
foreach ($this->options as $k => $v) {
$console->writeLine(' ' . $k . ') ' . $v);
}
// Prepare mask
$mask = implode("", array_keys($this->options));
if ($this->allowEmpty) {
$mask .= "\r\n";
}
// Prepare other params for parent class
$this->setAllowedChars($mask);
$oldPrompt = $this->promptText;
$oldEcho = $this->echo;
$this->echo = false;
$this->promptText = null;
// Retrieve a single character
$response = parent::show();
// Restore old params
$this->promptText = $oldPrompt;
$this->echo = $oldEcho;
// Display selected option if echo is enabled
if ($this->echo) {
if (isset($this->options[$response])) {
$console->writeLine($this->options[$response]);
} else {
$console->writeLine();
}
}
$this->lastResponse = $response;
return $response;
}
/**
* Set allowed options
*
* @param array|\Traversable $options
* @throws Exception\BadMethodCallException
*/
public function setOptions($options)
{
if (! is_array($options) && ! $options instanceof \Traversable) {
throw new Exception\BadMethodCallException(
'Please specify an array or Traversable object as options'
);
}
if (! is_array($options)) {
$this->options = [];
foreach ($options as $k => $v) {
$this->options[$k] = $v;
}
} else {
$this->options = $options;
}
}
/**
* @return array
*/
public function getOptions()
{
return $this->options;
}
}