-
Notifications
You must be signed in to change notification settings - Fork 232
/
Copy pathcli.html
510 lines (481 loc) · 12.5 KB
/
cli.html
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
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
<!doctype html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="stylesheet" href="./../assets/css/combined.css?20170912">
<link rel="shortcut icon" href="./../favicon.ico" />
<script src="https://www.google.com/jsapi" type="text/javascript"></script>
<script type="text/javascript">
var path = './../';
var class_prefix = "Cli::";
</script>
<script src="./../assets/js/combined.js?20170912"></script>
<title>Cli - Classes - FuelPHP Documentation</title>
</head>
<body>
<div id="container">
<header id="header">
<div class="table">
<div id="cse">
<gcse:searchbox-only newWindow="true"></gcse:searchbox-only>
</div>
<h1>
<a href="https://fuelphp.com"><img height="37px" width="147px" src="./../assets/img/fuel.png" /></a>
<strong>Documentation</strong>
</h1>
</div>
<nav>
<div class="clear"></div>
</nav>
<a href="#" id="toc_handle">table of contents</a>
<div class="clear"></div>
</header>
<div id="main">
<h2>Cli Class</h2>
<p>Interact with the command line by accepting input options, parameters and output text.</p>
<article>
<h4 class="method" id="method_beep">beep($num = 1)</h4>
<p>The <strong>beep</strong> method fires a system beep on the computer running the command.</p>
<table class="method">
<tbody>
<tr>
<th class="legend">Static</th>
<td>Yes</td>
</tr>
<tr>
<th>Parameters</th>
<td>
<table class="parameters">
<tr>
<th>Param</th>
<th>Default</th>
<th class="description">Description</th>
</tr>
<tr>
<th><kbd>$num</kbd></th>
<td><em>1</em></td>
<td>Number of beeps.</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>Returns</th>
<td>void</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php"><code>Cli::beep(25);</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_color">color($text, $foreground, $background = null, $format = null)</h4>
<p>The <strong>color</strong> method changes the color of a piece of text.</p>
<table class="method">
<tbody>
<tr>
<th class="legend">Static</th>
<td>Yes</td>
</tr>
<tr>
<th>Parameters</th>
<td>
<table class="parameters">
<tr>
<th>Param</th>
<th>Default</th>
<th class="description">Description</th>
</tr>
<tr>
<th><kbd>$text</kbd></th>
<td><i>Required</i></td>
<td>String to be colored.</td>
</tr>
<tr>
<th><kbd>$foreground</kbd></th>
<td><i>Required</i></td>
<td>Foreground color of the string.</td>
</tr>
<tr>
<th><kbd>$background</kbd></th>
<td><i>null</i></td>
<td>Background color of the string.</td>
</tr>
<tr>
<th><kbd>$format</kbd></th>
<td><i>null</i></td>
<td>Other formatting to apply. Currently only the format 'underline' is support.</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>Returns</th>
<td>string</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php"><code>if (true === false)
{
$message = Cli::color('Error: The universe is broken.', 'red');
}
else
{
$message = Cli::color('All is well with the world.', 'green');
}
Cli::write($message);</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_error">error($text)</h4>
<p>The <strong>error</strong> method will write a line of text to the command line as an error (similar to <strong>write</strong> but uses STDERR instead of STDOUT).</p>
<table class="method">
<tbody>
<tr>
<th class="legend">Static</th>
<td>Yes</td>
</tr>
<tr>
<th>Parameters</th>
<td>
<table class="parameters">
<tr>
<th>Param</th>
<th>Default</th>
<th class="description">Description</th>
</tr>
<tr>
<th><kbd>$text</kbd></th>
<td><i>empty string</i></td>
<td>Text to output to STDERR for the output.</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>Returns</th>
<td>void</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php"><code>Cli::error('Failure: You hit the wrong key with your chubby hands, try using a stick to poke the keyboard.');</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_prompt">prompt($question = null, $options = array())</h4>
<p>The <strong>prompt</strong> method prompts the user for input.</p>
<table class="method">
<tbody>
<tr>
<th class="legend">Static</th>
<td>Yes</td>
</tr>
<tr>
<th>Parameters</th>
<td>
<table class="parameters">
<tr>
<th>Param</th>
<th>Default</th>
<th class="description">Description</th>
</tr>
<tr>
<th><kbd>$question</kbd></th>
<td><i>null</i></td>
<td>Ask the user a question and wait for input.</td>
</tr>
<tr>
<th><kbd>$options</kbd></th>
<td><i>array()</i></td>
<td>An array of options for the user to select from.</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>Returns</th>
<td>string</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php"><code>// Waits for any key press
Cli::prompt();
// Takes any input
$color = Cli::prompt('What is your favorite color?');
// Takes any input, but offers default
$color = Cli::prompt('What is your favorite color?', 'white');
// Will only accept the options in the array
$ready = Cli::prompt('Are you ready?', array('y','n'));</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_option">option($name, null)</h4>
<p>The <strong>option</strong> accepts an option from the initial command.</p>
<table class="method">
<tbody>
<tr>
<th class="legend">Static</th>
<td>Yes</td>
</tr>
<tr>
<th>Parameters</th>
<td>
<table class="parameters">
<tr>
<th>Param</th>
<th>Default</th>
<th class="description">Description</th>
</tr>
<tr>
<th><kbd>$name</kbd></th>
<td><em>Required</em></td>
<td>Name of the option.</td>
</tr>
<tr>
<th><kbd>$default</kbd></th>
<td><em>null</em></td>
<td>A default value in case the option is not provided.</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>Returns</th>
<td>string</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="cli"><code>$ php index.php user -v --v -name=John --name=John</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_wait">wait($seconds = 0, $countdown = false)</h4>
<p>The <strong>wait</strong> method will make the cli output wait for a given number of seconds and optionally show a countdown.</p>
<table class="method">
<tbody>
<tr>
<th class="legend">Static</th>
<td>Yes</td>
</tr>
<tr>
<th>Parameters</th>
<td>
<table class="parameters">
<tr>
<th>Param</th>
<th>Default</th>
<th class="description">Description</th>
</tr>
<tr>
<th><kbd>$seconds</kbd></th>
<td><i>0</i></td>
<td>Number of seconds to wait.</td>
</tr>
<tr>
<th><kbd>$countdown</kbd></th>
<td><i>false</i></td>
<td>Show the countdown in the output.</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>Returns</th>
<td>void</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php"><code>Cli::write('Loading...');
Cli::wait(5, true);</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_write">write($text = '', $foreground = null, $background = null)</h4>
<p>The <strong>write</strong> method will write a line of text to the command line.</p>
<table class="method">
<tbody>
<tr>
<th class="legend">Static</th>
<td>Yes</td>
</tr>
<tr>
<th>Parameters</th>
<td>
<table class="parameters">
<tr>
<th>Param</th>
<th>Default</th>
<th class="description">Description</th>
</tr>
<tr>
<th><kbd>$text</kbd></th>
<td><i>empty string</i></td>
<td>Text to output to the command line.</td>
</tr>
<tr>
<th><kbd>$foreground</kbd></th>
<td><i>null</i></td>
<td>Foreground color of the string.</td>
</tr>
<tr>
<th><kbd>$background</kbd></th>
<td><i>null</i></td>
<td>Background color of the string.</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>Returns</th>
<td>void</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php"><code>Cli::write('Hello World!');</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_stdout">stdout($resource = null)</h4>
<p>
Changes or retrieves the current stdout stream. This is STDOUT by default.<br/>
<br/>
Note the public property <code>$nocolor</code> can be set to true to force all output
to plaintext.
</p>
<table class="method">
<tbody>
<tr>
<th class="legend">Static</th>
<td>Yes</td>
</tr>
<tr>
<th>Parameters</th>
<td>
<table class="parameters">
<tr>
<th>Param</th>
<th>Default</th>
<th class="description">Description</th>
</tr>
<tr>
<th><kbd>$resource</kbd></th>
<td><i>null</i></td>
<td>Any writable filehandle, or null to retrieve the current filehandle.</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>Returns</th>
<td>The previous value of the filehandle (or current value if you are not changing it)</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php"><code>$buffer = fopen('php://temp', 'w+');
$stdout = Cli::stdout($buffer);
Cli::write("Hello World!");
Cli::error("Where's my text? :(");
Cli::stdout($stdout);
Cli::write("There it is!");
rewind($buffer);
file_put_contents('out.log', stream_get_contents($buffer));
// $ cat out.log
// Hello World!</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_stderr">stderr($resource = null)</h4>
<p>
Changes or retrieves the current stderr stream. This is STDERR by default.<br/>
<br/>
Note the public property <code>$nocolor</code> can be set to true to force all output
to plaintext.
</p>
<table class="method">
<tbody>
<tr>
<th class="legend">Static</th>
<td>Yes</td>
</tr>
<tr>
<th>Parameters</th>
<td>
<table class="parameters">
<tr>
<th>Param</th>
<th>Default</th>
<th class="description">Description</th>
</tr>
<tr>
<th><kbd>$resource</kbd></th>
<td><i>null</i></td>
<td>Any writable filehandle, or null to retrieve the current filehandle.</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>Returns</th>
<td>The previous value of the filehandle (or current value if you are not changing it)</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php"><code>$errors = fopen('php://temp', 'w+');
$stderr = Cli::stderr($errors);
Cli::write("Hello World!");
Cli::error("Where's my text? :(");
Cli::stderr($stderr);
Cli::write("There it is!");
rewind($errors);
file_put_contents('out.log', stream_get_contents($errors));
// $ cat out.log
// Where's my text? :(
</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
</div>
<footer>
<p>
© FuelPHP Development Team 2010-2018 - <a href="https://fuelphp.com">FuelPHP</a> is released under the MIT license.
</p>
</footer>
</div>
</body>
</html>