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
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
|
<?php
/**
* Zend Framework (http://framework.zend.com/)
*
* @link http://github.com/zendframework/zf2 for the canonical source repository
* @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
*/
namespace Zend\Console\Adapter;
use Zend\Console\Charset\CharsetInterface;
interface AdapterInterface
{
const LINE_NONE = 1;
const LINE_SINGLE = 2;
const LINE_DOUBLE = 3;
const LINE_BLOCK = 4;
const FILL_NONE = 0;
const FILL_SHADE_LIGHT = 1;
const FILL_SHADE_MEDIUM = 2;
const FILL_SHADE_DARK = 3;
const FILL_BLOCK = 10;
/**
* Write a chunk of text to console.
*
* @param string $text
* @param null|int $color
* @param null|int $bgColor
* @return void
*/
public function write($text, $color = null, $bgColor = null);
/**
* Alias for write()
*
* @param string $text
* @param null|int $color
* @param null|int $bgColor
* @return void
*/
public function writeText($text, $color = null, $bgColor = null);
/**
* Write a single line of text to console and advance cursor to the next line.
* If the text is longer than console width it will be truncated.
*
* @param string $text
* @param null|int $color
* @param null|int $bgColor
* @return void
*/
public function writeLine($text = "", $color = null, $bgColor = null);
/**
* Write a piece of text at the coordinates of $x and $y
*
* @param string $text Text to write
* @param int $x Console X coordinate (column)
* @param int $y Console Y coordinate (row)
* @param null|int $color
* @param null|int $bgColor
* @return void
*/
public function writeAt($text, $x, $y, $color = null, $bgColor = null);
/**
* Write a box at the specified coordinates.
* If X or Y coordinate value is negative, it will be calculated as the distance from far right or bottom edge
* of the console (respectively).
*
* @param int $x1 Top-left corner X coordinate (column)
* @param int $y1 Top-left corner Y coordinate (row)
* @param int $x2 Bottom-right corner X coordinate (column)
* @param int $y2 Bottom-right corner Y coordinate (row)
* @param int $lineStyle (optional) Box border style.
* @param int $fillStyle (optional) Box fill style or a single character to fill it with.
* @param int $color (optional) Foreground color
* @param int $bgColor (optional) Background color
* @param null|int $fillColor (optional) Foreground color of box fill
* @param null|int $fillBgColor (optional) Background color of box fill
* @return void
*/
public function writeBox(
$x1,
$y1,
$x2,
$y2,
$lineStyle = self::LINE_SINGLE,
$fillStyle = self::FILL_NONE,
$color = null,
$bgColor = null,
$fillColor = null,
$fillBgColor = null
);
/**
* Write a block of text at the given coordinates, matching the supplied width and height.
* In case a line of text does not fit desired width, it will be wrapped to the next line.
* In case the whole text does not fit in desired height, it will be truncated.
*
* @param string $text Text to write
* @param int $width Maximum block width. Negative value means distance from right edge.
* @param int|null $height Maximum block height. Negative value means distance from bottom edge.
* @param int $x Block X coordinate (column)
* @param int $y Block Y coordinate (row)
* @param null|int $color (optional) Text color
* @param null|int $bgColor (optional) Text background color
* @return void
*/
public function writeTextBlock(
$text,
$width,
$height = null,
$x = 0,
$y = 0,
$color = null,
$bgColor = null
);
/**
* Determine and return current console width.
*
* @return int
*/
public function getWidth();
/**
* Determine and return current console height.
*
* @return int
*/
public function getHeight();
/**
* Determine and return current console width and height.
*
* @return array array($width, $height)
*/
public function getSize();
/**
* Check if console is UTF-8 compatible
*
* @return bool
*/
public function isUtf8();
/**
* Set cursor position
*
* @param int $x
* @param int $y
* @return void
*/
public function setPos($x, $y);
/**
* Hide console cursor
* @return void
*/
public function hideCursor();
/**
* Show console cursor
* @return void
*/
public function showCursor();
/**
* Return current console window title.
*
* @return string
*/
public function getTitle();
/**
* Prepare a string that will be rendered in color.
*
* @param string $string
* @param null|int $color Foreground color
* @param null|int $bgColor Background color
* @return string
*/
public function colorize($string, $color = null, $bgColor = null);
/**
* Change current drawing color.
*
* @param int $color
* @return void
*/
public function setColor($color);
/**
* Change current drawing background color
*
* @param int $color
* @return void
*/
public function setBgColor($color);
/**
* Reset color to console default.
* @return void
*/
public function resetColor();
/**
* Set Console charset to use.
*
* @param CharsetInterface $charset
* @return void
*/
public function setCharset(CharsetInterface $charset);
/**
* Get charset currently in use by this adapter.
*
* @return CharsetInterface $charset
*/
public function getCharset();
/**
* @return CharsetInterface
*/
public function getDefaultCharset();
/**
* Clear console screen
* @return void
*/
public function clear();
/**
* Clear line at cursor position
* @return void
*/
public function clearLine();
/**
* Clear console screen
* @return void
*/
public function clearScreen();
/**
* Read a single line from the console input
*
* @param int $maxLength Maximum response length
* @return string
*/
public function readLine($maxLength = 2048);
/**
* Read a single character from the console input
*
* @param string|null $mask A list of allowed chars
* @return string
*/
public function readChar($mask = null);
}
|
