-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathcookie.html
More file actions
242 lines (230 loc) · 6.78 KB
/
Copy pathcookie.html
File metadata and controls
242 lines (230 loc) · 6.78 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
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Cookie 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>Cookie Class</h2>
<p>The cookie class allows you to get, set and delete cookies.</p>
<h3>Configuration</h3>
<p>The cookie class is configured through the global application configuration file, <strong>app/config/config.php</strong>. It defines a section called '<strong>cookie</strong>', in which the following settings are defined:</p>
<table class="method">
<tbody>
<tr>
<th>Variable</th>
<th>Type</th>
<th>Default</th>
<th class="description">Description</th>
</tr>
<tr>
<th><kbd>expiration</kbd></th>
<td>integer</td>
<td><pre class="php"><code>0</code></pre></td>
<td>Number of seconds before the cookie expires. This value will be used when $expiration is not specified when you call the set() method.</td>
</tr>
<tr>
<th><kbd>path</kbd></th>
<td>string</td>
<td><pre class="php"><code>'/'</code></pre></td>
<td>Restrict the path that the cookie is available to. This value will be used when $path is not specified when you call the set() method.</td>
</tr>
<tr>
<th><kbd>domain</kbd></th>
<td>string</td>
<td><pre class="php"><code>null</code></pre></td>
<td>Restrict the domain that the cookie is available to. This value will be used when $domain is not specified when you call the set() method.</td>
</tr>
<tr>
<th><kbd>secure</kbd></th>
<td>boolean</td>
<td><pre class="php"><code>false</code></pre></td>
<td>Set to true if you only want to transmit cookies over secure connections.</td>
</tr>
<tr>
<th><kbd> httponly</kbd></th>
<td>boolean</td>
<td><pre class="php"><code>false</code></pre></td>
<td>Allow only transmit of cookies over HTTP, disabling Javascript access.</td>
</tr>
</tbody>
</table>
<p>If one or more of these values are missing from the global configuration, the class will use the defaults as defined in this table.</p>
<article>
<h4 id="method_get">get($name, $default = null)</h4>
<p>The <strong>get</strong> method allows you to read a $_COOKIE 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>The key in the $_COOKIE array.</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 class="php"><code>$theme = Cookie::get('theme', 'blue');</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 id="method_set">set($name, $value, $expiration = null, $path = null, $domain = null)</h4>
<p>The <strong>set</strong> method allows you to create a cookie.</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>The key in the $_COOKIE array.</td>
</tr>
<tr>
<th><kbd>$value</kbd></th>
<td><i>Required</i></td>
<td>The value of the cookie.</td>
</tr>
<tr>
<th><kbd>$expiration</kbd></th>
<td><pre class="php"><code>null</code></pre></td>
<td>Number of seconds the cookie should last for.</td>
</tr>
<tr>
<th><kbd>$path</kbd></th>
<td><pre class="php"><code>null</code></pre></td>
<td>The path on the server in which the cookie will be available on.</td>
</tr>
<tr>
<th><kbd>$domain</kbd></th>
<td><pre class="php"><code>null</code></pre></td>
<td>The domain that the cookie is available to.</td>
</tr>
<tr>
<th><kbd>$secure</kbd></th>
<td><pre class="php"><code>null</code></pre></td>
<td>Set to true if you only want to transmit cookies over secure connections.</td>
</tr>
<tr>
<th><kbd>$httponly</kbd></th>
<td><pre class="php"><code>null</code></pre></td>
<td>Allow only transmit of cookies over HTTP, disabling Javascript access.</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>Returns</th>
<td>boolean</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php"><code>Cookie::set('theme', 'blue', 60 * 60 * 24);</code></pre>
</td>
</tr>
</tbody>
</table>
<p>For every parameter not specified of defined as <strong>null</strong>, the globally defined configuration value will be substituted.</p>
</article>
<article>
<h4 id="method_delete">delete($name)</h4>
<p>The <strong>delete</strong> method deletes a parameter from the $_COOKIE array.</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>Remove a cookie item.</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>Returns</th>
<td>void</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php"><code>Cookie::delete('theme')</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>