-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathview.html
More file actions
540 lines (505 loc) · 13.5 KB
/
view.html
File metadata and controls
540 lines (505 loc) · 13.5 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
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>View 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>View Class</h2>
<p>
The View class acts as an object wrapper for HTML pages with embedded PHP, called "views".
Variables can be assigned with the view object and referenced locally within the view.
</p>
<p>
<a href="../general/views.html">Read more about using views.</a>
</p>
<article>
<h4 id="method_construct">__construct($file = null, $data = null, $auto_encode = null)</h4>
<table class="method">
<tbody>
<tr>
<th>Static</th>
<td>No</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>$file</kbd></th>
<td><em>null</em></td>
<td class="description">the view filename, if not supplied you must supply it later through <em>set_filename</em> or supply it in <em>render</em>. View files should be relative to the <em>app/views</em> directory.</td>
</tr>
<tr>
<th><kbd>$data</kbd></th>
<td><em>null</em></td>
<td class="description">array of values</td>
</tr>
<tr>
<th><kbd>$auto_encode</kbd></th>
<td><em>null</em></td>
<td class="description">set to <em>true</em> or <em>false</em> to set auto encoding, defaults to main config setting (app/config/config.php)</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>Returns</th>
<td>a new <em>View</em> object</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php"><code>$view = new View('path/to/view', array(
'menu' => $menu,
'articles' => $articles,
'footer_links' => $footer_links,
), false);
</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 id="method_factory">factory($file = null, $data = null, $auto_encode = null)</h4>
<p>The <strong>factory</strong> method returns a new View object.</p>
<table class="method">
<tbody>
<tr>
<th>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>$file</kbd></th>
<td><em>null</em></td>
<td class="description">the view filename, if not supplied you must supply it later through <em>set_filename</em> or supply it in <em>render</em>. View files should be relative to the <em>app/views</em> directory and be supplied without the <strong>.php</strong> file extension.</td>
</tr>
<tr>
<th><kbd>$data</kbd></th>
<td><em>null</em></td>
<td class="description">array of values</td>
</tr>
<tr>
<th><kbd>$auto_encode</kbd></th>
<td><em>null</em></td>
<td class="description">tet to <em>true</em> or <em>false</em> to set auto encoding, defaults to main config setting (app/config/config.php)</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>Returns</th>
<td>a new <em>View</em> object</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php"><code>// Will create a View object for APPPATH/
$view = View::factory('path/to/view', array(
'menu' => $menu,
'articles' => $articles,
'footer_links' => $footer_links,
), false);
</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 id="method_auto_encode">auto_encode($encode = true)</h4>
<p>The <strong>auto_encode</strong> sets whether to encode the data or not on a View instance.</p>
<table class="method">
<tbody>
<tr>
<th>Static</th>
<td>No</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>$encode</kbd></th>
<td><em>true</em></td>
<td class="description">whether to encode the data or not on a View instance</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>Returns</th>
<td>Current View object</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php"><code>$view = View::factory('path/to/view', array(
'menu' => $menu,
'articles' => $articles,
'footer_links' => $footer_links,
));
$view->auto_encode();
// or set it to false
$view->auto_encode(false);
// or chain it
$view = View::factory('path/to/view', array(
'menu' => $menu,
'articles' => $articles,
'footer_links' => $footer_links,
))->auto_encode();
</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 id="method_set_filename">set_filename($file)</h4>
<p>The <strong>set_filename</strong> allows you to set or change the view filename.</p>
<table class="method">
<tbody>
<tr>
<th>Static</th>
<td>No</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>$file</kbd></th>
<td><em>required</em></td>
<td class="description">the view filename, view files should be relative to the <em>app/views</em> directory and be supplied without the <strong>.php</strong> extension.</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>Returns</th>
<td>Current View object</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php"><code>$view = new View();
$view->set_filename('path/to/view');
</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 id="method_set">set($key, $value = null, $encode = null)</h4>
<p>The <strong>set</strong> assigns a variable to a view.</p>
<table class="method">
<tbody>
<tr>
<th>Static</th>
<td>No</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>$key</kbd></th>
<td><em>required</em></td>
<td class="description">variable name or array of variables</td>
</tr>
<tr>
<th><kbd>$value</kbd></th>
<td><em>null</em></td>
<td class="description">the value</td>
</tr>
<tr>
<th><kbd>$encode</kbd></th>
<td><em>null</em></td>
<td class="description">set to <em>true</em> or <em>false</em> to encoding, defaults to main auto encoding setting</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>Returns</th>
<td>Current View object</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php"><code>$view = new View;
$view->set('users', $users, false);
// or set an array
$view->set(array(
'users' => $users,
'articles' => $articles,
), null, true);
// If you need HTML / Javascript passed you need to set the last param to false
// when output encoding is enabled.
$view->set('example', '<h1>Heading</h1>', false);
</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 id="method_set_global">set_global($key, $value = null, $encode = null)</h4>
<p>The <strong>set_global</strong> sets a variable accessible for all views.</p>
<table class="method">
<tbody>
<tr>
<th>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>$key</kbd></th>
<td><em>required</em></td>
<td class="description">variable name or array of variables</td>
</tr>
<tr>
<th><kbd>$value</kbd></th>
<td><em>null</em></td>
<td class="description">the value</td>
</tr>
<tr>
<th><kbd>$encode</kbd></th>
<td><em>null</em></td>
<td class="description">set to <em>true</em> or <em>false</em> to encoding, defaults to main auto encoding setting</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>Returns</th>
<td><em>Void</em></td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php"><code>View::set_global('users', $users, false);
// or set an array
View::set_global(array(
'users' => $users,
'articles' => $articles,
), null, true);
</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 id="method_bind">bind($key, $value = null)</h4>
<p>
Assigns a value by reference. The benefit of binding is that values can be altered without re-setting
them. It is also possible to bind variables before they have values. Assigned values will be available
as a variable within the view file.
</p>
<p class="note">Please note: these cannot be cleaned by output encoding and should thus be considered unsafe.</p>
<table class="method">
<tbody>
<tr>
<th>Static</th>
<td>No</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>$key</kbd></th>
<td><em>required</em></td>
<td class="description">variable name or array of variables</td>
</tr>
<tr>
<th><kbd>$value</kbd></th>
<td><em>null</em></td>
<td class="description">the value</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>Returns</th>
<td>Current View object</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php"><code>$view = new View;
$view->bind('users', $users, false);
// or set an array
$view->bind(array(
'users' => $users,
'articles' => $articles,
), null, true);
</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 id="method_bind_global">bind_global($key, $value = null)</h4>
<p>The <strong>bind_global</strong> assigns a global variable by reference accessible for all views.</p>
<p class="note">Please note: these cannot be cleaned by output encoding and should thus be considered unsafe.</p>
<table class="method">
<tbody>
<tr>
<th>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>$key</kbd></th>
<td><em>required</em></td>
<td class="description">variable name or array of variables</td>
</tr>
<tr>
<th><kbd>$value</kbd></th>
<td><em>required</em></td>
<td class="description">the value</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>Returns</th>
<td><em>Void</em></td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php"><code>View::bind_global('users', $users);
</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 id="method_render">render($file = null)</h4>
<p>
The <strong>set</strong> renders the view object to a string.
Global and local data are merged and extracted to create local variables within the view file.
</p>
<table class="method">
<tbody>
<tr>
<th>Static</th>
<td>No</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>$file</kbd></th>
<td><em>null</em></td>
<td class="description">the view filename</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>Returns</th>
<td><strong>the rendered view file</strong></td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php"><code>$html = View::factory()->render('path/to/view');
// or
$html = View::factory('path/to/view')->render();
// or
$html = View::factory()->set_filename('path/to/view')->render();
</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>