-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathusage.html
More file actions
565 lines (540 loc) · 14.3 KB
/
usage.html
File metadata and controls
565 lines (540 loc) · 14.3 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
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Session Class - Usage - 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>Session Class</h2>
<p>
The session class allows you to maintain state for your application in the stateless environment of the web.
It allows you to store variables on the server using a variety of storage solutions, and recall these variables on the next page request.
</p>
<p>
The static methods documented on this page use the session driver configured in the configuration via the <kbd>driver</kbd> setting.
When you have set the <kbd>auto_initialize</kbd> setting to <kbd>true</kbd>, the session will be loaded and initialized when the Fuel framework loads.
If it is set to <kbd>false</kbd>, it will be loaded automatically as soon as you use one of the methods below.
</p>
<p>
Note that if you choose not to <kbd>auto_initialize</kbd> the session, and you don't use any of the session methods, the session will not be refreshed!
This can cause unexpected behaviour of your application due to an expired session.
</p>
<article>
<h4 id="method_instance">instance($instance = null)</h4>
<p>The <strong>instance</strong> method returns the default session instance, or a specific instance, identified by name.</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>$instance</kbd></th>
<td><i>optional</i></td>
<td>Cookiename (as defined in config/session.php) that identifies the required session instance.</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>Returns</th>
<td>mixed - session object, or false in case the requested instance does not exist.</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php">
<code>// get the default session instance (identified by the 'driver' configuration setting).
$session = Session::instance();
// get a specific session instance
$session = Session::instance('myappcookie');
</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 id="method_set">set($variable, $value = null)</h4>
<p>The <strong>set</strong> method allows you to set a session variable.</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 session variable to set.</td>
</tr>
<tr>
<th><kbd>$value</kbd></th>
<td><i>optional</i></td>
<td>
The session variables value.<br />
This can be any data type, but pay attention when storing objects in the session, as session data is serialized, and there are restrictions to serializing an object.
</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>Returns</th>
<td>void</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php">
<code>// store the userid in the session
Session::set('userid', $userid);
// you can also store more complex values
Session::set('array', array('varA', 'varB', 'varC' => array('val1', 'val2'));
</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 id="method_get">get($variable = null, $default = null)</h4>
<p>The <strong>get</strong> method allows you to retrieve stored variables from the session.</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>$variable</kbd></th>
<td><i>required</i></td>
<td>Name of the session variable to get.</td>
</tr>
<tr>
<th><kbd>$default</kbd></th>
<td><i>optional</i></td>
<td>Default value to return in case the requested variable does not exist. If no default is given, the method will return <kbd>null</kbd>.</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>Returns</th>
<td>mixed - Dependent on the type of the stored <var>$variable</var>. The method returns <kbd>null</kbd> if the requested variable does not exist.</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php">
<code>// get the stored userid from the session
$userid = Session::get('userid');
if ( $userid === false )
{
echo "no user is logged in";
}
// you can retrieve the entire array stored
$arr = Session::get('array');
// or get a specific key from the array
$arr = Session::get('array.varC');
</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 id="method_delete">delete($variable)</h4>
<p>The <strong>delete</strong> method allows you to delete a stored session variable.</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>$variable</kbd></th>
<td><i>required</i></td>
<td>Name of the session variable to delete.</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>Returns</th>
<td>void</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php">
<code>// delete the stored userid from the session
Session::delete('userid');
// you can also delete a specific key from the array
Session::delete('array.varC');
</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 id="method_set_flash">set_flash($variable, $value = null)</h4>
<p>The <strong>set_flash</strong> method allows you to set a session flash variable. Flash variables have a limited lifespan. Depending on the configuration, they will be deleted after the next page request, or after they are retrieved.</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 session flash variable to set.</td>
</tr>
<tr>
<th><kbd>$value</kbd></th>
<td><i>optional</i></td>
<td>
The session flash variables value.<br />
This can be any data type, but pay attention when storing objects in the session, as session data is serialized, and there are restrictions to serializing an object.
</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>Returns</th>
<td>void</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php">
<code>// tell the next page request which step to process
Session::set_flash('step', 2);
// you can also store more complex values
Session::set_flash('array', array('varA', 'varB', 'varC' => array('val1', 'val2'));
</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 id="method_get_flash">get_flash($variable, $default = null)</h4>
<p>The <strong>get_flash</strong> method allows you to get a session flash variable. Flash variables have a limited lifespan. Depending on the configuration, they will be deleted after the next page request, or after they are retrieved.</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>$variable</kbd></th>
<td><i>required</i></td>
<td>Name of the session variable to get.</td>
</tr>
<tr>
<th><kbd>$default</kbd></th>
<td><i>optional</i></td>
<td>Default value to return in case the requested variable does not exist. If no default is given, the method will return <kbd>null</kbd>.</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>Returns</th>
<td>mixed - Dependent on the type of the stored <var>$variable</var>. The method returns <kbd>null</kbd> if the requested variable does not exist.</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php">
<code>// find out which step to process
$step = Session::get_flash('step');
</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 id="method_keep_flash">keep_flash($variable)</h4>
<p>The <strong>keep_flash</strong> method resets a flash variable stored in the session to an 'unrequested' state. This allows you to get a flash variable, and still pass it on to the next page request.</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>$variable</kbd></th>
<td><i>required</i></td>
<td>Name of the flash variable to keep.</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>Returns</th>
<td>void</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php">
<code>// keep the step value for one more page request
Session::keep_flash('step');
</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 id="method_delete_flash">delete_flash($variable)</h4>
<p>The <strong>delete_flash</strong> method allows you to delete a stored flash variable.</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>$variable</kbd></th>
<td><i>required</i></td>
<td>Name of the flash variable to delete.</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>Returns</th>
<td>void</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php">
<code>// delete the step from the session
Session::delete_flash('userid');
</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 id="method_create">create()</h4>
<p>The <strong>create</strong> method allows you to create a new session. If a session is already present, it will be destroyed when the new one is created.</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>void</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php">
<code>// create a new session
Session::create();
</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 id="method_destroy">destroy()</h4>
<p>The <strong>destroy</strong> method allows you to destroy an existing session.</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>void</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php">
<code>// destroy a session
Session::destroy();
</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 id="method_read">read()</h4>
<p>The <strong>read</strong> method allows you to manually read a session. The session is automatically read when the session class is initialized, so under normal circumstances there is no need to use this method.</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>void</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php">
<code>// read the session
Session::read();
</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 id="method_write">write()</h4>
<p>The <strong>write</strong> method allows you to manually write the session. Under normal circumstances, the session is automatically written when the script ends.</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>void</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php">
<code>// write the session
Session::write();
</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>