|
0
|
1 |
|
|
|
2 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> |
|
|
3 |
<html> |
|
|
4 |
<head> |
|
|
5 |
<title>YUI Library Examples: Cookie: Subcookie Example</title> |
|
|
6 |
<meta http-equiv="content-type" content="text/html; charset=utf-8"> |
|
|
7 |
<link rel="stylesheet" type="text/css" href="../../assets/yui.css" > |
|
|
8 |
|
|
|
9 |
<style> |
|
|
10 |
/*Supplemental CSS for the YUI distribution*/ |
|
|
11 |
#custom-doc { width: 95%; min-width: 950px; } |
|
|
12 |
#pagetitle {background-image: url(../../assets/bg_hd.gif);} |
|
|
13 |
/* #pagetitle h1 {background-image: url(../../assets/title_h_bg.gif);}*/ |
|
|
14 |
</style> |
|
|
15 |
|
|
|
16 |
<link rel="stylesheet" type="text/css" href="../../assets/dpSyntaxHighlighter.css"> |
|
|
17 |
|
|
|
18 |
<!--there is no custom header content for this example--> |
|
|
19 |
|
|
|
20 |
<link type="text/css" rel="stylesheet" href="../../build/cssfonts/fonts-min.css" /> |
|
|
21 |
<script type="text/javascript" src="../../build/yui/yui-min.js"></script> |
|
|
22 |
|
|
|
23 |
</head> |
|
|
24 |
<body id="yahoo-com" class=" yui-skin-sam"> |
|
|
25 |
<div id="custom-doc" class="yui-t2"> |
|
|
26 |
<div id="hd"> |
|
|
27 |
<div id="ygunav"> |
|
|
28 |
<p> |
|
|
29 |
<em> |
|
|
30 |
<a href="http://developer.yahoo.com/yui/3/">YUI 3.x Home</a> <i> - </i> |
|
|
31 |
</em> |
|
|
32 |
</p> |
|
|
33 |
<form action="http://search.yahoo.com/search" id="sitesearchform"> |
|
|
34 |
<input name="vs" type="hidden" value="developer.yahoo.com"> |
|
|
35 |
<input name="vs" type="hidden" value="yuiblog.com"> |
|
|
36 |
<div id="sitesearch"> |
|
|
37 |
<label for="searchinput">Site Search (YDN & YUIBlog): </label> |
|
|
38 |
<input type="text" id="searchinput" name="p"> |
|
|
39 |
<input type="submit" value="Search" id="searchsubmit" class="ygbt"> |
|
|
40 |
</div> |
|
|
41 |
</form> |
|
|
42 |
</div> |
|
|
43 |
<div id="ygma"><a href="../../"><img src="../../assets/logo.gif" border="0" width="200" height="93"></a></div> |
|
|
44 |
<div id="pagetitle"><h1>YUI Library Examples: Cookie: Subcookie Example</h1></div> |
|
|
45 |
</div> |
|
|
46 |
<div id="bd"> |
|
|
47 |
|
|
|
48 |
|
|
|
49 |
<div id="yui-main"> |
|
|
50 |
<div class="yui-b"> |
|
|
51 |
<div class="yui-ge"> |
|
|
52 |
<div class="yui-u first example" id="main"> |
|
|
53 |
|
|
|
54 |
<h2>Cookie: Subcookie Example</h2> |
|
|
55 |
|
|
|
56 |
<div id="example" class="promo"> |
|
|
57 |
<div class="example-intro"> |
|
|
58 |
<p>This example shows how to get and set subcookies as well as using conversion functions when retrieving subcookie values.</p> </div> |
|
|
59 |
|
|
|
60 |
<div class="module example-container "> |
|
|
61 |
<div id="example-canvas" class="bd"> |
|
|
62 |
|
|
|
63 |
|
|
|
64 |
<!--BEGIN SOURCE CODE FOR EXAMPLE =============================== --> |
|
|
65 |
|
|
|
66 |
<script type="text/javascript"> |
|
|
67 |
YUI({base:"../../build/", timeout: 10000}).use("node", "cookie",function (Y) { |
|
|
68 |
|
|
|
69 |
//get subcookie values |
|
|
70 |
var name = Y.Cookie.getSub("example", "name"); |
|
|
71 |
var today = Y.Cookie.getSub("example", "today", function(value){ |
|
|
72 |
return new Date(value); |
|
|
73 |
}); |
|
|
74 |
var count = Y.Cookie.getSub("example", "count", Number); |
|
|
75 |
|
|
|
76 |
alert("The subcookie 'name' is '" + name + "'(" + (typeof name) + ")"); |
|
|
77 |
alert("The subcookie 'today' is '" + today + "'(" + (typeof today) + ")"); |
|
|
78 |
alert("The subcookie 'count' is '" + count + "'(" + (typeof count) + ")"); |
|
|
79 |
|
|
|
80 |
//set subcookie values |
|
|
81 |
Y.Cookie.setSub("example", "name", "Yahoo!"); |
|
|
82 |
Y.Cookie.setSub("example", "today", (new Date()).toString()); |
|
|
83 |
Y.Cookie.setSub("example", "count", Math.round(Math.random() * 30)); |
|
|
84 |
|
|
|
85 |
}); |
|
|
86 |
</script> |
|
|
87 |
<!--END SOURCE CODE FOR EXAMPLE =============================== --> |
|
|
88 |
|
|
|
89 |
|
|
|
90 |
</div> |
|
|
91 |
</div> |
|
|
92 |
</div> |
|
|
93 |
|
|
|
94 |
<h2 class="first">Subcookie Example</h2> |
|
|
95 |
<p>The first three lines attempt to read the values stored in subcookies of the "example" cookie:</p> |
|
|
96 |
<div id="syntax1" class="yui-syntax-highlight"><div class="numbers"><pre class="javascript" style="font-family:monospace;"><ol><li class="li1"><div class="de1"><span class="kw2">var</span> <span class="kw3">name</span> <span class="sy0">=</span> Y.<span class="me1">Cookie</span>.<span class="me1">getSub</span><span class="br0">(</span><span class="st0">"example"</span><span class="sy0">,</span> <span class="st0">"name"</span><span class="br0">)</span><span class="sy0">;</span></div></li><li class="li1"><div class="de1"><span class="kw2">var</span> today <span class="sy0">=</span> Y.<span class="me1">Cookie</span>.<span class="me1">getSub</span><span class="br0">(</span><span class="st0">"example"</span><span class="sy0">,</span> <span class="st0">"today"</span><span class="sy0">,</span> <span class="kw2">function</span><span class="br0">(</span>value<span class="br0">)</span><span class="br0">{</span></div></li><li class="li1"><div class="de1"> <span class="kw1">return</span> <span class="kw2">new</span> Date<span class="br0">(</span>value<span class="br0">)</span><span class="sy0">;</span></div></li><li class="li1"><div class="de1"><span class="br0">}</span><span class="br0">)</span><span class="sy0">;</span></div></li><li class="li2"><div class="de2"><span class="kw2">var</span> count <span class="sy0">=</span> Y.<span class="me1">Cookie</span>.<span class="me1">getSub</span><span class="br0">(</span><span class="st0">"example"</span><span class="sy0">,</span> <span class="st0">"count"</span><span class="sy0">,</span> Number<span class="br0">)</span><span class="sy0">;</span></div></li></ol></pre></div><div class="nonumbers"><pre class="javascript" style="font-family:monospace;"><span class="kw2">var</span> <span class="kw3">name</span> <span class="sy0">=</span> Y.<span class="me1">Cookie</span>.<span class="me1">getSub</span><span class="br0">(</span><span class="st0">"example"</span><span class="sy0">,</span> <span class="st0">"name"</span><span class="br0">)</span><span class="sy0">;</span> |
|
|
97 |
<span class="kw2">var</span> today <span class="sy0">=</span> Y.<span class="me1">Cookie</span>.<span class="me1">getSub</span><span class="br0">(</span><span class="st0">"example"</span><span class="sy0">,</span> <span class="st0">"today"</span><span class="sy0">,</span> <span class="kw2">function</span><span class="br0">(</span>value<span class="br0">)</span><span class="br0">{</span> |
|
|
98 |
<span class="kw1">return</span> <span class="kw2">new</span> Date<span class="br0">(</span>value<span class="br0">)</span><span class="sy0">;</span> |
|
|
99 |
<span class="br0">}</span><span class="br0">)</span><span class="sy0">;</span> |
|
|
100 |
<span class="kw2">var</span> count <span class="sy0">=</span> Y.<span class="me1">Cookie</span>.<span class="me1">getSub</span><span class="br0">(</span><span class="st0">"example"</span><span class="sy0">,</span> <span class="st0">"count"</span><span class="sy0">,</span> Number<span class="br0">)</span><span class="sy0">;</span></pre></div><textarea id="syntax1-plain">var name = Y.Cookie.getSub("example", "name"); |
|
|
101 |
var today = Y.Cookie.getSub("example", "today", function(value){ |
|
|
102 |
return new Date(value); |
|
|
103 |
}); |
|
|
104 |
var count = Y.Cookie.getSub("example", "count", Number);</textarea></div><p>The "name" subcookie stores a string so it is retrieved without specifying a third argument. The "today" |
|
|
105 |
subcookie stores a date string, which should be converted to a <code>Date</code> object upon retrieval; the third argument |
|
|
106 |
of <code>getSub()</code> is specified as a custom function that will convert the returned value into a <code>Date</code> object. |
|
|
107 |
The "count" subcookie contains a number and is converted to an actual JavaScript number by passing in the native |
|
|
108 |
<code>Number</code> function. If any of these subcookies don't exist, <code>getSub()</code> returns <code>null</code> (this should |
|
|
109 |
be the case the first time you run the example). The retrieved values are output in the logger.</p> |
|
|
110 |
<p>After that, new values are assigned to the various subcookies:</p> |
|
|
111 |
<div id="syntax2" class="yui-syntax-highlight"><div class="numbers"><pre class="javascript" style="font-family:monospace;"><ol><li class="li1"><div class="de1">Y.<span class="me1">Cookie</span>.<span class="me1">setSub</span><span class="br0">(</span><span class="st0">"example"</span><span class="sy0">,</span> <span class="st0">"name"</span><span class="sy0">,</span> <span class="st0">"Yahoo!"</span><span class="br0">)</span><span class="sy0">;</span></div></li><li class="li1"><div class="de1">Y.<span class="me1">Cookie</span>.<span class="me1">setSub</span><span class="br0">(</span><span class="st0">"example"</span><span class="sy0">,</span> <span class="st0">"today"</span><span class="sy0">,</span> <span class="br0">(</span><span class="kw2">new</span> Date<span class="br0">(</span><span class="br0">)</span><span class="br0">)</span>.<span class="me1">toString</span><span class="br0">(</span><span class="br0">)</span><span class="br0">)</span><span class="sy0">;</span></div></li><li class="li1"><div class="de1">Y.<span class="me1">Cookie</span>.<span class="me1">setSub</span><span class="br0">(</span><span class="st0">"example"</span><span class="sy0">,</span> <span class="st0">"count"</span><span class="sy0">,</span> Math.<span class="me1">round</span><span class="br0">(</span>Math.<span class="me1">random</span><span class="br0">(</span><span class="br0">)</span> <span class="sy0">*</span> <span class="nu0">30</span><span class="br0">)</span><span class="br0">)</span><span class="sy0">;</span></div></li></ol></pre></div><div class="nonumbers"><pre class="javascript" style="font-family:monospace;">Y.<span class="me1">Cookie</span>.<span class="me1">setSub</span><span class="br0">(</span><span class="st0">"example"</span><span class="sy0">,</span> <span class="st0">"name"</span><span class="sy0">,</span> <span class="st0">"Yahoo!"</span><span class="br0">)</span><span class="sy0">;</span> |
|
|
112 |
Y.<span class="me1">Cookie</span>.<span class="me1">setSub</span><span class="br0">(</span><span class="st0">"example"</span><span class="sy0">,</span> <span class="st0">"today"</span><span class="sy0">,</span> <span class="br0">(</span><span class="kw2">new</span> Date<span class="br0">(</span><span class="br0">)</span><span class="br0">)</span>.<span class="me1">toString</span><span class="br0">(</span><span class="br0">)</span><span class="br0">)</span><span class="sy0">;</span> |
|
|
113 |
Y.<span class="me1">Cookie</span>.<span class="me1">setSub</span><span class="br0">(</span><span class="st0">"example"</span><span class="sy0">,</span> <span class="st0">"count"</span><span class="sy0">,</span> Math.<span class="me1">round</span><span class="br0">(</span>Math.<span class="me1">random</span><span class="br0">(</span><span class="br0">)</span> <span class="sy0">*</span> <span class="nu0">30</span><span class="br0">)</span><span class="br0">)</span><span class="sy0">;</span></pre></div><textarea id="syntax2-plain">Y.Cookie.setSub("example", "name", "Yahoo!"); |
|
|
114 |
Y.Cookie.setSub("example", "today", (new Date()).toString()); |
|
|
115 |
Y.Cookie.setSub("example", "count", Math.round(Math.random() * 30));</textarea></div><p>The "name" subcookie is set to "Yahoo!", the "today" subcookie is set to the value |
|
|
116 |
of a new <code>Date</code> object, outputting its string representation, and the "count" subcookie is filled |
|
|
117 |
with a random number. The next time you run the example, the subcookies should have these values.</p> </div> |
|
|
118 |
<div class="yui-u sidebar"> |
|
|
119 |
|
|
|
120 |
|
|
|
121 |
<div id="examples" class="mod box4"> |
|
|
122 |
<div class="hd"> |
|
|
123 |
<h4> |
|
|
124 |
Cookie Examples:</h4> |
|
|
125 |
</div> |
|
|
126 |
<div class="bd"> |
|
|
127 |
<ul> |
|
|
128 |
<li><a href='../cookie/cookie-simple-example.html'>Simple Cookie Example</a></li><li><a href='../cookie/cookie-advanced-example.html'>Advanced Cookie Example</a></li><li class='selected'><a href='../cookie/cookie-subcookie-example.html'>Subcookie Example</a></li> </ul> |
|
|
129 |
</div> |
|
|
130 |
</div> |
|
|
131 |
|
|
|
132 |
<div class="mod box4"> |
|
|
133 |
<div class="hd"> |
|
|
134 |
<h4>More Cookie Resources:</h4> |
|
|
135 |
</div> |
|
|
136 |
<div class="bd"> |
|
|
137 |
<ul> |
|
|
138 |
<!-- <li><a href="http://developer.yahoo.com/yui/cookie/">User's Guide</a> (external)</li> --> |
|
|
139 |
<li><a href="../../api/module_cookie.html">API Documentation</a></li></ul> |
|
|
140 |
</div> |
|
|
141 |
</div> |
|
|
142 |
</div> |
|
|
143 |
</div> |
|
|
144 |
|
|
|
145 |
</div> |
|
|
146 |
</div> |
|
|
147 |
|
|
|
148 |
|
|
|
149 |
<div class="yui-b toc3" id="tocWrapper"> |
|
|
150 |
<!-- TABLE OF CONTENTS --> |
|
|
151 |
<div id="toc"> |
|
|
152 |
|
|
|
153 |
<ul> |
|
|
154 |
<li class="sect first">YUI 3 Resources</li><li class="item"><a title="YUI 3 -- Yahoo! User Interface (YUI) Library" href="http://developer.yahoo.com/yui/3/">YUI 3 Web Site</a></li><li class="item"><a title="Examples of every YUI utility and control in action" href="../../examples/">YUI 3 Examples</a></li><li class="item"><a title="Instantly searchable API documentation for the entire YUI library." href="../../api/">YUI 3 API Docs</a></li><li class="item"><a title="YUI 3 Dependency Configurator -- configure your custom YUI implementation" href="http://developer.yahoo.com/yui/3/configurator">YUI 3 Dependency Configurator</a></li><li class="item"><a title="The YUI 3 Forum on YUILibrary.com" href="http://yuilibrary.com/forum/viewforum.php?f=15">YUI 3 Forums (external)</a></li><li class="item"><a title="Found a bug or a missing feature? Let us know on YUILibrary.com." href="http://developer.yahoo.com/yui/articles/reportingbugs/">Bug Reports/Feature Requests</a></li><li class="item"><a title="YUI is free and open, offered under a BSD license." href="http://developer.yahoo.com/yui/license.html">YUI License</a></li><li class="item"><a title="Download and fork the YUI project on GitHub" href="http://github.com/yui">YUI on Github</a></li><li class="item"><a title="The Yahoo! User Interface Blog" href="http://yuiblog.com">YUI Blog (external)</a></li><li class="sect">YUI 3 Core - Examples</li><li class="item"><a title="YUI Global Object - Functional Examples" href="../../examples/yui/index.html">YUI Global Object</a></li><li class="item"><a title="Event - Functional Examples" href="../../examples/event/index.html">Event</a></li><li class="item"><a title="Node - Functional Examples" href="../../examples/node/index.html">Node</a></li><li class="sect">YUI 3 Component Infrastructure - Examples</li><li class="item"><a title="Attribute - Functional Examples" href="../../examples/attribute/index.html">Attribute</a></li><li class="item"><a title="Plugin - Functional Examples" href="../../examples/plugin/index.html">Plugin <img src='http://l.yimg.com/a/i/not/beta_1.gif'></a></li><li class="item"><a title="Widget - Functional Examples" href="../../examples/widget/index.html">Widget <img src='http://l.yimg.com/a/i/not/beta_1.gif'></a></li><li class="sect">YUI 3 Utilities - Examples</li><li class="item"><a title="Animation - Functional Examples" href="../../examples/anim/index.html">Animation</a></li><li class="item"><a title="AsyncQueue - Functional Examples" href="../../examples/async-queue/index.html">AsyncQueue</a></li><li class="item"><a title="Browser History - Functional Examples" href="../../examples/history/index.html">Browser History</a></li><li class="item"><a title="Cache - Functional Examples" href="../../examples/cache/index.html">Cache</a></li><li class="selected "><a title="Cookie - Functional Examples" href="../../examples/cookie/index.html">Cookie</a></li><li class="item"><a title="DataSchema - Functional Examples" href="../../examples/dataschema/index.html">DataSchema <img src='http://l.yimg.com/a/i/not/beta_1.gif'></a></li><li class="item"><a title="DataSource - Functional Examples" href="../../examples/datasource/index.html">DataSource <img src='http://l.yimg.com/a/i/not/beta_1.gif'></a></li><li class="item"><a title="DataType - Functional Examples" href="../../examples/datatype/index.html">DataType <img src='http://l.yimg.com/a/i/not/beta_1.gif'></a></li><li class="item"><a title="Drag & Drop - Functional Examples" href="../../examples/dd/index.html">Drag & Drop</a></li><li class="item"><a title="Get - Functional Examples" href="../../examples/get/index.html">Get</a></li><li class="item"><a title="ImageLoader - Functional Examples" href="../../examples/imageloader/index.html">ImageLoader</a></li><li class="item"><a title="IO - Functional Examples" href="../../examples/io/index.html">IO</a></li><li class="item"><a title="JSON (JavaScript Object Notation) - Functional Examples" href="../../examples/json/index.html">JSON</a></li><li class="item"><a title="Stylesheet - Functional Examples" href="../../examples/stylesheet/index.html">Stylesheet</a></li><li class="sect">YUI 3 Widgets - Examples</li><li class="item"><a title="Overlay - Functional Examples" href="../../examples/overlay/index.html">Overlay <img src='http://l.yimg.com/a/i/not/beta_1.gif'></a></li><li class="item"><a title="Slider - Functional Examples" href="../../examples/slider/index.html">Slider <img src='http://l.yimg.com/a/i/not/beta_1.gif'></a></li><li class="sect">YUI 3 Node Plugins - Examples</li><li class="item"><a title="FocusManager Node Plugin - Functional Examples" href="../../examples/node-focusmanager/index.html">FocusManager Node Plugin <img src='http://l.yimg.com/a/i/not/beta_1.gif'></a></li><li class="item"><a title="MenuNav Node Plugin - Functional Examples" href="../../examples/node-menunav/index.html">MenuNav Node Plugin <img src='http://l.yimg.com/a/i/not/beta_1.gif'></a></li><li class="sect">YUI 3 CSS - Examples</li><li class="item"><a title="YUI CSS Reset - Functional Examples" href="../../examples/cssreset/index.html">CSS Reset</a></li><li class="item"><a title="YUI Fonts - Functional Examples" href="../../examples/cssfonts/index.html">CSS Fonts</a></li><li class="item"><a title="YUI Base - Functional Examples" href="../../examples/cssbase/index.html">CSS Base</a></li><li class="sect">YUI 3 Developer Tools - Examples</li><li class="item"><a title="Console - Functional Examples" href="../../examples/console/index.html">Console <img src='http://l.yimg.com/a/i/not/beta_1.gif'></a></li><li class="item"><a title="Console Filters Plugin- Functional Examples" href="../../examples/console-filters/index.html">Plugin.ConsoleFilters <img src='http://l.yimg.com/a/i/not/beta_1.gif'></a></li><li class="item"><a title="Profiler - Functional Examples" href="../../examples/profiler/index.html">Profiler</a></li><li class="item"><a title="Test - Functional Examples" href="../../examples/test/index.html">Test</a></li><li class="sect">Other Useful YUI 3 Resources</li><li class="item"><a title="Answers to Frequently Asked Questions about the YUI Library" href="http://developer.yahoo.com/yui/articles/faq/">YUI FAQ (external)</a></li><li class="item"><a title="Yahoo!'s philosophy of Graded Browser Support" href="http://developer.yahoo.com/yui/articles/gbs/">Graded Browser Support (external)</a></li><li class="item"><a title="Videos and podcasts from the YUI Team and from the Yahoo! frontend engineering community." href="http://developer.yahoo.com/yui/theater/">YUI Theater (external)</a></li></ul> |
|
|
155 |
</div> |
|
|
156 |
</div> |
|
|
157 |
</div><!--closes bd--> |
|
|
158 |
|
|
|
159 |
<div id="ft"> |
|
|
160 |
<p class="first">Copyright © 2009 Yahoo! Inc. All rights reserved.</p> |
|
|
161 |
<p><a href="http://privacy.yahoo.com/privacy/us/devel/index.html">Privacy Policy</a> - |
|
|
162 |
<a href="http://docs.yahoo.com/info/terms/">Terms of Service</a> - |
|
|
163 |
<a href="http://docs.yahoo.com/info/copyright/copyright.html">Copyright Policy</a> - |
|
|
164 |
<a href="http://careers.yahoo.com/">Job Openings</a></p> |
|
|
165 |
</div> |
|
|
166 |
</div> |
|
|
167 |
<script language="javascript"> |
|
|
168 |
var yuiConfig = {base:"../../build/", timeout: 10000}; |
|
|
169 |
</script> |
|
|
170 |
<script src="../../assets/syntax.js"></script> |
|
|
171 |
<script src="../../assets/dpSyntaxHighlighter.js"></script> |
|
|
172 |
<script language="javascript"> |
|
|
173 |
dp.SyntaxHighlighter.HighlightAll('code'); |
|
|
174 |
</script> |
|
|
175 |
</body> |
|
|
176 |
</html> |