|
0
|
1 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> |
|
|
2 |
<html xmlns:yui="http://yuilibrary.com/rdf/1.0/yui.rdf#"> |
|
|
3 |
<head> |
|
|
4 |
<meta http-equiv="content-type" content="text/html; charset=UTF-8" /> |
|
|
5 |
<title>API: cookie Cookie (YUI Library)</title> |
|
|
6 |
|
|
|
7 |
<link rel="stylesheet" type="text/css" href="assets/reset-fonts-grids-min.css" /> |
|
|
8 |
<link rel="stylesheet" type="text/css" href="assets/api.css" /> |
|
|
9 |
|
|
|
10 |
<script type="text/javascript" src="assets/api-js"></script> |
|
|
11 |
<script type="text/javascript" src="assets/ac-js"></script> |
|
|
12 |
</head> |
|
|
13 |
|
|
|
14 |
<body id="yahoo-com"> |
|
|
15 |
|
|
|
16 |
<div id="doc3" class="yui-t2"> |
|
|
17 |
<div id="hd"> |
|
|
18 |
<h1><a href="http://developer.yahoo.com/yui/" title="Yahoo! UI Library">Yahoo! UI Library</a></h1> |
|
|
19 |
<h3>cookie <span class="subtitle">3.0.0</span></h3> |
|
|
20 |
<a href="./index.html" title="Yahoo! UI Library">Yahoo! UI Library</a> |
|
|
21 |
> <a href="./module_cookie.html" title="cookie">cookie</a> |
|
|
22 |
> Cookie |
|
|
23 |
|
|
|
24 |
<form onsubmit="return false"> |
|
|
25 |
<div id="propertysearch"> |
|
|
26 |
Search: <input autocomplete="off" id="searchinput" /> |
|
|
27 |
<div id="searchresults"> |
|
|
28 |
|
|
|
29 |
</div> |
|
|
30 |
</div> |
|
|
31 |
</form> |
|
|
32 |
</div> |
|
|
33 |
|
|
|
34 |
<div id="bd"> |
|
|
35 |
<div id="yui-main"> |
|
|
36 |
<div class="yui-b"> |
|
|
37 |
<form action="#" name="yui-classopts-form" method="get" id="yui-classopts-form"> |
|
|
38 |
<fieldset> |
|
|
39 |
<legend>Filters</legend> |
|
|
40 |
<span class="classopts"><input type="checkbox" name="show_private" id="show_private" /> <label for="show_private">Show Private</label></span> |
|
|
41 |
<span class="classopts"><input type="checkbox" name="show_protected" id="show_protected" /> <label for="show_protected">Show Protected</label></span> |
|
|
42 |
<span class="classopts"><input type="checkbox" name="show_deprecated" id="show_deprecated" /> <label for="show_deprecated">Show Deprecated</label></span> |
|
|
43 |
</fieldset> |
|
|
44 |
</form> |
|
|
45 |
|
|
|
46 |
<h2> |
|
|
47 |
|
|
|
48 |
|
|
|
49 |
<code>static</code> |
|
|
50 |
|
|
|
51 |
Class <b property="yui:name">Cookie</b> |
|
|
52 |
<span class="extends"> |
|
|
53 |
</span> |
|
|
54 |
|
|
|
55 |
</h2> |
|
|
56 |
<!-- class tree goes here --> |
|
|
57 |
|
|
|
58 |
|
|
|
59 |
|
|
|
60 |
|
|
|
61 |
<div class="summary description" property="yui:description"> |
|
|
62 |
Cookie utility. |
|
|
63 |
</div> |
|
|
64 |
|
|
|
65 |
|
|
|
66 |
<div rel="yui:properties" resource="#properties"> |
|
|
67 |
|
|
|
68 |
</div> |
|
|
69 |
|
|
|
70 |
<div rel="yui:methods" resource="#methods"> |
|
|
71 |
<div class="section method details"> |
|
|
72 |
<h3 id="methods">Methods</h3> |
|
|
73 |
<div class="content"> |
|
|
74 |
<div class="private" rel="yui:method" resource="#method__createCookieHashString"> |
|
|
75 |
<h4> |
|
|
76 |
<a name="method__createCookieHashString">_createCookieHashString</a></h4> |
|
|
77 |
<div class="detail" > |
|
|
78 |
<code> |
|
|
79 |
private |
|
|
80 |
static |
|
|
81 |
|
|
|
82 |
String |
|
|
83 |
<strong property="yui:name">_createCookieHashString</strong> |
|
|
84 |
( |
|
|
85 |
|
|
|
86 |
|
|
|
87 |
hash |
|
|
88 |
|
|
|
89 |
|
|
|
90 |
) |
|
|
91 |
</code> |
|
|
92 |
|
|
|
93 |
<div class="description" property="yui:description"> |
|
|
94 |
Formats a cookie value for an object containing multiple values. |
|
|
95 |
</div> |
|
|
96 |
|
|
|
97 |
<div class="description"> |
|
|
98 |
|
|
|
99 |
<dl rel="yui:parameters"> |
|
|
100 |
<dt>Parameters:</dt> |
|
|
101 |
<dd rel="yui:parameter"> |
|
|
102 |
<code><span property="yui:name">hash</span> |
|
|
103 |
<<span property="yui:type">Object</span>> |
|
|
104 |
</code> |
|
|
105 |
<span property="yui:description"> An object of key-value pairs to create a string for.</span> |
|
|
106 |
</dd> |
|
|
107 |
</dl> |
|
|
108 |
|
|
|
109 |
<dl> |
|
|
110 |
<dt>Returns: |
|
|
111 |
<code property="yui:return"> |
|
|
112 |
String |
|
|
113 |
</code></dt> |
|
|
114 |
<dd property="yui:returnInfo">A string suitable for use as a cookie value.</dd> |
|
|
115 |
</dl> |
|
|
116 |
|
|
|
117 |
|
|
|
118 |
|
|
|
119 |
|
|
|
120 |
</div> |
|
|
121 |
|
|
|
122 |
</div> |
|
|
123 |
<hr /> |
|
|
124 |
</div> |
|
|
125 |
<div class="private" rel="yui:method" resource="#method__createCookieString"> |
|
|
126 |
<h4> |
|
|
127 |
<a name="method__createCookieString">_createCookieString</a></h4> |
|
|
128 |
<div class="detail" > |
|
|
129 |
<code> |
|
|
130 |
private |
|
|
131 |
static |
|
|
132 |
|
|
|
133 |
String |
|
|
134 |
<strong property="yui:name">_createCookieString</strong> |
|
|
135 |
( |
|
|
136 |
|
|
|
137 |
|
|
|
138 |
name |
|
|
139 |
|
|
|
140 |
|
|
|
141 |
, |
|
|
142 |
value |
|
|
143 |
|
|
|
144 |
|
|
|
145 |
, |
|
|
146 |
encodeValue |
|
|
147 |
|
|
|
148 |
|
|
|
149 |
, |
|
|
150 |
options |
|
|
151 |
|
|
|
152 |
|
|
|
153 |
) |
|
|
154 |
</code> |
|
|
155 |
|
|
|
156 |
<div class="description" property="yui:description"> |
|
|
157 |
Creates a cookie string that can be assigned into document.cookie. |
|
|
158 |
</div> |
|
|
159 |
|
|
|
160 |
<div class="description"> |
|
|
161 |
|
|
|
162 |
<dl rel="yui:parameters"> |
|
|
163 |
<dt>Parameters:</dt> |
|
|
164 |
<dd rel="yui:parameter"> |
|
|
165 |
<code><span property="yui:name">name</span> |
|
|
166 |
<<span property="yui:type">String</span>> |
|
|
167 |
</code> |
|
|
168 |
<span property="yui:description"> The name of the cookie.</span> |
|
|
169 |
</dd> |
|
|
170 |
<dd rel="yui:parameter"> |
|
|
171 |
<code><span property="yui:name">value</span> |
|
|
172 |
<<span property="yui:type">String</span>> |
|
|
173 |
</code> |
|
|
174 |
<span property="yui:description"> The value of the cookie.</span> |
|
|
175 |
</dd> |
|
|
176 |
<dd rel="yui:parameter"> |
|
|
177 |
<code><span property="yui:name">encodeValue</span> |
|
|
178 |
<<span property="yui:type">Boolean</span>> |
|
|
179 |
</code> |
|
|
180 |
<span property="yui:description"> True to encode the value, false to leave as-is.</span> |
|
|
181 |
</dd> |
|
|
182 |
<dd rel="yui:parameter"> |
|
|
183 |
<code><span property="yui:name">options</span> |
|
|
184 |
<<span property="yui:type">Object</span>> |
|
|
185 |
</code> |
|
|
186 |
<span property="yui:description"> (Optional) Options for the cookie.</span> |
|
|
187 |
</dd> |
|
|
188 |
</dl> |
|
|
189 |
|
|
|
190 |
<dl> |
|
|
191 |
<dt>Returns: |
|
|
192 |
<code property="yui:return"> |
|
|
193 |
String |
|
|
194 |
</code></dt> |
|
|
195 |
<dd property="yui:returnInfo">The formatted cookie string.</dd> |
|
|
196 |
</dl> |
|
|
197 |
|
|
|
198 |
|
|
|
199 |
|
|
|
200 |
|
|
|
201 |
</div> |
|
|
202 |
|
|
|
203 |
</div> |
|
|
204 |
<hr /> |
|
|
205 |
</div> |
|
|
206 |
<div class="private" rel="yui:method" resource="#method__parseCookieHash"> |
|
|
207 |
<h4> |
|
|
208 |
<a name="method__parseCookieHash">_parseCookieHash</a></h4> |
|
|
209 |
<div class="detail" > |
|
|
210 |
<code> |
|
|
211 |
private |
|
|
212 |
static |
|
|
213 |
|
|
|
214 |
Object |
|
|
215 |
<strong property="yui:name">_parseCookieHash</strong> |
|
|
216 |
( |
|
|
217 |
|
|
|
218 |
|
|
|
219 |
text |
|
|
220 |
|
|
|
221 |
|
|
|
222 |
) |
|
|
223 |
</code> |
|
|
224 |
|
|
|
225 |
<div class="description" property="yui:description"> |
|
|
226 |
Parses a cookie hash string into an object. |
|
|
227 |
</div> |
|
|
228 |
|
|
|
229 |
<div class="description"> |
|
|
230 |
|
|
|
231 |
<dl rel="yui:parameters"> |
|
|
232 |
<dt>Parameters:</dt> |
|
|
233 |
<dd rel="yui:parameter"> |
|
|
234 |
<code><span property="yui:name">text</span> |
|
|
235 |
<<span property="yui:type">String</span>> |
|
|
236 |
</code> |
|
|
237 |
<span property="yui:description"> The cookie hash string to parse (format: n1=v1&n2=v2).</span> |
|
|
238 |
</dd> |
|
|
239 |
</dl> |
|
|
240 |
|
|
|
241 |
<dl> |
|
|
242 |
<dt>Returns: |
|
|
243 |
<code property="yui:return"> |
|
|
244 |
Object |
|
|
245 |
</code></dt> |
|
|
246 |
<dd property="yui:returnInfo">An object containing entries for each cookie value.</dd> |
|
|
247 |
</dl> |
|
|
248 |
|
|
|
249 |
|
|
|
250 |
|
|
|
251 |
|
|
|
252 |
</div> |
|
|
253 |
|
|
|
254 |
</div> |
|
|
255 |
<hr /> |
|
|
256 |
</div> |
|
|
257 |
<div class="private" rel="yui:method" resource="#method__parseCookieString"> |
|
|
258 |
<h4> |
|
|
259 |
<a name="method__parseCookieString">_parseCookieString</a></h4> |
|
|
260 |
<div class="detail" > |
|
|
261 |
<code> |
|
|
262 |
private |
|
|
263 |
static |
|
|
264 |
|
|
|
265 |
Object |
|
|
266 |
<strong property="yui:name">_parseCookieString</strong> |
|
|
267 |
( |
|
|
268 |
|
|
|
269 |
|
|
|
270 |
text |
|
|
271 |
|
|
|
272 |
|
|
|
273 |
, |
|
|
274 |
shouldDecode |
|
|
275 |
|
|
|
276 |
|
|
|
277 |
) |
|
|
278 |
</code> |
|
|
279 |
|
|
|
280 |
<div class="description" property="yui:description"> |
|
|
281 |
Parses a cookie string into an object representing all accessible cookies. |
|
|
282 |
</div> |
|
|
283 |
|
|
|
284 |
<div class="description"> |
|
|
285 |
|
|
|
286 |
<dl rel="yui:parameters"> |
|
|
287 |
<dt>Parameters:</dt> |
|
|
288 |
<dd rel="yui:parameter"> |
|
|
289 |
<code><span property="yui:name">text</span> |
|
|
290 |
<<span property="yui:type">String</span>> |
|
|
291 |
</code> |
|
|
292 |
<span property="yui:description"> The cookie string to parse.</span> |
|
|
293 |
</dd> |
|
|
294 |
<dd rel="yui:parameter"> |
|
|
295 |
<code><span property="yui:name">shouldDecode</span> |
|
|
296 |
<<span property="yui:type">Boolean</span>> |
|
|
297 |
</code> |
|
|
298 |
<span property="yui:description"> (Optional) Indicates if the cookie values should be decoded or not. Default is true.</span> |
|
|
299 |
</dd> |
|
|
300 |
</dl> |
|
|
301 |
|
|
|
302 |
<dl> |
|
|
303 |
<dt>Returns: |
|
|
304 |
<code property="yui:return"> |
|
|
305 |
Object |
|
|
306 |
</code></dt> |
|
|
307 |
<dd property="yui:returnInfo">An object containing entries for each accessible cookie.</dd> |
|
|
308 |
</dl> |
|
|
309 |
|
|
|
310 |
|
|
|
311 |
|
|
|
312 |
|
|
|
313 |
</div> |
|
|
314 |
|
|
|
315 |
</div> |
|
|
316 |
<hr /> |
|
|
317 |
</div> |
|
|
318 |
<div class="" rel="yui:method" resource="#method_exists"> |
|
|
319 |
<h4> |
|
|
320 |
<a name="method_exists">exists</a></h4> |
|
|
321 |
<div class="detail" > |
|
|
322 |
<code> |
|
|
323 |
|
|
|
324 |
static |
|
|
325 |
|
|
|
326 |
Boolean |
|
|
327 |
<strong property="yui:name">exists</strong> |
|
|
328 |
( |
|
|
329 |
|
|
|
330 |
|
|
|
331 |
name |
|
|
332 |
|
|
|
333 |
|
|
|
334 |
) |
|
|
335 |
</code> |
|
|
336 |
|
|
|
337 |
<div class="description" property="yui:description"> |
|
|
338 |
Determines if the cookie with the given name exists. This is useful for |
|
|
339 |
Boolean cookies (those that do not follow the name=value convention). |
|
|
340 |
</div> |
|
|
341 |
|
|
|
342 |
<div class="description"> |
|
|
343 |
|
|
|
344 |
<dl rel="yui:parameters"> |
|
|
345 |
<dt>Parameters:</dt> |
|
|
346 |
<dd rel="yui:parameter"> |
|
|
347 |
<code><span property="yui:name">name</span> |
|
|
348 |
<<span property="yui:type">String</span>> |
|
|
349 |
</code> |
|
|
350 |
<span property="yui:description"> The name of the cookie to check.</span> |
|
|
351 |
</dd> |
|
|
352 |
</dl> |
|
|
353 |
|
|
|
354 |
<dl> |
|
|
355 |
<dt>Returns: |
|
|
356 |
<code property="yui:return"> |
|
|
357 |
Boolean |
|
|
358 |
</code></dt> |
|
|
359 |
<dd property="yui:returnInfo">True if the cookie exists, false if not.</dd> |
|
|
360 |
</dl> |
|
|
361 |
|
|
|
362 |
|
|
|
363 |
|
|
|
364 |
|
|
|
365 |
</div> |
|
|
366 |
|
|
|
367 |
</div> |
|
|
368 |
<hr /> |
|
|
369 |
</div> |
|
|
370 |
<div class="" rel="yui:method" resource="#method_get"> |
|
|
371 |
<h4> |
|
|
372 |
<a name="method_get">get</a></h4> |
|
|
373 |
<div class="detail" > |
|
|
374 |
<code> |
|
|
375 |
|
|
|
376 |
static |
|
|
377 |
|
|
|
378 |
Variant |
|
|
379 |
<strong property="yui:name">get</strong> |
|
|
380 |
( |
|
|
381 |
|
|
|
382 |
|
|
|
383 |
name |
|
|
384 |
|
|
|
385 |
|
|
|
386 |
, |
|
|
387 |
options |
|
|
388 |
|
|
|
389 |
|
|
|
390 |
) |
|
|
391 |
</code> |
|
|
392 |
|
|
|
393 |
<div class="description" property="yui:description"> |
|
|
394 |
Returns the cookie value for the given name. |
|
|
395 |
</div> |
|
|
396 |
|
|
|
397 |
<div class="description"> |
|
|
398 |
|
|
|
399 |
<dl rel="yui:parameters"> |
|
|
400 |
<dt>Parameters:</dt> |
|
|
401 |
<dd rel="yui:parameter"> |
|
|
402 |
<code><span property="yui:name">name</span> |
|
|
403 |
<<span property="yui:type">String</span>> |
|
|
404 |
</code> |
|
|
405 |
<span property="yui:description"> The name of the cookie to retrieve.</span> |
|
|
406 |
</dd> |
|
|
407 |
<dd rel="yui:parameter"> |
|
|
408 |
<code><span property="yui:name">options</span> |
|
|
409 |
<<span property="yui:type">Function|Object</span>> |
|
|
410 |
</code> |
|
|
411 |
<span property="yui:description"> (Optional) An object containing one or more |
|
|
412 |
cookie options: raw (true/false) and converter (a function). |
|
|
413 |
The converter function is run on the value before returning it. The |
|
|
414 |
function is not used if the cookie doesn't exist. The function can be |
|
|
415 |
passed instead of the options object for backwards compatibility. When |
|
|
416 |
raw is set to true, the cookie value is not URI decoded.</span> |
|
|
417 |
</dd> |
|
|
418 |
</dl> |
|
|
419 |
|
|
|
420 |
<dl> |
|
|
421 |
<dt>Returns: |
|
|
422 |
<code property="yui:return"> |
|
|
423 |
Variant |
|
|
424 |
</code></dt> |
|
|
425 |
<dd property="yui:returnInfo">If no converter is specified, returns a string or null if |
|
|
426 |
the cookie doesn't exist. If the converter is specified, returns the value |
|
|
427 |
returned from the converter or null if the cookie doesn't exist.</dd> |
|
|
428 |
</dl> |
|
|
429 |
|
|
|
430 |
|
|
|
431 |
|
|
|
432 |
|
|
|
433 |
</div> |
|
|
434 |
|
|
|
435 |
</div> |
|
|
436 |
<hr /> |
|
|
437 |
</div> |
|
|
438 |
<div class="" rel="yui:method" resource="#method_getSub"> |
|
|
439 |
<h4> |
|
|
440 |
<a name="method_getSub">getSub</a></h4> |
|
|
441 |
<div class="detail" > |
|
|
442 |
<code> |
|
|
443 |
|
|
|
444 |
static |
|
|
445 |
|
|
|
446 |
Variant |
|
|
447 |
<strong property="yui:name">getSub</strong> |
|
|
448 |
( |
|
|
449 |
|
|
|
450 |
|
|
|
451 |
name |
|
|
452 |
|
|
|
453 |
|
|
|
454 |
, |
|
|
455 |
subName |
|
|
456 |
|
|
|
457 |
|
|
|
458 |
, |
|
|
459 |
converter |
|
|
460 |
|
|
|
461 |
|
|
|
462 |
) |
|
|
463 |
</code> |
|
|
464 |
|
|
|
465 |
<div class="description" property="yui:description"> |
|
|
466 |
Returns the value of a subcookie. |
|
|
467 |
</div> |
|
|
468 |
|
|
|
469 |
<div class="description"> |
|
|
470 |
|
|
|
471 |
<dl rel="yui:parameters"> |
|
|
472 |
<dt>Parameters:</dt> |
|
|
473 |
<dd rel="yui:parameter"> |
|
|
474 |
<code><span property="yui:name">name</span> |
|
|
475 |
<<span property="yui:type">String</span>> |
|
|
476 |
</code> |
|
|
477 |
<span property="yui:description"> The name of the cookie to retrieve.</span> |
|
|
478 |
</dd> |
|
|
479 |
<dd rel="yui:parameter"> |
|
|
480 |
<code><span property="yui:name">subName</span> |
|
|
481 |
<<span property="yui:type">String</span>> |
|
|
482 |
</code> |
|
|
483 |
<span property="yui:description"> The name of the subcookie to retrieve.</span> |
|
|
484 |
</dd> |
|
|
485 |
<dd rel="yui:parameter"> |
|
|
486 |
<code><span property="yui:name">converter</span> |
|
|
487 |
<<span property="yui:type">Function</span>> |
|
|
488 |
</code> |
|
|
489 |
<span property="yui:description"> (Optional) A function to run on the value before returning |
|
|
490 |
it. The function is not used if the cookie doesn't exist.</span> |
|
|
491 |
</dd> |
|
|
492 |
</dl> |
|
|
493 |
|
|
|
494 |
<dl> |
|
|
495 |
<dt>Returns: |
|
|
496 |
<code property="yui:return"> |
|
|
497 |
Variant |
|
|
498 |
</code></dt> |
|
|
499 |
<dd property="yui:returnInfo">If the cookie doesn't exist, null is returned. If the subcookie |
|
|
500 |
doesn't exist, null if also returned. If no converter is specified and the |
|
|
501 |
subcookie exists, a string is returned. If a converter is specified and the |
|
|
502 |
subcookie exists, the value returned from the converter is returned.</dd> |
|
|
503 |
</dl> |
|
|
504 |
|
|
|
505 |
|
|
|
506 |
|
|
|
507 |
|
|
|
508 |
</div> |
|
|
509 |
|
|
|
510 |
</div> |
|
|
511 |
<hr /> |
|
|
512 |
</div> |
|
|
513 |
<div class="" rel="yui:method" resource="#method_getSubs"> |
|
|
514 |
<h4> |
|
|
515 |
<a name="method_getSubs">getSubs</a></h4> |
|
|
516 |
<div class="detail" > |
|
|
517 |
<code> |
|
|
518 |
|
|
|
519 |
static |
|
|
520 |
|
|
|
521 |
Object |
|
|
522 |
<strong property="yui:name">getSubs</strong> |
|
|
523 |
( |
|
|
524 |
|
|
|
525 |
|
|
|
526 |
name |
|
|
527 |
|
|
|
528 |
|
|
|
529 |
) |
|
|
530 |
</code> |
|
|
531 |
|
|
|
532 |
<div class="description" property="yui:description"> |
|
|
533 |
Returns an object containing name-value pairs stored in the cookie with the given name. |
|
|
534 |
</div> |
|
|
535 |
|
|
|
536 |
<div class="description"> |
|
|
537 |
|
|
|
538 |
<dl rel="yui:parameters"> |
|
|
539 |
<dt>Parameters:</dt> |
|
|
540 |
<dd rel="yui:parameter"> |
|
|
541 |
<code><span property="yui:name">name</span> |
|
|
542 |
<<span property="yui:type">String</span>> |
|
|
543 |
</code> |
|
|
544 |
<span property="yui:description"> The name of the cookie to retrieve.</span> |
|
|
545 |
</dd> |
|
|
546 |
</dl> |
|
|
547 |
|
|
|
548 |
<dl> |
|
|
549 |
<dt>Returns: |
|
|
550 |
<code property="yui:return"> |
|
|
551 |
Object |
|
|
552 |
</code></dt> |
|
|
553 |
<dd property="yui:returnInfo">An object of name-value pairs if the cookie with the given name |
|
|
554 |
exists, null if it does not.</dd> |
|
|
555 |
</dl> |
|
|
556 |
|
|
|
557 |
|
|
|
558 |
|
|
|
559 |
|
|
|
560 |
</div> |
|
|
561 |
|
|
|
562 |
</div> |
|
|
563 |
<hr /> |
|
|
564 |
</div> |
|
|
565 |
<div class="" rel="yui:method" resource="#method_remove"> |
|
|
566 |
<h4> |
|
|
567 |
<a name="method_remove">remove</a></h4> |
|
|
568 |
<div class="detail" > |
|
|
569 |
<code> |
|
|
570 |
|
|
|
571 |
static |
|
|
572 |
|
|
|
573 |
String |
|
|
574 |
<strong property="yui:name">remove</strong> |
|
|
575 |
( |
|
|
576 |
|
|
|
577 |
|
|
|
578 |
name |
|
|
579 |
|
|
|
580 |
|
|
|
581 |
, |
|
|
582 |
options |
|
|
583 |
|
|
|
584 |
|
|
|
585 |
) |
|
|
586 |
</code> |
|
|
587 |
|
|
|
588 |
<div class="description" property="yui:description"> |
|
|
589 |
Removes a cookie from the machine by setting its expiration date to |
|
|
590 |
sometime in the past. |
|
|
591 |
</div> |
|
|
592 |
|
|
|
593 |
<div class="description"> |
|
|
594 |
|
|
|
595 |
<dl rel="yui:parameters"> |
|
|
596 |
<dt>Parameters:</dt> |
|
|
597 |
<dd rel="yui:parameter"> |
|
|
598 |
<code><span property="yui:name">name</span> |
|
|
599 |
<<span property="yui:type">String</span>> |
|
|
600 |
</code> |
|
|
601 |
<span property="yui:description"> The name of the cookie to remove.</span> |
|
|
602 |
</dd> |
|
|
603 |
<dd rel="yui:parameter"> |
|
|
604 |
<code><span property="yui:name">options</span> |
|
|
605 |
<<span property="yui:type">Object</span>> |
|
|
606 |
</code> |
|
|
607 |
<span property="yui:description"> (Optional) An object containing one or more |
|
|
608 |
cookie options: path (a string), domain (a string), |
|
|
609 |
and secure (true/false). The expires option will be overwritten |
|
|
610 |
by the method.</span> |
|
|
611 |
</dd> |
|
|
612 |
</dl> |
|
|
613 |
|
|
|
614 |
<dl> |
|
|
615 |
<dt>Returns: |
|
|
616 |
<code property="yui:return"> |
|
|
617 |
String |
|
|
618 |
</code></dt> |
|
|
619 |
<dd property="yui:returnInfo">The created cookie string.</dd> |
|
|
620 |
</dl> |
|
|
621 |
|
|
|
622 |
|
|
|
623 |
|
|
|
624 |
|
|
|
625 |
</div> |
|
|
626 |
|
|
|
627 |
</div> |
|
|
628 |
<hr /> |
|
|
629 |
</div> |
|
|
630 |
<div class="" rel="yui:method" resource="#method_removeSub"> |
|
|
631 |
<h4> |
|
|
632 |
<a name="method_removeSub">removeSub</a></h4> |
|
|
633 |
<div class="detail" > |
|
|
634 |
<code> |
|
|
635 |
|
|
|
636 |
static |
|
|
637 |
|
|
|
638 |
String |
|
|
639 |
<strong property="yui:name">removeSub</strong> |
|
|
640 |
( |
|
|
641 |
|
|
|
642 |
|
|
|
643 |
name |
|
|
644 |
|
|
|
645 |
|
|
|
646 |
, |
|
|
647 |
subName |
|
|
648 |
|
|
|
649 |
|
|
|
650 |
, |
|
|
651 |
options |
|
|
652 |
|
|
|
653 |
|
|
|
654 |
) |
|
|
655 |
</code> |
|
|
656 |
|
|
|
657 |
<div class="description" property="yui:description"> |
|
|
658 |
Removes a sub cookie with a given name. |
|
|
659 |
</div> |
|
|
660 |
|
|
|
661 |
<div class="description"> |
|
|
662 |
|
|
|
663 |
<dl rel="yui:parameters"> |
|
|
664 |
<dt>Parameters:</dt> |
|
|
665 |
<dd rel="yui:parameter"> |
|
|
666 |
<code><span property="yui:name">name</span> |
|
|
667 |
<<span property="yui:type">String</span>> |
|
|
668 |
</code> |
|
|
669 |
<span property="yui:description"> The name of the cookie in which the subcookie exists.</span> |
|
|
670 |
</dd> |
|
|
671 |
<dd rel="yui:parameter"> |
|
|
672 |
<code><span property="yui:name">subName</span> |
|
|
673 |
<<span property="yui:type">String</span>> |
|
|
674 |
</code> |
|
|
675 |
<span property="yui:description"> The name of the subcookie to remove.</span> |
|
|
676 |
</dd> |
|
|
677 |
<dd rel="yui:parameter"> |
|
|
678 |
<code><span property="yui:name">options</span> |
|
|
679 |
<<span property="yui:type">Object</span>> |
|
|
680 |
</code> |
|
|
681 |
<span property="yui:description"> (Optional) An object containing one or more |
|
|
682 |
cookie options: path (a string), domain (a string), expires (a Date object), |
|
|
683 |
removeIfEmpty (true/false), and secure (true/false). This must be the same |
|
|
684 |
settings as the original subcookie.</span> |
|
|
685 |
</dd> |
|
|
686 |
</dl> |
|
|
687 |
|
|
|
688 |
<dl> |
|
|
689 |
<dt>Returns: |
|
|
690 |
<code property="yui:return"> |
|
|
691 |
String |
|
|
692 |
</code></dt> |
|
|
693 |
<dd property="yui:returnInfo">The created cookie string.</dd> |
|
|
694 |
</dl> |
|
|
695 |
|
|
|
696 |
|
|
|
697 |
|
|
|
698 |
|
|
|
699 |
</div> |
|
|
700 |
|
|
|
701 |
</div> |
|
|
702 |
<hr /> |
|
|
703 |
</div> |
|
|
704 |
<div class="" rel="yui:method" resource="#method_set"> |
|
|
705 |
<h4> |
|
|
706 |
<a name="method_set">set</a></h4> |
|
|
707 |
<div class="detail" > |
|
|
708 |
<code> |
|
|
709 |
|
|
|
710 |
static |
|
|
711 |
|
|
|
712 |
String |
|
|
713 |
<strong property="yui:name">set</strong> |
|
|
714 |
( |
|
|
715 |
|
|
|
716 |
|
|
|
717 |
name |
|
|
718 |
|
|
|
719 |
|
|
|
720 |
, |
|
|
721 |
value |
|
|
722 |
|
|
|
723 |
|
|
|
724 |
, |
|
|
725 |
options |
|
|
726 |
|
|
|
727 |
|
|
|
728 |
) |
|
|
729 |
</code> |
|
|
730 |
|
|
|
731 |
<div class="description" property="yui:description"> |
|
|
732 |
Sets a cookie with a given name and value. |
|
|
733 |
</div> |
|
|
734 |
|
|
|
735 |
<div class="description"> |
|
|
736 |
|
|
|
737 |
<dl rel="yui:parameters"> |
|
|
738 |
<dt>Parameters:</dt> |
|
|
739 |
<dd rel="yui:parameter"> |
|
|
740 |
<code><span property="yui:name">name</span> |
|
|
741 |
<<span property="yui:type">String</span>> |
|
|
742 |
</code> |
|
|
743 |
<span property="yui:description"> The name of the cookie to set.</span> |
|
|
744 |
</dd> |
|
|
745 |
<dd rel="yui:parameter"> |
|
|
746 |
<code><span property="yui:name">value</span> |
|
|
747 |
<<span property="yui:type">Variant</span>> |
|
|
748 |
</code> |
|
|
749 |
<span property="yui:description"> The value to set for the cookie.</span> |
|
|
750 |
</dd> |
|
|
751 |
<dd rel="yui:parameter"> |
|
|
752 |
<code><span property="yui:name">options</span> |
|
|
753 |
<<span property="yui:type">Object</span>> |
|
|
754 |
</code> |
|
|
755 |
<span property="yui:description"> (Optional) An object containing one or more |
|
|
756 |
cookie options: path (a string), domain (a string), expires (a Date object), |
|
|
757 |
secure (true/false), and raw (true/false). Setting raw to true indicates |
|
|
758 |
that the cookie should not be URI encoded before being set.</span> |
|
|
759 |
</dd> |
|
|
760 |
</dl> |
|
|
761 |
|
|
|
762 |
<dl> |
|
|
763 |
<dt>Returns: |
|
|
764 |
<code property="yui:return"> |
|
|
765 |
String |
|
|
766 |
</code></dt> |
|
|
767 |
<dd property="yui:returnInfo">The created cookie string.</dd> |
|
|
768 |
</dl> |
|
|
769 |
|
|
|
770 |
|
|
|
771 |
|
|
|
772 |
|
|
|
773 |
</div> |
|
|
774 |
|
|
|
775 |
</div> |
|
|
776 |
<hr /> |
|
|
777 |
</div> |
|
|
778 |
<div class="" rel="yui:method" resource="#method_setSub"> |
|
|
779 |
<h4> |
|
|
780 |
<a name="method_setSub">setSub</a></h4> |
|
|
781 |
<div class="detail" > |
|
|
782 |
<code> |
|
|
783 |
|
|
|
784 |
static |
|
|
785 |
|
|
|
786 |
String |
|
|
787 |
<strong property="yui:name">setSub</strong> |
|
|
788 |
( |
|
|
789 |
|
|
|
790 |
|
|
|
791 |
name |
|
|
792 |
|
|
|
793 |
|
|
|
794 |
, |
|
|
795 |
subName |
|
|
796 |
|
|
|
797 |
|
|
|
798 |
, |
|
|
799 |
value |
|
|
800 |
|
|
|
801 |
|
|
|
802 |
, |
|
|
803 |
options |
|
|
804 |
|
|
|
805 |
|
|
|
806 |
) |
|
|
807 |
</code> |
|
|
808 |
|
|
|
809 |
<div class="description" property="yui:description"> |
|
|
810 |
Sets a sub cookie with a given name to a particular value. |
|
|
811 |
</div> |
|
|
812 |
|
|
|
813 |
<div class="description"> |
|
|
814 |
|
|
|
815 |
<dl rel="yui:parameters"> |
|
|
816 |
<dt>Parameters:</dt> |
|
|
817 |
<dd rel="yui:parameter"> |
|
|
818 |
<code><span property="yui:name">name</span> |
|
|
819 |
<<span property="yui:type">String</span>> |
|
|
820 |
</code> |
|
|
821 |
<span property="yui:description"> The name of the cookie to set.</span> |
|
|
822 |
</dd> |
|
|
823 |
<dd rel="yui:parameter"> |
|
|
824 |
<code><span property="yui:name">subName</span> |
|
|
825 |
<<span property="yui:type">String</span>> |
|
|
826 |
</code> |
|
|
827 |
<span property="yui:description"> The name of the subcookie to set.</span> |
|
|
828 |
</dd> |
|
|
829 |
<dd rel="yui:parameter"> |
|
|
830 |
<code><span property="yui:name">value</span> |
|
|
831 |
<<span property="yui:type">Variant</span>> |
|
|
832 |
</code> |
|
|
833 |
<span property="yui:description"> The value to set.</span> |
|
|
834 |
</dd> |
|
|
835 |
<dd rel="yui:parameter"> |
|
|
836 |
<code><span property="yui:name">options</span> |
|
|
837 |
<<span property="yui:type">Object</span>> |
|
|
838 |
</code> |
|
|
839 |
<span property="yui:description"> (Optional) An object containing one or more |
|
|
840 |
cookie options: path (a string), domain (a string), expires (a Date object), |
|
|
841 |
and secure (true/false).</span> |
|
|
842 |
</dd> |
|
|
843 |
</dl> |
|
|
844 |
|
|
|
845 |
<dl> |
|
|
846 |
<dt>Returns: |
|
|
847 |
<code property="yui:return"> |
|
|
848 |
String |
|
|
849 |
</code></dt> |
|
|
850 |
<dd property="yui:returnInfo">The created cookie string.</dd> |
|
|
851 |
</dl> |
|
|
852 |
|
|
|
853 |
|
|
|
854 |
|
|
|
855 |
|
|
|
856 |
</div> |
|
|
857 |
|
|
|
858 |
</div> |
|
|
859 |
<hr /> |
|
|
860 |
</div> |
|
|
861 |
<div class="" rel="yui:method" resource="#method_setSubs"> |
|
|
862 |
<h4> |
|
|
863 |
<a name="method_setSubs">setSubs</a></h4> |
|
|
864 |
<div class="detail" > |
|
|
865 |
<code> |
|
|
866 |
|
|
|
867 |
static |
|
|
868 |
|
|
|
869 |
String |
|
|
870 |
<strong property="yui:name">setSubs</strong> |
|
|
871 |
( |
|
|
872 |
|
|
|
873 |
|
|
|
874 |
name |
|
|
875 |
|
|
|
876 |
|
|
|
877 |
, |
|
|
878 |
value |
|
|
879 |
|
|
|
880 |
|
|
|
881 |
, |
|
|
882 |
options |
|
|
883 |
|
|
|
884 |
|
|
|
885 |
) |
|
|
886 |
</code> |
|
|
887 |
|
|
|
888 |
<div class="description" property="yui:description"> |
|
|
889 |
Sets a cookie with a given name to contain a hash of name-value pairs. |
|
|
890 |
</div> |
|
|
891 |
|
|
|
892 |
<div class="description"> |
|
|
893 |
|
|
|
894 |
<dl rel="yui:parameters"> |
|
|
895 |
<dt>Parameters:</dt> |
|
|
896 |
<dd rel="yui:parameter"> |
|
|
897 |
<code><span property="yui:name">name</span> |
|
|
898 |
<<span property="yui:type">String</span>> |
|
|
899 |
</code> |
|
|
900 |
<span property="yui:description"> The name of the cookie to set.</span> |
|
|
901 |
</dd> |
|
|
902 |
<dd rel="yui:parameter"> |
|
|
903 |
<code><span property="yui:name">value</span> |
|
|
904 |
<<span property="yui:type">Object</span>> |
|
|
905 |
</code> |
|
|
906 |
<span property="yui:description"> An object containing name-value pairs.</span> |
|
|
907 |
</dd> |
|
|
908 |
<dd rel="yui:parameter"> |
|
|
909 |
<code><span property="yui:name">options</span> |
|
|
910 |
<<span property="yui:type">Object</span>> |
|
|
911 |
</code> |
|
|
912 |
<span property="yui:description"> (Optional) An object containing one or more |
|
|
913 |
cookie options: path (a string), domain (a string), expires (a Date object), |
|
|
914 |
and secure (true/false).</span> |
|
|
915 |
</dd> |
|
|
916 |
</dl> |
|
|
917 |
|
|
|
918 |
<dl> |
|
|
919 |
<dt>Returns: |
|
|
920 |
<code property="yui:return"> |
|
|
921 |
String |
|
|
922 |
</code></dt> |
|
|
923 |
<dd property="yui:returnInfo">The created cookie string.</dd> |
|
|
924 |
</dl> |
|
|
925 |
|
|
|
926 |
|
|
|
927 |
|
|
|
928 |
|
|
|
929 |
</div> |
|
|
930 |
|
|
|
931 |
</div> |
|
|
932 |
<hr /> |
|
|
933 |
</div> |
|
|
934 |
</div> |
|
|
935 |
</div> |
|
|
936 |
|
|
|
937 |
</div> |
|
|
938 |
|
|
|
939 |
<div rel="yui:events" resource="#events"> |
|
|
940 |
|
|
|
941 |
|
|
|
942 |
</div> |
|
|
943 |
|
|
|
944 |
<div rel="yui:attributes" resource="#configattributes"> |
|
|
945 |
|
|
|
946 |
</div> |
|
|
947 |
|
|
|
948 |
</div> |
|
|
949 |
</div> |
|
|
950 |
<div class="yui-b"> |
|
|
951 |
<div class="nav"> |
|
|
952 |
|
|
|
953 |
<div id="moduleList" class="module"> |
|
|
954 |
<h4>Modules</h4> |
|
|
955 |
<ul class="content"> |
|
|
956 |
<li class=""><a href="module_anim.html" title="anim">anim</a></li> |
|
|
957 |
<li class=""><a href="module_async-queue.html" title="async-queue">async-queue</a></li> |
|
|
958 |
<li class=""><a href="module_attribute.html" title="attribute">attribute</a></li> |
|
|
959 |
<li class=""><a href="module_base.html" title="base">base</a></li> |
|
|
960 |
<li class=""><a href="module_cache.html" title="cache">cache</a></li> |
|
|
961 |
<li class=""><a href="module_classnamemanager.html" title="classnamemanager">classnamemanager</a></li> |
|
|
962 |
<li class=""><a href="module_collection.html" title="collection">collection</a></li> |
|
|
963 |
<li class=""><a href="module_console.html" title="console">console</a></li> |
|
|
964 |
<li class=""><a href="module_console-filters.html" title="console-filters">console-filters</a></li> |
|
|
965 |
<li class="selected"><a href="module_cookie.html" title="cookie">cookie</a></li> |
|
|
966 |
<li class=""><a href="module_dataschema.html" title="dataschema">dataschema</a></li> |
|
|
967 |
<li class=""><a href="module_datasource.html" title="datasource">datasource</a></li> |
|
|
968 |
<li class=""><a href="module_datatype.html" title="datatype">datatype</a></li> |
|
|
969 |
<li class=""><a href="module_dd.html" title="dd">dd</a></li> |
|
|
970 |
<li class=""><a href="module_dom.html" title="dom">dom</a></li> |
|
|
971 |
<li class=""><a href="module_dump.html" title="dump">dump</a></li> |
|
|
972 |
<li class=""><a href="module_event.html" title="event">event</a></li> |
|
|
973 |
<li class=""><a href="module_event-custom.html" title="event-custom">event-custom</a></li> |
|
|
974 |
<li class=""><a href="module_event-simulate.html" title="event-simulate">event-simulate</a></li> |
|
|
975 |
<li class=""><a href="module_history.html" title="history">history</a></li> |
|
|
976 |
<li class=""><a href="module_imageloader.html" title="imageloader">imageloader</a></li> |
|
|
977 |
<li class=""><a href="module_io.html" title="io">io</a></li> |
|
|
978 |
<li class=""><a href="module_json.html" title="json">json</a></li> |
|
|
979 |
<li class=""><a href="module_node.html" title="node">node</a></li> |
|
|
980 |
<li class=""><a href="module_node-focusmanager.html" title="node-focusmanager">node-focusmanager</a></li> |
|
|
981 |
<li class=""><a href="module_node-menunav.html" title="node-menunav">node-menunav</a></li> |
|
|
982 |
<li class=""><a href="module_oop.html" title="oop">oop</a></li> |
|
|
983 |
<li class=""><a href="module_overlay.html" title="overlay">overlay</a></li> |
|
|
984 |
<li class=""><a href="module_plugin.html" title="plugin">plugin</a></li> |
|
|
985 |
<li class=""><a href="module_profiler.html" title="profiler">profiler</a></li> |
|
|
986 |
<li class=""><a href="module_queue-promote.html" title="queue-promote">queue-promote</a></li> |
|
|
987 |
<li class=""><a href="module_slider.html" title="slider">slider</a></li> |
|
|
988 |
<li class=""><a href="module_stylesheet.html" title="stylesheet">stylesheet</a></li> |
|
|
989 |
<li class=""><a href="module_substitute.html" title="substitute">substitute</a></li> |
|
|
990 |
<li class=""><a href="module_test.html" title="test">test</a></li> |
|
|
991 |
<li class=""><a href="module_widget.html" title="widget">widget</a></li> |
|
|
992 |
<li class=""><a href="module_widget-position.html" title="widget-position">widget-position</a></li> |
|
|
993 |
<li class=""><a href="module_widget-position-ext.html" title="widget-position-ext">widget-position-ext</a></li> |
|
|
994 |
<li class=""><a href="module_widget-stack.html" title="widget-stack">widget-stack</a></li> |
|
|
995 |
<li class=""><a href="module_widget-stdmod.html" title="widget-stdmod">widget-stdmod</a></li> |
|
|
996 |
<li class=""><a href="module_yui.html" title="yui">yui</a></li> |
|
|
997 |
</ul> |
|
|
998 |
</div> |
|
|
999 |
|
|
|
1000 |
<div id="classList" class="module"> |
|
|
1001 |
<h4>Classes</h4> |
|
|
1002 |
<ul class="content"> |
|
|
1003 |
<li class="selected"><a href="Cookie.html" title="Cookie">Cookie</a></li> |
|
|
1004 |
</ul> |
|
|
1005 |
</div> |
|
|
1006 |
|
|
|
1007 |
<div id="fileList" class="module"> |
|
|
1008 |
<h4>Files</h4> |
|
|
1009 |
<ul class="content"> |
|
|
1010 |
<li class=""><a href="Cookie.js.html" title="Cookie.js">Cookie.js</a></li> |
|
|
1011 |
</ul> |
|
|
1012 |
</div> |
|
|
1013 |
|
|
|
1014 |
|
|
|
1015 |
<div id="methodsList" class="module"> |
|
|
1016 |
<h4>Methods</h4> |
|
|
1017 |
<ul class="content"> |
|
|
1018 |
<li class="private"><a href="#method__createCookieHashString" title="_createCookieHashString">_createCookieHashString</a></li> |
|
|
1019 |
<li class="private"><a href="#method__createCookieString" title="_createCookieString">_createCookieString</a></li> |
|
|
1020 |
<li class="private"><a href="#method__parseCookieHash" title="_parseCookieHash">_parseCookieHash</a></li> |
|
|
1021 |
<li class="private"><a href="#method__parseCookieString" title="_parseCookieString">_parseCookieString</a></li> |
|
|
1022 |
<li class=""><a href="#method_exists" title="exists">exists</a></li> |
|
|
1023 |
<li class=""><a href="#method_get" title="get">get</a></li> |
|
|
1024 |
<li class=""><a href="#method_getSub" title="getSub">getSub</a></li> |
|
|
1025 |
<li class=""><a href="#method_getSubs" title="getSubs">getSubs</a></li> |
|
|
1026 |
<li class=""><a href="#method_remove" title="remove">remove</a></li> |
|
|
1027 |
<li class=""><a href="#method_removeSub" title="removeSub">removeSub</a></li> |
|
|
1028 |
<li class=""><a href="#method_set" title="set">set</a></li> |
|
|
1029 |
<li class=""><a href="#method_setSub" title="setSub">setSub</a></li> |
|
|
1030 |
<li class=""><a href="#method_setSubs" title="setSubs">setSubs</a></li> |
|
|
1031 |
</ul> |
|
|
1032 |
</div> |
|
|
1033 |
|
|
|
1034 |
|
|
|
1035 |
|
|
|
1036 |
</div> |
|
|
1037 |
</div> |
|
|
1038 |
</div> |
|
|
1039 |
<div id="ft"> |
|
|
1040 |
<hr /> |
|
|
1041 |
Copyright © 2009 Yahoo! Inc. All rights reserved. |
|
|
1042 |
</div> |
|
|
1043 |
</div> |
|
|
1044 |
<script type="text/javascript"> |
|
|
1045 |
ALL_YUI_PROPS = [{"access": "private", "host": "Cookie", "name": "_createCookieHashString", "url": "Cookie.html#method__createCookieHashString", "type": "method"}, {"access": "private", "host": "Cookie", "name": "_createCookieString", "url": "Cookie.html#method__createCookieString", "type": "method"}, {"access": "", "host": "Cookie", "name": "exists", "url": "Cookie.html#method_exists", "type": "method"}, {"access": "", "host": "Cookie", "name": "get", "url": "Cookie.html#method_get", "type": "method"}, {"access": "", "host": "Cookie", "name": "getSub", "url": "Cookie.html#method_getSub", "type": "method"}, {"access": "", "host": "Cookie", "name": "getSubs", "url": "Cookie.html#method_getSubs", "type": "method"}, {"access": "private", "host": "Cookie", "name": "_parseCookieHash", "url": "Cookie.html#method__parseCookieHash", "type": "method"}, {"access": "private", "host": "Cookie", "name": "_parseCookieString", "url": "Cookie.html#method__parseCookieString", "type": "method"}, {"access": "", "host": "Cookie", "name": "remove", "url": "Cookie.html#method_remove", "type": "method"}, {"access": "", "host": "Cookie", "name": "removeSub", "url": "Cookie.html#method_removeSub", "type": "method"}, {"access": "", "host": "Cookie", "name": "set", "url": "Cookie.html#method_set", "type": "method"}, {"access": "", "host": "Cookie", "name": "setSub", "url": "Cookie.html#method_setSub", "type": "method"}, {"access": "", "host": "Cookie", "name": "setSubs", "url": "Cookie.html#method_setSubs", "type": "method"}]; |
|
|
1046 |
</script> |
|
|
1047 |
</body> |
|
|
1048 |
</html> |