-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathinput.html
More file actions
500 lines (478 loc) · 12.1 KB
/
input.html
File metadata and controls
500 lines (478 loc) · 12.1 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
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
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Input 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>Input Class</h2>
<p>The input class allows you to access HTTP parameters, load server variables and user agent details.</p>
<article>
<h4 id="method_cookie">cookie($index, $default = null)</h4>
<p>The <strong>cookie</strong> method allows you to read $_COOKIE variables.</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>$index</kbd></th>
<td><i>Required</i></td>
<td>The key in the $_COOKIE array. Multi-dimensional arrays can be accessed by separating the levels by a dot (.)</td>
</tr>
<tr>
<th><kbd>$default</kbd></th>
<td><pre class="php"><code>null</code></pre></td>
<td>What value should be returned if the array item is not found?</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>Returns</th>
<td>mixed</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre><code class="php">Input::cookie('foo', 'bar');</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 id="method_delete">delete($index, $default = null)</h4>
<p>The <strong>delete</strong> method allows you to read parameters from php://input stream when called via DELETE.</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>$index</kbd></th>
<td><i>required</i></td>
<td>The key in the php://input stream.</td>
</tr>
<tr>
<th><kbd>$default</kbd></th>
<td><i>optional</i></td>
<td>What value should be returned if the array item is not found?</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>Returns</th>
<td>mixed</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre><code class="php">Input::delete('foo', 'bar');</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 id="method_get">get($index, $default = null)</h4>
<p>The <strong>get</strong> method allows you to read $_GET variables.</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>$index</kbd></th>
<td><i>required</i></td>
<td>The key in the $_GET array, or <kbd>null</kbd> for the entire array. Multi-dimensional arrays can be accessed by separating the levels by a dot (.)</td>
</tr>
<tr>
<th><kbd>$default</kbd></th>
<td><i>optional</i></td>
<td>What value should be returned if the array item is not found?</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>Returns</th>
<td>mixed</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre><code class="php">Input::get('foo', 'bar');
// You can go multiple levels deep as well.
// This will return $_GET['somevar']['foo']['bar']
Input::get('somevar.foo.bar');</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 id="method_post">post($index, $default = null)</h4>
<p>The <strong>post</strong> method allows you to read $_POST variables.</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>$index</kbd></th>
<td><i>required</i></td>
<td>The key in the $_POST array, or <kbd>null</kbd> for the entire array. Multi-dimensional arrays can be accessed by separating the levels by a dot (.)</td>
</tr>
<tr>
<th><kbd>$default</kbd></th>
<td><i>optional</i></td>
<td>What value should be returned if the array item is not found?</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>Returns</th>
<td>mixed</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre><code class="php">Input::post('foo', 'bar');
// You can go multiple levels deep as well.
// This will return $_POST['somevar']['foo']['bar']
Input::post('somevar.foo.bar');</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 id="method_get_post">get_post($index, $default = null)</h4>
<p>The <strong>get_post</strong> method allows you to read from $_GET and $_POST variables, checking $_GET first.</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>$index</kbd></th>
<td><i>required</i></td>
<td>The key in the $_GET or $_POST array. Multi-dimensional arrays can be accessed by separating the levels by a dot (.)</td>
</tr>
<tr>
<th><kbd>$default</kbd></th>
<td><i>optional</i></td>
<td>What value should be returned if the array item is not found?</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>Returns</th>
<td>mixed</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre><code class="php">Input::get_post('foo', 'bar');</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 id="method_is_ajax">is_ajax()</h4>
<p>The <strong>is_ajax</strong> method returns true if the controller is called via AJAX.</p>
<table class="method">
<tbody>
<tr>
<th class="legend">Static</th>
<td>Yes</td>
</tr>
<tr>
<th>Parameters</th>
<td>None</td>
</tr>
<tr>
<th>Returns</th>
<td>mixed</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre><code class="php">Input::is_ajax(); // false</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 id="method_method">method()</h4>
<p>The <strong>method</strong> method returns the HTTP method used to call the controller.</p>
<table class="method">
<tbody>
<tr>
<th class="legend">Static</th>
<td>Yes</td>
</tr>
<tr>
<th>Parameters</th>
<td>None</td>
</tr>
<tr>
<th>Returns</th>
<td>string</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre><code class="php">Input::method(); // "GET"</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 id="method_protocol">protocol()</h4>
<p>The <strong>protocol</strong> method returns the HTTP protocol used to call the controller.</p>
<table class="method">
<tbody>
<tr>
<th class="legend">Static</th>
<td>Yes</td>
</tr>
<tr>
<th>Parameters</th>
<td>None</td>
</tr>
<tr>
<th>Returns</th>
<td>string</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre><code class="php">Input::protocol(); // "HTTP"</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 id="method_put">put($index, $default = null)</h4>
<p>The <strong>put</strong> method allows you to read parameters from php://input stream when called via PUT.</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>$index</kbd></th>
<td><i>required</i></td>
<td>The key in the php://input stream.</td>
</tr>
<tr>
<th><kbd>$default</kbd></th>
<td><i>optional</i></td>
<td>What value should be returned if the array item is not found?</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>Returns</th>
<td>mixed</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre><code class="php">Input::put('foo', 'bar');</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 id="method_ip">ip()</h4>
<p>The <strong>ip</strong> method returns the public IP address of the user. If the user operates from behind a proxy server, the IP address of that server is returned.</p>
<table class="method">
<tbody>
<tr>
<th class="legend">Static</th>
<td>Yes</td>
</tr>
<tr>
<th>Parameters</th>
<td>None</td>
</tr>
<tr>
<th>Returns</th>
<td>string</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre><code class="php">echo Input::ip(); // 73.194.37.104 (public IP address)</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 id="method_real_ip">real_ip()</h4>
<p>The <strong>real_ip</strong> method returns the 'real' IP address of the user. If a proxy server is detected, it will attempt to determine the user's private IP address from the information the proxy adds to the header. If this information is not present, the public IP address is returned.</p>
<table class="method">
<tbody>
<tr>
<th class="legend">Static</th>
<td>Yes</td>
</tr>
<tr>
<th>Parameters</th>
<td>None</td>
</tr>
<tr>
<th>Returns</th>
<td>string</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre><code class="php">echo Input::real_ip(); // 10.76.12.199 (private IP behind a proxy server)</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 id="method_server">server($index, $default = null)</h4>
<p>The <strong>server</strong> method allows you to read parameters from the $_SERVER array with default values.</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>$index</kbd></th>
<td><i>required</i></td>
<td>The key in the $_SERVER array.</td>
</tr>
<tr>
<th><kbd>$default</kbd></th>
<td><i>optional</i></td>
<td>What value should be returned if the array item is not found?</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>Returns</th>
<td>string</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre><code class="php">Input::server('HTTP_HOST'); // "localhost:8080"</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>