|
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.js (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 |
|
23 > Cookie.js (source view) |
|
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 <div id="srcout"> |
|
47 <style> |
|
48 #doc3 .classopts { display:none; } |
|
49 </style> |
|
50 <div class="highlight" ><pre><span class="c">/**</span> |
|
51 <span class="c"> * Utilities for cookie management</span> |
|
52 <span class="c"> * @module cookie</span> |
|
53 <span class="c"> */</span> |
|
54 |
|
55 <span class="c">//shortcuts</span> |
|
56 <span class="c"></span> <span class="k">var</span> <span class="nx">L</span> <span class="o">=</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">Lang</span><span class="o">,</span> |
|
57 <span class="nx">O</span> <span class="o">=</span> <span class="nx">Y</span><span class="o">.</span><span class="nb">Object</span><span class="o">,</span> |
|
58 <span class="nx">NULL</span> <span class="o">=</span> <span class="kc">null</span><span class="o">,</span> |
|
59 |
|
60 <span class="c">//shortcuts to functions</span> |
|
61 <span class="c"></span> <span class="nx">isString</span> <span class="o">=</span> <span class="nx">L</span><span class="o">.</span><span class="nx">isString</span><span class="o">,</span> |
|
62 <span class="nx">isObject</span> <span class="o">=</span> <span class="nx">L</span><span class="o">.</span><span class="nx">isObject</span><span class="o">,</span> |
|
63 <span class="nx">isUndefined</span> <span class="o">=</span> <span class="nx">L</span><span class="o">.</span><span class="nx">isUndefined</span><span class="o">,</span> |
|
64 <span class="nx">isFunction</span> <span class="o">=</span> <span class="nx">L</span><span class="o">.</span><span class="nx">isFunction</span><span class="o">,</span> |
|
65 <span class="nx">encode</span> <span class="o">=</span> <span class="nb">encodeURIComponent</span><span class="o">,</span> |
|
66 <span class="nx">decode</span> <span class="o">=</span> <span class="nb">decodeURIComponent</span><span class="o">,</span> |
|
67 |
|
68 <span class="c">//shortcut to document</span> |
|
69 <span class="c"></span> <span class="nx">doc</span> <span class="o">=</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">config</span><span class="o">.</span><span class="nx">doc</span><span class="o">;</span> |
|
70 |
|
71 <span class="c">/*</span> |
|
72 <span class="c"> * Throws an error message.</span> |
|
73 <span class="c"> */</span> |
|
74 <span class="k">function</span> <span class="nx">error</span><span class="o">(</span><span class="nx">message</span><span class="o">){</span> |
|
75 <span class="k">throw</span> <span class="k">new</span> <span class="nx">TypeError</span><span class="o">(</span><span class="nx">message</span><span class="o">);</span> |
|
76 <span class="o">}</span> |
|
77 |
|
78 <span class="c">/*</span> |
|
79 <span class="c"> * Checks the validity of a cookie name.</span> |
|
80 <span class="c"> */</span> |
|
81 <span class="k">function</span> <span class="nx">validateCookieName</span><span class="o">(</span><span class="nx">name</span><span class="o">){</span> |
|
82 <span class="k">if</span> <span class="o">(!</span><span class="nx">isString</span><span class="o">(</span><span class="nx">name</span><span class="o">)</span> <span class="o">||</span> <span class="nx">name</span> <span class="o">===</span> <span class="s2">""</span><span class="o">){</span> |
|
83 <span class="nx">error</span><span class="o">(</span><span class="s2">"Cookie name must be a non-empty string."</span><span class="o">);</span> |
|
84 <span class="o">}</span> |
|
85 <span class="o">}</span> |
|
86 |
|
87 <span class="c">/*</span> |
|
88 <span class="c"> * Checks the validity of a subcookie name.</span> |
|
89 <span class="c"> */</span> |
|
90 <span class="k">function</span> <span class="nx">validateSubcookieName</span><span class="o">(</span><span class="nx">subName</span><span class="o">){</span> |
|
91 <span class="k">if</span> <span class="o">(!</span><span class="nx">isString</span><span class="o">(</span><span class="nx">subName</span><span class="o">)</span> <span class="o">||</span> <span class="nx">subName</span> <span class="o">===</span> <span class="s2">""</span><span class="o">){</span> |
|
92 <span class="nx">error</span><span class="o">(</span><span class="s2">"Subcookie name must be a non-empty string."</span><span class="o">);</span> |
|
93 <span class="o">}</span> |
|
94 <span class="o">}</span> |
|
95 |
|
96 <span class="c">/**</span> |
|
97 <span class="c"> * Cookie utility.</span> |
|
98 <span class="c"> * @class Cookie</span> |
|
99 <span class="c"> * @static</span> |
|
100 <span class="c"> */</span> |
|
101 <span class="nx">Y</span><span class="o">.</span><span class="nx">Cookie</span> <span class="o">=</span> <span class="o">{</span> |
|
102 |
|
103 <span class="c">//-------------------------------------------------------------------------</span> |
|
104 <span class="c"></span> <span class="c">// Private Methods</span> |
|
105 <span class="c"></span> <span class="c">//-------------------------------------------------------------------------</span> |
|
106 <span class="c"></span> |
|
107 <span class="c">/**</span> |
|
108 <span class="c"> * Creates a cookie string that can be assigned into document.cookie.</span> |
|
109 <span class="c"> * @param {String} name The name of the cookie.</span> |
|
110 <span class="c"> * @param {String} value The value of the cookie.</span> |
|
111 <span class="c"> * @param {Boolean} encodeValue True to encode the value, false to leave as-is.</span> |
|
112 <span class="c"> * @param {Object} options (Optional) Options for the cookie.</span> |
|
113 <span class="c"> * @return {String} The formatted cookie string.</span> |
|
114 <span class="c"> * @method _createCookieString</span> |
|
115 <span class="c"> * @private</span> |
|
116 <span class="c"> * @static</span> |
|
117 <span class="c"> */</span> |
|
118 <span class="nx">_createCookieString</span> <span class="o">:</span> <span class="k">function</span> <span class="o">(</span><span class="nx">name</span> <span class="c">/*:String*/</span><span class="o">,</span> <span class="nx">value</span> <span class="c">/*:Variant*/</span><span class="o">,</span> <span class="nx">encodeValue</span> <span class="c">/*:Boolean*/</span><span class="o">,</span> <span class="nx">options</span> <span class="c">/*:Object*/</span><span class="o">)</span> <span class="c">/*:String*/</span> <span class="o">{</span> |
|
119 |
|
120 <span class="nx">options</span> <span class="o">=</span> <span class="nx">options</span> <span class="o">||</span> <span class="o">{};</span> |
|
121 |
|
122 <span class="k">var</span> <span class="nx">text</span> <span class="c">/*:String*/</span> <span class="o">=</span> <span class="nx">encode</span><span class="o">(</span><span class="nx">name</span><span class="o">)</span> <span class="o">+</span> <span class="s2">"="</span> <span class="o">+</span> <span class="o">(</span><span class="nx">encodeValue</span> <span class="o">?</span> <span class="nx">encode</span><span class="o">(</span><span class="nx">value</span><span class="o">)</span> <span class="o">:</span> <span class="nx">value</span><span class="o">),</span> |
|
123 <span class="nx">expires</span> <span class="o">=</span> <span class="nx">options</span><span class="o">.</span><span class="nx">expires</span><span class="o">,</span> |
|
124 <span class="nx">path</span> <span class="o">=</span> <span class="nx">options</span><span class="o">.</span><span class="nx">path</span><span class="o">,</span> |
|
125 <span class="nx">domain</span> <span class="o">=</span> <span class="nx">options</span><span class="o">.</span><span class="nx">domain</span><span class="o">;</span> |
|
126 |
|
127 |
|
128 <span class="k">if</span> <span class="o">(</span><span class="nx">isObject</span><span class="o">(</span><span class="nx">options</span><span class="o">)){</span> |
|
129 <span class="c">//expiration date</span> |
|
130 <span class="c"></span> <span class="k">if</span> <span class="o">(</span><span class="nx">expires</span> <span class="k">instanceof</span> <span class="nb">Date</span><span class="o">){</span> |
|
131 <span class="nx">text</span> <span class="o">+=</span> <span class="s2">"; expires="</span> <span class="o">+</span> <span class="nx">expires</span><span class="o">.</span><span class="nx">toUTCString</span><span class="o">();</span> |
|
132 <span class="o">}</span> |
|
133 |
|
134 <span class="c">//path</span> |
|
135 <span class="c"></span> <span class="k">if</span> <span class="o">(</span><span class="nx">isString</span><span class="o">(</span><span class="nx">path</span><span class="o">)</span> <span class="o">&&</span> <span class="nx">path</span> <span class="o">!==</span> <span class="s2">""</span><span class="o">){</span> |
|
136 <span class="nx">text</span> <span class="o">+=</span> <span class="s2">"; path="</span> <span class="o">+</span> <span class="nx">path</span><span class="o">;</span> |
|
137 <span class="o">}</span> |
|
138 |
|
139 <span class="c">//domain</span> |
|
140 <span class="c"></span> <span class="k">if</span> <span class="o">(</span><span class="nx">isString</span><span class="o">(</span><span class="nx">domain</span><span class="o">)</span> <span class="o">&&</span> <span class="nx">domain</span> <span class="o">!==</span> <span class="s2">""</span><span class="o">){</span> |
|
141 <span class="nx">text</span> <span class="o">+=</span> <span class="s2">"; domain="</span> <span class="o">+</span> <span class="nx">domain</span><span class="o">;</span> |
|
142 <span class="o">}</span> |
|
143 |
|
144 <span class="c">//secure</span> |
|
145 <span class="c"></span> <span class="k">if</span> <span class="o">(</span><span class="nx">options</span><span class="o">.</span><span class="nx">secure</span> <span class="o">===</span> <span class="kc">true</span><span class="o">){</span> |
|
146 <span class="nx">text</span> <span class="o">+=</span> <span class="s2">"; secure"</span><span class="o">;</span> |
|
147 <span class="o">}</span> |
|
148 <span class="o">}</span> |
|
149 |
|
150 <span class="k">return</span> <span class="nx">text</span><span class="o">;</span> |
|
151 <span class="o">},</span> |
|
152 |
|
153 <span class="c">/**</span> |
|
154 <span class="c"> * Formats a cookie value for an object containing multiple values.</span> |
|
155 <span class="c"> * @param {Object} hash An object of key-value pairs to create a string for.</span> |
|
156 <span class="c"> * @return {String} A string suitable for use as a cookie value.</span> |
|
157 <span class="c"> * @method _createCookieHashString</span> |
|
158 <span class="c"> * @private</span> |
|
159 <span class="c"> * @static</span> |
|
160 <span class="c"> */</span> |
|
161 <span class="nx">_createCookieHashString</span> <span class="o">:</span> <span class="k">function</span> <span class="o">(</span><span class="nx">hash</span> <span class="c">/*:Object*/</span><span class="o">)</span> <span class="c">/*:String*/</span> <span class="o">{</span> |
|
162 <span class="k">if</span> <span class="o">(!</span><span class="nx">isObject</span><span class="o">(</span><span class="nx">hash</span><span class="o">)){</span> |
|
163 <span class="nx">error</span><span class="o">(</span><span class="s2">"Cookie._createCookieHashString(): Argument must be an object."</span><span class="o">);</span> |
|
164 <span class="o">}</span> |
|
165 |
|
166 <span class="k">var</span> <span class="nx">text</span> <span class="c">/*:Array*/</span> <span class="o">=</span> <span class="o">[];</span> |
|
167 |
|
168 <span class="nx">O</span><span class="o">.</span><span class="nx">each</span><span class="o">(</span><span class="nx">hash</span><span class="o">,</span> <span class="k">function</span><span class="o">(</span><span class="nx">value</span><span class="o">,</span> <span class="nx">key</span><span class="o">){</span> |
|
169 <span class="k">if</span> <span class="o">(!</span><span class="nx">isFunction</span><span class="o">(</span><span class="nx">value</span><span class="o">)</span> <span class="o">&&</span> <span class="o">!</span><span class="nx">isUndefined</span><span class="o">(</span><span class="nx">value</span><span class="o">)){</span> |
|
170 <span class="nx">text</span><span class="o">.</span><span class="nx">push</span><span class="o">(</span><span class="nx">encode</span><span class="o">(</span><span class="nx">key</span><span class="o">)</span> <span class="o">+</span> <span class="s2">"="</span> <span class="o">+</span> <span class="nx">encode</span><span class="o">(</span><span class="nb">String</span><span class="o">(</span><span class="nx">value</span><span class="o">)));</span> |
|
171 <span class="o">}</span> |
|
172 <span class="o">});</span> |
|
173 |
|
174 <span class="k">return</span> <span class="nx">text</span><span class="o">.</span><span class="nx">join</span><span class="o">(</span><span class="s2">"&"</span><span class="o">);</span> |
|
175 <span class="o">},</span> |
|
176 |
|
177 <span class="c">/**</span> |
|
178 <span class="c"> * Parses a cookie hash string into an object.</span> |
|
179 <span class="c"> * @param {String} text The cookie hash string to parse (format: n1=v1&n2=v2).</span> |
|
180 <span class="c"> * @return {Object} An object containing entries for each cookie value.</span> |
|
181 <span class="c"> * @method _parseCookieHash</span> |
|
182 <span class="c"> * @private</span> |
|
183 <span class="c"> * @static</span> |
|
184 <span class="c"> */</span> |
|
185 <span class="nx">_parseCookieHash</span> <span class="o">:</span> <span class="k">function</span> <span class="o">(</span><span class="nx">text</span><span class="o">)</span> <span class="o">{</span> |
|
186 |
|
187 <span class="k">var</span> <span class="nx">hashParts</span> <span class="o">=</span> <span class="nx">text</span><span class="o">.</span><span class="nx">split</span><span class="o">(</span><span class="s2">"&"</span><span class="o">),</span> |
|
188 <span class="nx">hashPart</span> <span class="o">=</span> <span class="nx">NULL</span><span class="o">,</span> |
|
189 <span class="nx">hash</span> <span class="o">=</span> <span class="o">{};</span> |
|
190 |
|
191 <span class="k">if</span> <span class="o">(</span><span class="nx">text</span><span class="o">.</span><span class="nx">length</span><span class="o">){</span> |
|
192 <span class="k">for</span> <span class="o">(</span><span class="k">var</span> <span class="nx">i</span><span class="o">=</span><span class="m">0</span><span class="o">,</span> <span class="nx">len</span><span class="o">=</span><span class="nx">hashParts</span><span class="o">.</span><span class="nx">length</span><span class="o">;</span> <span class="nx">i</span> <span class="o"><</span> <span class="nx">len</span><span class="o">;</span> <span class="nx">i</span><span class="o">++){</span> |
|
193 <span class="nx">hashPart</span> <span class="o">=</span> <span class="nx">hashParts</span><span class="o">[</span><span class="nx">i</span><span class="o">].</span><span class="nx">split</span><span class="o">(</span><span class="s2">"="</span><span class="o">);</span> |
|
194 <span class="nx">hash</span><span class="o">[</span><span class="nx">decode</span><span class="o">(</span><span class="nx">hashPart</span><span class="o">[</span><span class="m">0</span><span class="o">])]</span> <span class="o">=</span> <span class="nx">decode</span><span class="o">(</span><span class="nx">hashPart</span><span class="o">[</span><span class="m">1</span><span class="o">]);</span> |
|
195 <span class="o">}</span> |
|
196 <span class="o">}</span> |
|
197 |
|
198 <span class="k">return</span> <span class="nx">hash</span><span class="o">;</span> |
|
199 <span class="o">},</span> |
|
200 |
|
201 <span class="c">/**</span> |
|
202 <span class="c"> * Parses a cookie string into an object representing all accessible cookies.</span> |
|
203 <span class="c"> * @param {String} text The cookie string to parse.</span> |
|
204 <span class="c"> * @param {Boolean} shouldDecode (Optional) Indicates if the cookie values should be decoded or not. Default is true.</span> |
|
205 <span class="c"> * @return {Object} An object containing entries for each accessible cookie.</span> |
|
206 <span class="c"> * @method _parseCookieString</span> |
|
207 <span class="c"> * @private</span> |
|
208 <span class="c"> * @static</span> |
|
209 <span class="c"> */</span> |
|
210 <span class="nx">_parseCookieString</span> <span class="o">:</span> <span class="k">function</span> <span class="o">(</span><span class="nx">text</span> <span class="c">/*:String*/</span><span class="o">,</span> <span class="nx">shouldDecode</span> <span class="c">/*:Boolean*/</span><span class="o">)</span> <span class="c">/*:Object*/</span> <span class="o">{</span> |
|
211 |
|
212 <span class="k">var</span> <span class="nx">cookies</span> <span class="c">/*:Object*/</span> <span class="o">=</span> <span class="o">{};</span> |
|
213 |
|
214 <span class="k">if</span> <span class="o">(</span><span class="nx">isString</span><span class="o">(</span><span class="nx">text</span><span class="o">)</span> <span class="o">&&</span> <span class="nx">text</span><span class="o">.</span><span class="nx">length</span> <span class="o">></span> <span class="m">0</span><span class="o">)</span> <span class="o">{</span> |
|
215 |
|
216 <span class="k">var</span> <span class="nx">decodeValue</span> <span class="o">=</span> <span class="o">(</span><span class="nx">shouldDecode</span> <span class="o">===</span> <span class="kc">false</span> <span class="o">?</span> <span class="k">function</span><span class="o">(</span><span class="nx">s</span><span class="o">){</span><span class="k">return</span> <span class="nx">s</span><span class="o">;}</span> <span class="o">:</span> <span class="nx">decode</span><span class="o">),</span> |
|
217 <span class="nx">cookieParts</span> <span class="o">=</span> <span class="nx">text</span><span class="o">.</span><span class="nx">split</span><span class="o">(</span><span class="sr">/;\s/g</span><span class="o">),</span> |
|
218 <span class="nx">cookieName</span> <span class="o">=</span> <span class="nx">NULL</span><span class="o">,</span> |
|
219 <span class="nx">cookieValue</span> <span class="o">=</span> <span class="nx">NULL</span><span class="o">,</span> |
|
220 <span class="nx">cookieNameValue</span> <span class="o">=</span> <span class="nx">NULL</span><span class="o">;</span> |
|
221 |
|
222 <span class="k">for</span> <span class="o">(</span><span class="k">var</span> <span class="nx">i</span><span class="o">=</span><span class="m">0</span><span class="o">,</span> <span class="nx">len</span><span class="o">=</span><span class="nx">cookieParts</span><span class="o">.</span><span class="nx">length</span><span class="o">;</span> <span class="nx">i</span> <span class="o"><</span> <span class="nx">len</span><span class="o">;</span> <span class="nx">i</span><span class="o">++){</span> |
|
223 |
|
224 <span class="c">//check for normally-formatted cookie (name-value)</span> |
|
225 <span class="c"></span> <span class="nx">cookieNameValue</span> <span class="o">=</span> <span class="nx">cookieParts</span><span class="o">[</span><span class="nx">i</span><span class="o">].</span><span class="nx">match</span><span class="o">(</span><span class="sr">/([^=]+)=/i</span><span class="o">);</span> |
|
226 <span class="k">if</span> <span class="o">(</span><span class="nx">cookieNameValue</span> <span class="k">instanceof</span> <span class="nb">Array</span><span class="o">){</span> |
|
227 <span class="k">try</span> <span class="o">{</span> |
|
228 <span class="nx">cookieName</span> <span class="o">=</span> <span class="nx">decode</span><span class="o">(</span><span class="nx">cookieNameValue</span><span class="o">[</span><span class="m">1</span><span class="o">]);</span> |
|
229 <span class="nx">cookieValue</span> <span class="o">=</span> <span class="nx">decodeValue</span><span class="o">(</span><span class="nx">cookieParts</span><span class="o">[</span><span class="nx">i</span><span class="o">].</span><span class="nx">substring</span><span class="o">(</span><span class="nx">cookieNameValue</span><span class="o">[</span><span class="m">1</span><span class="o">].</span><span class="nx">length</span><span class="o">+</span><span class="m">1</span><span class="o">));</span> |
|
230 <span class="o">}</span> <span class="k">catch</span> <span class="o">(</span><span class="nx">ex</span><span class="o">){</span> |
|
231 <span class="c">//intentionally ignore the cookie - the encoding is wrong</span> |
|
232 <span class="c"></span> <span class="o">}</span> |
|
233 <span class="o">}</span> <span class="k">else</span> <span class="o">{</span> |
|
234 <span class="c">//means the cookie does not have an "=", so treat it as a boolean flag</span> |
|
235 <span class="c"></span> <span class="nx">cookieName</span> <span class="o">=</span> <span class="nx">decode</span><span class="o">(</span><span class="nx">cookieParts</span><span class="o">[</span><span class="nx">i</span><span class="o">]);</span> |
|
236 <span class="nx">cookieValue</span> <span class="o">=</span> <span class="s2">""</span><span class="o">;</span> |
|
237 <span class="o">}</span> |
|
238 <span class="nx">cookies</span><span class="o">[</span><span class="nx">cookieName</span><span class="o">]</span> <span class="o">=</span> <span class="nx">cookieValue</span><span class="o">;</span> |
|
239 <span class="o">}</span> |
|
240 |
|
241 <span class="o">}</span> |
|
242 |
|
243 <span class="k">return</span> <span class="nx">cookies</span><span class="o">;</span> |
|
244 <span class="o">},</span> |
|
245 |
|
246 <span class="c">//-------------------------------------------------------------------------</span> |
|
247 <span class="c"></span> <span class="c">// Public Methods</span> |
|
248 <span class="c"></span> <span class="c">//-------------------------------------------------------------------------</span> |
|
249 <span class="c"></span> |
|
250 <span class="c">/**</span> |
|
251 <span class="c"> * Determines if the cookie with the given name exists. This is useful for</span> |
|
252 <span class="c"> * Boolean cookies (those that do not follow the name=value convention).</span> |
|
253 <span class="c"> * @param {String} name The name of the cookie to check.</span> |
|
254 <span class="c"> * @return {Boolean} True if the cookie exists, false if not.</span> |
|
255 <span class="c"> * @method exists</span> |
|
256 <span class="c"> * @static</span> |
|
257 <span class="c"> */</span> |
|
258 <span class="nx">exists</span><span class="o">:</span> <span class="k">function</span><span class="o">(</span><span class="nx">name</span><span class="o">)</span> <span class="o">{</span> |
|
259 |
|
260 <span class="nx">validateCookieName</span><span class="o">(</span><span class="nx">name</span><span class="o">);</span> <span class="c">//throws error</span> |
|
261 <span class="c"></span> |
|
262 <span class="k">var</span> <span class="nx">cookies</span> <span class="o">=</span> <span class="k">this</span><span class="o">.</span><span class="nx">_parseCookieString</span><span class="o">(</span><span class="nx">doc</span><span class="o">.</span><span class="nx">cookie</span><span class="o">,</span> <span class="kc">true</span><span class="o">);</span> |
|
263 |
|
264 <span class="k">return</span> <span class="nx">cookies</span><span class="o">.</span><span class="nx">hasOwnProperty</span><span class="o">(</span><span class="nx">name</span><span class="o">);</span> |
|
265 <span class="o">},</span> |
|
266 |
|
267 <span class="c">/**</span> |
|
268 <span class="c"> * Returns the cookie value for the given name.</span> |
|
269 <span class="c"> * @param {String} name The name of the cookie to retrieve.</span> |
|
270 <span class="c"> * @param {Function|Object} options (Optional) An object containing one or more</span> |
|
271 <span class="c"> * cookie options: raw (true/false) and converter (a function).</span> |
|
272 <span class="c"> * The converter function is run on the value before returning it. The</span> |
|
273 <span class="c"> * function is not used if the cookie doesn't exist. The function can be</span> |
|
274 <span class="c"> * passed instead of the options object for backwards compatibility. When</span> |
|
275 <span class="c"> * raw is set to true, the cookie value is not URI decoded.</span> |
|
276 <span class="c"> * @return {Variant} If no converter is specified, returns a string or null if</span> |
|
277 <span class="c"> * the cookie doesn't exist. If the converter is specified, returns the value</span> |
|
278 <span class="c"> * returned from the converter or null if the cookie doesn't exist.</span> |
|
279 <span class="c"> * @method get</span> |
|
280 <span class="c"> * @static</span> |
|
281 <span class="c"> */</span> |
|
282 <span class="nx">get</span> <span class="o">:</span> <span class="k">function</span> <span class="o">(</span><span class="nx">name</span><span class="o">,</span> <span class="nx">options</span><span class="o">)</span> <span class="o">{</span> |
|
283 |
|
284 <span class="nx">validateCookieName</span><span class="o">(</span><span class="nx">name</span><span class="o">);</span> <span class="c">//throws error </span> |
|
285 <span class="c"></span> |
|
286 <span class="k">var</span> <span class="nx">cookies</span><span class="o">,</span> |
|
287 <span class="nx">cookie</span><span class="o">,</span> |
|
288 <span class="nx">converter</span><span class="o">;</span> |
|
289 |
|
290 <span class="c">//if options is a function, then it's the converter</span> |
|
291 <span class="c"></span> <span class="k">if</span> <span class="o">(</span><span class="nx">isFunction</span><span class="o">(</span><span class="nx">options</span><span class="o">))</span> <span class="o">{</span> |
|
292 <span class="nx">converter</span> <span class="o">=</span> <span class="nx">options</span><span class="o">;</span> |
|
293 <span class="nx">options</span> <span class="o">=</span> <span class="o">{};</span> |
|
294 <span class="o">}</span> <span class="k">else</span> <span class="k">if</span> <span class="o">(</span><span class="nx">isObject</span><span class="o">(</span><span class="nx">options</span><span class="o">))</span> <span class="o">{</span> |
|
295 <span class="nx">converter</span> <span class="o">=</span> <span class="nx">options</span><span class="o">.</span><span class="nx">converter</span><span class="o">;</span> |
|
296 <span class="o">}</span> <span class="k">else</span> <span class="o">{</span> |
|
297 <span class="nx">options</span> <span class="o">=</span> <span class="o">{};</span> |
|
298 <span class="o">}</span> |
|
299 |
|
300 <span class="nx">cookies</span> <span class="o">=</span> <span class="k">this</span><span class="o">.</span><span class="nx">_parseCookieString</span><span class="o">(</span><span class="nx">doc</span><span class="o">.</span><span class="nx">cookie</span><span class="o">,</span> <span class="o">!</span><span class="nx">options</span><span class="o">.</span><span class="nx">raw</span><span class="o">);</span> |
|
301 <span class="nx">cookie</span> <span class="o">=</span> <span class="nx">cookies</span><span class="o">[</span><span class="nx">name</span><span class="o">];</span> |
|
302 |
|
303 <span class="c">//should return null, not undefined if the cookie doesn't exist</span> |
|
304 <span class="c"></span> <span class="k">if</span> <span class="o">(</span><span class="nx">isUndefined</span><span class="o">(</span><span class="nx">cookie</span><span class="o">))</span> <span class="o">{</span> |
|
305 <span class="k">return</span> <span class="nx">NULL</span><span class="o">;</span> |
|
306 <span class="o">}</span> |
|
307 |
|
308 <span class="k">if</span> <span class="o">(!</span><span class="nx">isFunction</span><span class="o">(</span><span class="nx">converter</span><span class="o">)){</span> |
|
309 <span class="k">return</span> <span class="nx">cookie</span><span class="o">;</span> |
|
310 <span class="o">}</span> <span class="k">else</span> <span class="o">{</span> |
|
311 <span class="k">return</span> <span class="nx">converter</span><span class="o">(</span><span class="nx">cookie</span><span class="o">);</span> |
|
312 <span class="o">}</span> |
|
313 <span class="o">},</span> |
|
314 |
|
315 <span class="c">/**</span> |
|
316 <span class="c"> * Returns the value of a subcookie.</span> |
|
317 <span class="c"> * @param {String} name The name of the cookie to retrieve.</span> |
|
318 <span class="c"> * @param {String} subName The name of the subcookie to retrieve.</span> |
|
319 <span class="c"> * @param {Function} converter (Optional) A function to run on the value before returning</span> |
|
320 <span class="c"> * it. The function is not used if the cookie doesn't exist.</span> |
|
321 <span class="c"> * @return {Variant} If the cookie doesn't exist, null is returned. If the subcookie</span> |
|
322 <span class="c"> * doesn't exist, null if also returned. If no converter is specified and the</span> |
|
323 <span class="c"> * subcookie exists, a string is returned. If a converter is specified and the</span> |
|
324 <span class="c"> * subcookie exists, the value returned from the converter is returned.</span> |
|
325 <span class="c"> * @method getSub</span> |
|
326 <span class="c"> * @static</span> |
|
327 <span class="c"> */</span> |
|
328 <span class="nx">getSub</span> <span class="o">:</span> <span class="k">function</span> <span class="o">(</span><span class="nx">name</span> <span class="c">/*:String*/</span><span class="o">,</span> <span class="nx">subName</span> <span class="c">/*:String*/</span><span class="o">,</span> <span class="nx">converter</span> <span class="c">/*:Function*/</span><span class="o">)</span> <span class="c">/*:Variant*/</span> <span class="o">{</span> |
|
329 |
|
330 <span class="k">var</span> <span class="nx">hash</span> <span class="c">/*:Variant*/</span> <span class="o">=</span> <span class="k">this</span><span class="o">.</span><span class="nx">getSubs</span><span class="o">(</span><span class="nx">name</span><span class="o">);</span> |
|
331 |
|
332 <span class="k">if</span> <span class="o">(</span><span class="nx">hash</span> <span class="o">!==</span> <span class="nx">NULL</span><span class="o">)</span> <span class="o">{</span> |
|
333 |
|
334 <span class="nx">validateSubcookieName</span><span class="o">(</span><span class="nx">subName</span><span class="o">);</span> <span class="c">//throws error</span> |
|
335 <span class="c"></span> |
|
336 <span class="k">if</span> <span class="o">(</span><span class="nx">isUndefined</span><span class="o">(</span><span class="nx">hash</span><span class="o">[</span><span class="nx">subName</span><span class="o">])){</span> |
|
337 <span class="k">return</span> <span class="nx">NULL</span><span class="o">;</span> |
|
338 <span class="o">}</span> |
|
339 |
|
340 <span class="k">if</span> <span class="o">(!</span><span class="nx">isFunction</span><span class="o">(</span><span class="nx">converter</span><span class="o">)){</span> |
|
341 <span class="k">return</span> <span class="nx">hash</span><span class="o">[</span><span class="nx">subName</span><span class="o">];</span> |
|
342 <span class="o">}</span> <span class="k">else</span> <span class="o">{</span> |
|
343 <span class="k">return</span> <span class="nx">converter</span><span class="o">(</span><span class="nx">hash</span><span class="o">[</span><span class="nx">subName</span><span class="o">]);</span> |
|
344 <span class="o">}</span> |
|
345 <span class="o">}</span> <span class="k">else</span> <span class="o">{</span> |
|
346 <span class="k">return</span> <span class="nx">NULL</span><span class="o">;</span> |
|
347 <span class="o">}</span> |
|
348 |
|
349 <span class="o">},</span> |
|
350 |
|
351 <span class="c">/**</span> |
|
352 <span class="c"> * Returns an object containing name-value pairs stored in the cookie with the given name.</span> |
|
353 <span class="c"> * @param {String} name The name of the cookie to retrieve.</span> |
|
354 <span class="c"> * @return {Object} An object of name-value pairs if the cookie with the given name</span> |
|
355 <span class="c"> * exists, null if it does not.</span> |
|
356 <span class="c"> * @method getSubs</span> |
|
357 <span class="c"> * @static</span> |
|
358 <span class="c"> */</span> |
|
359 <span class="nx">getSubs</span> <span class="o">:</span> <span class="k">function</span> <span class="o">(</span><span class="nx">name</span><span class="o">)</span> <span class="o">{</span> |
|
360 |
|
361 <span class="nx">validateCookieName</span><span class="o">(</span><span class="nx">name</span><span class="o">);</span> <span class="c">//throws error</span> |
|
362 <span class="c"></span> |
|
363 <span class="k">var</span> <span class="nx">cookies</span> <span class="o">=</span> <span class="k">this</span><span class="o">.</span><span class="nx">_parseCookieString</span><span class="o">(</span><span class="nx">doc</span><span class="o">.</span><span class="nx">cookie</span><span class="o">,</span> <span class="kc">false</span><span class="o">);</span> |
|
364 <span class="k">if</span> <span class="o">(</span><span class="nx">isString</span><span class="o">(</span><span class="nx">cookies</span><span class="o">[</span><span class="nx">name</span><span class="o">])){</span> |
|
365 <span class="k">return</span> <span class="k">this</span><span class="o">.</span><span class="nx">_parseCookieHash</span><span class="o">(</span><span class="nx">cookies</span><span class="o">[</span><span class="nx">name</span><span class="o">]);</span> |
|
366 <span class="o">}</span> |
|
367 <span class="k">return</span> <span class="nx">NULL</span><span class="o">;</span> |
|
368 <span class="o">},</span> |
|
369 |
|
370 <span class="c">/**</span> |
|
371 <span class="c"> * Removes a cookie from the machine by setting its expiration date to</span> |
|
372 <span class="c"> * sometime in the past.</span> |
|
373 <span class="c"> * @param {String} name The name of the cookie to remove.</span> |
|
374 <span class="c"> * @param {Object} options (Optional) An object containing one or more</span> |
|
375 <span class="c"> * cookie options: path (a string), domain (a string), </span> |
|
376 <span class="c"> * and secure (true/false). The expires option will be overwritten</span> |
|
377 <span class="c"> * by the method.</span> |
|
378 <span class="c"> * @return {String} The created cookie string.</span> |
|
379 <span class="c"> * @method remove</span> |
|
380 <span class="c"> * @static</span> |
|
381 <span class="c"> */</span> |
|
382 <span class="nx">remove</span> <span class="o">:</span> <span class="k">function</span> <span class="o">(</span><span class="nx">name</span><span class="o">,</span> <span class="nx">options</span><span class="o">)</span> <span class="o">{</span> |
|
383 |
|
384 <span class="nx">validateCookieName</span><span class="o">(</span><span class="nx">name</span><span class="o">);</span> <span class="c">//throws error</span> |
|
385 <span class="c"></span> |
|
386 <span class="c">//set options</span> |
|
387 <span class="c"></span> <span class="nx">options</span> <span class="o">=</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">merge</span><span class="o">(</span><span class="nx">options</span> <span class="o">||</span> <span class="o">{},</span> <span class="o">{</span> |
|
388 <span class="nx">expires</span><span class="o">:</span> <span class="k">new</span> <span class="nb">Date</span><span class="o">(</span><span class="m">0</span><span class="o">)</span> |
|
389 <span class="o">});</span> |
|
390 |
|
391 <span class="c">//set cookie</span> |
|
392 <span class="c"></span> <span class="k">return</span> <span class="k">this</span><span class="o">.</span><span class="nx">set</span><span class="o">(</span><span class="nx">name</span><span class="o">,</span> <span class="s2">""</span><span class="o">,</span> <span class="nx">options</span><span class="o">);</span> |
|
393 <span class="o">},</span> |
|
394 |
|
395 <span class="c">/**</span> |
|
396 <span class="c"> * Removes a sub cookie with a given name.</span> |
|
397 <span class="c"> * @param {String} name The name of the cookie in which the subcookie exists.</span> |
|
398 <span class="c"> * @param {String} subName The name of the subcookie to remove.</span> |
|
399 <span class="c"> * @param {Object} options (Optional) An object containing one or more</span> |
|
400 <span class="c"> * cookie options: path (a string), domain (a string), expires (a Date object),</span> |
|
401 <span class="c"> * removeIfEmpty (true/false), and secure (true/false). This must be the same</span> |
|
402 <span class="c"> * settings as the original subcookie.</span> |
|
403 <span class="c"> * @return {String} The created cookie string.</span> |
|
404 <span class="c"> * @method removeSub</span> |
|
405 <span class="c"> * @static</span> |
|
406 <span class="c"> */</span> |
|
407 <span class="nx">removeSub</span> <span class="o">:</span> <span class="k">function</span><span class="o">(</span><span class="nx">name</span><span class="o">,</span> <span class="nx">subName</span><span class="o">,</span> <span class="nx">options</span><span class="o">)</span> <span class="o">{</span> |
|
408 |
|
409 <span class="nx">validateCookieName</span><span class="o">(</span><span class="nx">name</span><span class="o">);</span> <span class="c">//throws error</span> |
|
410 <span class="c"></span> |
|
411 <span class="nx">validateSubcookieName</span><span class="o">(</span><span class="nx">subName</span><span class="o">);</span> <span class="c">//throws error</span> |
|
412 <span class="c"></span> |
|
413 <span class="nx">options</span> <span class="o">=</span> <span class="nx">options</span> <span class="o">||</span> <span class="o">{};</span> |
|
414 |
|
415 <span class="c">//get all subcookies for this cookie</span> |
|
416 <span class="c"></span> <span class="k">var</span> <span class="nx">subs</span> <span class="o">=</span> <span class="k">this</span><span class="o">.</span><span class="nx">getSubs</span><span class="o">(</span><span class="nx">name</span><span class="o">);</span> |
|
417 |
|
418 <span class="c">//delete the indicated subcookie</span> |
|
419 <span class="c"></span> <span class="k">if</span> <span class="o">(</span><span class="nx">isObject</span><span class="o">(</span><span class="nx">subs</span><span class="o">)</span> <span class="o">&&</span> <span class="nx">subs</span><span class="o">.</span><span class="nx">hasOwnProperty</span><span class="o">(</span><span class="nx">subName</span><span class="o">)){</span> |
|
420 <span class="nx">delete</span> <span class="nx">subs</span><span class="o">[</span><span class="nx">subName</span><span class="o">];</span> |
|
421 |
|
422 <span class="k">if</span> <span class="o">(!</span><span class="nx">options</span><span class="o">.</span><span class="nx">removeIfEmpty</span><span class="o">)</span> <span class="o">{</span> |
|
423 <span class="c">//reset the cookie</span> |
|
424 <span class="c"></span> |
|
425 <span class="k">return</span> <span class="k">this</span><span class="o">.</span><span class="nx">setSubs</span><span class="o">(</span><span class="nx">name</span><span class="o">,</span> <span class="nx">subs</span><span class="o">,</span> <span class="nx">options</span><span class="o">);</span> |
|
426 <span class="o">}</span> <span class="k">else</span> <span class="o">{</span> |
|
427 <span class="c">//reset the cookie if there are subcookies left, else remove</span> |
|
428 <span class="c"></span> <span class="k">for</span> <span class="o">(</span><span class="k">var</span> <span class="nx">key</span> <span class="k">in</span> <span class="nx">subs</span><span class="o">){</span> |
|
429 <span class="k">if</span> <span class="o">(</span><span class="nx">subs</span><span class="o">.</span><span class="nx">hasOwnProperty</span><span class="o">(</span><span class="nx">key</span><span class="o">)</span> <span class="o">&&</span> <span class="o">!</span><span class="nx">isFunction</span><span class="o">(</span><span class="nx">subs</span><span class="o">[</span><span class="nx">key</span><span class="o">])</span> <span class="o">&&</span> <span class="o">!</span><span class="nx">isUndefined</span><span class="o">(</span><span class="nx">subs</span><span class="o">[</span><span class="nx">key</span><span class="o">])){</span> |
|
430 <span class="k">return</span> <span class="k">this</span><span class="o">.</span><span class="nx">setSubs</span><span class="o">(</span><span class="nx">name</span><span class="o">,</span> <span class="nx">subs</span><span class="o">,</span> <span class="nx">options</span><span class="o">);</span> |
|
431 <span class="o">}</span> |
|
432 <span class="o">}</span> |
|
433 |
|
434 <span class="k">return</span> <span class="k">this</span><span class="o">.</span><span class="nx">remove</span><span class="o">(</span><span class="nx">name</span><span class="o">,</span> <span class="nx">options</span><span class="o">);</span> |
|
435 <span class="o">}</span> |
|
436 <span class="o">}</span> <span class="k">else</span> <span class="o">{</span> |
|
437 <span class="k">return</span> <span class="s2">""</span><span class="o">;</span> |
|
438 <span class="o">}</span> |
|
439 |
|
440 <span class="o">},</span> |
|
441 |
|
442 <span class="c">/**</span> |
|
443 <span class="c"> * Sets a cookie with a given name and value.</span> |
|
444 <span class="c"> * @param {String} name The name of the cookie to set.</span> |
|
445 <span class="c"> * @param {Variant} value The value to set for the cookie.</span> |
|
446 <span class="c"> * @param {Object} options (Optional) An object containing one or more</span> |
|
447 <span class="c"> * cookie options: path (a string), domain (a string), expires (a Date object),</span> |
|
448 <span class="c"> * secure (true/false), and raw (true/false). Setting raw to true indicates</span> |
|
449 <span class="c"> * that the cookie should not be URI encoded before being set.</span> |
|
450 <span class="c"> * @return {String} The created cookie string.</span> |
|
451 <span class="c"> * @method set</span> |
|
452 <span class="c"> * @static</span> |
|
453 <span class="c"> */</span> |
|
454 <span class="nx">set</span> <span class="o">:</span> <span class="k">function</span> <span class="o">(</span><span class="nx">name</span><span class="o">,</span> <span class="nx">value</span><span class="o">,</span> <span class="nx">options</span><span class="o">)</span> <span class="o">{</span> |
|
455 |
|
456 <span class="nx">validateCookieName</span><span class="o">(</span><span class="nx">name</span><span class="o">);</span> <span class="c">//throws error</span> |
|
457 <span class="c"></span> |
|
458 <span class="k">if</span> <span class="o">(</span><span class="nx">isUndefined</span><span class="o">(</span><span class="nx">value</span><span class="o">)){</span> |
|
459 <span class="nx">error</span><span class="o">(</span><span class="s2">"Cookie.set(): Value cannot be undefined."</span><span class="o">);</span> |
|
460 <span class="o">}</span> |
|
461 |
|
462 <span class="nx">options</span> <span class="o">=</span> <span class="nx">options</span> <span class="o">||</span> <span class="o">{};</span> |
|
463 |
|
464 <span class="k">var</span> <span class="nx">text</span> <span class="o">=</span> <span class="k">this</span><span class="o">.</span><span class="nx">_createCookieString</span><span class="o">(</span><span class="nx">name</span><span class="o">,</span> <span class="nx">value</span><span class="o">,</span> <span class="o">!</span><span class="nx">options</span><span class="o">.</span><span class="nx">raw</span><span class="o">,</span> <span class="nx">options</span><span class="o">);</span> |
|
465 <span class="nx">doc</span><span class="o">.</span><span class="nx">cookie</span> <span class="o">=</span> <span class="nx">text</span><span class="o">;</span> |
|
466 <span class="k">return</span> <span class="nx">text</span><span class="o">;</span> |
|
467 <span class="o">},</span> |
|
468 |
|
469 <span class="c">/**</span> |
|
470 <span class="c"> * Sets a sub cookie with a given name to a particular value.</span> |
|
471 <span class="c"> * @param {String} name The name of the cookie to set.</span> |
|
472 <span class="c"> * @param {String} subName The name of the subcookie to set.</span> |
|
473 <span class="c"> * @param {Variant} value The value to set.</span> |
|
474 <span class="c"> * @param {Object} options (Optional) An object containing one or more</span> |
|
475 <span class="c"> * cookie options: path (a string), domain (a string), expires (a Date object),</span> |
|
476 <span class="c"> * and secure (true/false).</span> |
|
477 <span class="c"> * @return {String} The created cookie string.</span> |
|
478 <span class="c"> * @method setSub</span> |
|
479 <span class="c"> * @static</span> |
|
480 <span class="c"> */</span> |
|
481 <span class="nx">setSub</span> <span class="o">:</span> <span class="k">function</span> <span class="o">(</span><span class="nx">name</span><span class="o">,</span> <span class="nx">subName</span><span class="o">,</span> <span class="nx">value</span><span class="o">,</span> <span class="nx">options</span><span class="o">)</span> <span class="o">{</span> |
|
482 |
|
483 <span class="nx">validateCookieName</span><span class="o">(</span><span class="nx">name</span><span class="o">);</span> <span class="c">//throws error</span> |
|
484 <span class="c"></span> |
|
485 <span class="nx">validateSubcookieName</span><span class="o">(</span><span class="nx">subName</span><span class="o">);</span> <span class="c">//throws error</span> |
|
486 <span class="c"></span> |
|
487 <span class="k">if</span> <span class="o">(</span><span class="nx">isUndefined</span><span class="o">(</span><span class="nx">value</span><span class="o">)){</span> |
|
488 <span class="nx">error</span><span class="o">(</span><span class="s2">"Cookie.setSub(): Subcookie value cannot be undefined."</span><span class="o">);</span> |
|
489 <span class="o">}</span> |
|
490 |
|
491 <span class="k">var</span> <span class="nx">hash</span> <span class="o">=</span> <span class="k">this</span><span class="o">.</span><span class="nx">getSubs</span><span class="o">(</span><span class="nx">name</span><span class="o">);</span> |
|
492 |
|
493 <span class="k">if</span> <span class="o">(!</span><span class="nx">isObject</span><span class="o">(</span><span class="nx">hash</span><span class="o">)){</span> |
|
494 <span class="nx">hash</span> <span class="o">=</span> <span class="o">{};</span> |
|
495 <span class="o">}</span> |
|
496 |
|
497 <span class="nx">hash</span><span class="o">[</span><span class="nx">subName</span><span class="o">]</span> <span class="o">=</span> <span class="nx">value</span><span class="o">;</span> |
|
498 |
|
499 <span class="k">return</span> <span class="k">this</span><span class="o">.</span><span class="nx">setSubs</span><span class="o">(</span><span class="nx">name</span><span class="o">,</span> <span class="nx">hash</span><span class="o">,</span> <span class="nx">options</span><span class="o">);</span> |
|
500 |
|
501 <span class="o">},</span> |
|
502 |
|
503 <span class="c">/**</span> |
|
504 <span class="c"> * Sets a cookie with a given name to contain a hash of name-value pairs.</span> |
|
505 <span class="c"> * @param {String} name The name of the cookie to set.</span> |
|
506 <span class="c"> * @param {Object} value An object containing name-value pairs.</span> |
|
507 <span class="c"> * @param {Object} options (Optional) An object containing one or more</span> |
|
508 <span class="c"> * cookie options: path (a string), domain (a string), expires (a Date object),</span> |
|
509 <span class="c"> * and secure (true/false).</span> |
|
510 <span class="c"> * @return {String} The created cookie string.</span> |
|
511 <span class="c"> * @method setSubs</span> |
|
512 <span class="c"> * @static</span> |
|
513 <span class="c"> */</span> |
|
514 <span class="nx">setSubs</span> <span class="o">:</span> <span class="k">function</span> <span class="o">(</span><span class="nx">name</span><span class="o">,</span> <span class="nx">value</span><span class="o">,</span> <span class="nx">options</span><span class="o">)</span> <span class="o">{</span> |
|
515 |
|
516 <span class="nx">validateCookieName</span><span class="o">(</span><span class="nx">name</span><span class="o">);</span> <span class="c">//throws error</span> |
|
517 <span class="c"></span> |
|
518 <span class="k">if</span> <span class="o">(!</span><span class="nx">isObject</span><span class="o">(</span><span class="nx">value</span><span class="o">)){</span> |
|
519 <span class="nx">error</span><span class="o">(</span><span class="s2">"Cookie.setSubs(): Cookie value must be an object."</span><span class="o">);</span> |
|
520 <span class="o">}</span> |
|
521 |
|
522 <span class="k">var</span> <span class="nx">text</span> <span class="c">/*:String*/</span> <span class="o">=</span> <span class="k">this</span><span class="o">.</span><span class="nx">_createCookieString</span><span class="o">(</span><span class="nx">name</span><span class="o">,</span> <span class="k">this</span><span class="o">.</span><span class="nx">_createCookieHashString</span><span class="o">(</span><span class="nx">value</span><span class="o">),</span> <span class="kc">false</span><span class="o">,</span> <span class="nx">options</span><span class="o">);</span> |
|
523 <span class="nx">doc</span><span class="o">.</span><span class="nx">cookie</span> <span class="o">=</span> <span class="nx">text</span><span class="o">;</span> |
|
524 <span class="k">return</span> <span class="nx">text</span><span class="o">;</span> |
|
525 <span class="o">}</span> |
|
526 |
|
527 <span class="o">};</span> |
|
528 </pre></div> |
|
529 |
|
530 </div> |
|
531 </div> |
|
532 </div> |
|
533 <div class="yui-b"> |
|
534 <div class="nav"> |
|
535 |
|
536 <div id="moduleList" class="module"> |
|
537 <h4>Modules</h4> |
|
538 <ul class="content"> |
|
539 <li class=""><a href="module_anim.html" title="anim">anim</a></li> |
|
540 <li class=""><a href="module_async-queue.html" title="async-queue">async-queue</a></li> |
|
541 <li class=""><a href="module_attribute.html" title="attribute">attribute</a></li> |
|
542 <li class=""><a href="module_base.html" title="base">base</a></li> |
|
543 <li class=""><a href="module_cache.html" title="cache">cache</a></li> |
|
544 <li class=""><a href="module_classnamemanager.html" title="classnamemanager">classnamemanager</a></li> |
|
545 <li class=""><a href="module_collection.html" title="collection">collection</a></li> |
|
546 <li class=""><a href="module_console.html" title="console">console</a></li> |
|
547 <li class=""><a href="module_console-filters.html" title="console-filters">console-filters</a></li> |
|
548 <li class="selected"><a href="module_cookie.html" title="cookie">cookie</a></li> |
|
549 <li class=""><a href="module_dataschema.html" title="dataschema">dataschema</a></li> |
|
550 <li class=""><a href="module_datasource.html" title="datasource">datasource</a></li> |
|
551 <li class=""><a href="module_datatype.html" title="datatype">datatype</a></li> |
|
552 <li class=""><a href="module_dd.html" title="dd">dd</a></li> |
|
553 <li class=""><a href="module_dom.html" title="dom">dom</a></li> |
|
554 <li class=""><a href="module_dump.html" title="dump">dump</a></li> |
|
555 <li class=""><a href="module_event.html" title="event">event</a></li> |
|
556 <li class=""><a href="module_event-custom.html" title="event-custom">event-custom</a></li> |
|
557 <li class=""><a href="module_event-simulate.html" title="event-simulate">event-simulate</a></li> |
|
558 <li class=""><a href="module_history.html" title="history">history</a></li> |
|
559 <li class=""><a href="module_imageloader.html" title="imageloader">imageloader</a></li> |
|
560 <li class=""><a href="module_io.html" title="io">io</a></li> |
|
561 <li class=""><a href="module_json.html" title="json">json</a></li> |
|
562 <li class=""><a href="module_node.html" title="node">node</a></li> |
|
563 <li class=""><a href="module_node-focusmanager.html" title="node-focusmanager">node-focusmanager</a></li> |
|
564 <li class=""><a href="module_node-menunav.html" title="node-menunav">node-menunav</a></li> |
|
565 <li class=""><a href="module_oop.html" title="oop">oop</a></li> |
|
566 <li class=""><a href="module_overlay.html" title="overlay">overlay</a></li> |
|
567 <li class=""><a href="module_plugin.html" title="plugin">plugin</a></li> |
|
568 <li class=""><a href="module_profiler.html" title="profiler">profiler</a></li> |
|
569 <li class=""><a href="module_queue-promote.html" title="queue-promote">queue-promote</a></li> |
|
570 <li class=""><a href="module_slider.html" title="slider">slider</a></li> |
|
571 <li class=""><a href="module_stylesheet.html" title="stylesheet">stylesheet</a></li> |
|
572 <li class=""><a href="module_substitute.html" title="substitute">substitute</a></li> |
|
573 <li class=""><a href="module_test.html" title="test">test</a></li> |
|
574 <li class=""><a href="module_widget.html" title="widget">widget</a></li> |
|
575 <li class=""><a href="module_widget-position.html" title="widget-position">widget-position</a></li> |
|
576 <li class=""><a href="module_widget-position-ext.html" title="widget-position-ext">widget-position-ext</a></li> |
|
577 <li class=""><a href="module_widget-stack.html" title="widget-stack">widget-stack</a></li> |
|
578 <li class=""><a href="module_widget-stdmod.html" title="widget-stdmod">widget-stdmod</a></li> |
|
579 <li class=""><a href="module_yui.html" title="yui">yui</a></li> |
|
580 </ul> |
|
581 </div> |
|
582 |
|
583 <div id="classList" class="module"> |
|
584 <h4>Classes</h4> |
|
585 <ul class="content"> |
|
586 <li class=""><a href="Cookie.html" title="Cookie">Cookie</a></li> |
|
587 </ul> |
|
588 </div> |
|
589 |
|
590 <div id="fileList" class="module"> |
|
591 <h4>Files</h4> |
|
592 <ul class="content"> |
|
593 <li class="selected"><a href="Cookie.js.html" title="Cookie.js">Cookie.js</a></li> |
|
594 </ul> |
|
595 </div> |
|
596 |
|
597 |
|
598 |
|
599 |
|
600 |
|
601 </div> |
|
602 </div> |
|
603 </div> |
|
604 <div id="ft"> |
|
605 <hr /> |
|
606 Copyright © 2009 Yahoo! Inc. All rights reserved. |
|
607 </div> |
|
608 </div> |
|
609 <script type="text/javascript"> |
|
610 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"}]; |
|
611 </script> |
|
612 </body> |
|
613 </html> |