-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathcli.html
More file actions
384 lines (358 loc) · 8.55 KB
/
cli.html
File metadata and controls
384 lines (358 loc) · 8.55 KB
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
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Cli Class - Fuel Documentation</title>
<link href="../assets/css/main.css" media="screen" rel="stylesheet" />
<script type="text/javascript" src="../assets/js/jquery-1.4.4.min.js"></script>
<script type="text/javascript" src="../assets/js/nav.js"></script>
<script type="text/javascript" src="../assets/js/highlight.pack.js"></script>
<script type="text/javascript">
$(function() {
show_nav('classes', '../');
});
hljs.tabReplace = ' ';
hljs.initHighlightingOnLoad();
</script>
</head>
<body>
<header>
<h1>Fuel Documentation</h1>
</header>
<div id="main-nav"></div>
<section id="content">
<h2>Cli Class</h2>
<p>Interact with the command line by accepting input options, parameters and output text.</p>
<article>
<h4 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><i>1</i></td>
<td>Number of beeps.</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>Returns</th>
<td>void</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre><code>Cli::beep(25);</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 id="method_color">color($text, $foreground, $background = 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>
</table>
</td>
</tr>
<tr>
<th>Returns</th>
<td>string</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre><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 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><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 id="method_prompt">prompt($question = null, $options = array())</h4>
<p>The <strong>read</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><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 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><i>Required</i></td>
<td>Name of the option.</td>
</tr>
<tr>
<th><kbd>$default</kbd></th>
<td><i>null</i></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>$ php index.php user -v --v -name=John --name=John</pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 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><code>Cli::write('Loading...');
Cli::wait(5, true);</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 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><code>Cli::write('Hello World!');</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
</section>
<section id="footer">
<p>
<a href="http://fuelphp.com">Fuel</a> is released under the MIT license.<br />
© 2010 - 2011 Fuel Development Team
</p>
</section>
</body>
</html>