|
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: substitute substitute.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>substitute <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_substitute.html" title="substitute">substitute</a> |
|
22 |
|
23 > substitute.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"> * String variable substitution and string formatting.</span> |
|
52 <span class="c"> * If included, the substitute method is added to the YUI instance.</span> |
|
53 <span class="c"> *</span> |
|
54 <span class="c"> * @module substitute</span> |
|
55 <span class="c"> */</span> |
|
56 |
|
57 <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> <span class="nx">DUMP</span><span class="o">=</span><span class="s1">'dump'</span><span class="o">,</span> <span class="nx">SPACE</span><span class="o">=</span><span class="s1">' '</span><span class="o">,</span> <span class="nx">LBRACE</span><span class="o">=</span><span class="s1">'{'</span><span class="o">,</span> <span class="nx">RBRACE</span><span class="o">=</span><span class="s1">'}'</span><span class="o">,</span> |
|
58 |
|
59 <span class="c">/**</span> |
|
60 <span class="c"> * The following methods are added to the YUI instance</span> |
|
61 <span class="c"> * @class YUI~substitute</span> |
|
62 <span class="c"> */</span> |
|
63 |
|
64 <span class="c">// @todo template configurability is not implemented yet</span> |
|
65 <span class="c"></span> <span class="c">// @param ldelim {string} optional left delimiter for the replacement token (default: left brace)</span> |
|
66 <span class="c"></span> <span class="c">// @param rdelim {string} optional right delimiter for the replacement token (default: right brace)</span> |
|
67 <span class="c"></span> |
|
68 <span class="c">/**</span> |
|
69 <span class="c"> * Does variable substitution on a string. It scans through the string </span> |
|
70 <span class="c"> * looking for expressions enclosed in { } braces. If an expression </span> |
|
71 <span class="c"> * is found, it is used a key on the object. If there is a space in</span> |
|
72 <span class="c"> * the key, the first word is used for the key and the rest is provided</span> |
|
73 <span class="c"> * to an optional function to be used to programatically determine the</span> |
|
74 <span class="c"> * value (the extra information might be used for this decision). If </span> |
|
75 <span class="c"> * the value for the key in the object, or what is returned from the</span> |
|
76 <span class="c"> * function has a string value, number value, or object value, it is </span> |
|
77 <span class="c"> * substituted for the bracket expression and it repeats. If this</span> |
|
78 <span class="c"> * value is an object, it uses the Object's toString() if this has</span> |
|
79 <span class="c"> * been overridden, otherwise it does a shallow dump of the key/value</span> |
|
80 <span class="c"> * pairs if Y.dump is available (if dump isn't available, toString()</span> |
|
81 <span class="c"> * is used).</span> |
|
82 <span class="c"> *</span> |
|
83 <span class="c"> * This method is included in the 'substitute' module. It is not included</span> |
|
84 <span class="c"> * in the YUI module.</span> |
|
85 <span class="c"> *</span> |
|
86 <span class="c"> * @method substitute</span> |
|
87 <span class="c"> * @param s {string} The string that will be modified.</span> |
|
88 <span class="c"> * @param o An object containing the replacement values</span> |
|
89 <span class="c"> * @param f {function} An optional function that can be used to</span> |
|
90 <span class="c"> * process each match. It receives the key,</span> |
|
91 <span class="c"> * value, and any extra metadata included with</span> |
|
92 <span class="c"> * the key inside of the braces.</span> |
|
93 <span class="c"> * @return {string} the substituted string</span> |
|
94 <span class="c"> */</span> |
|
95 |
|
96 <span class="nx">substitute</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="nx">o</span><span class="o">,</span> <span class="nx">f</span><span class="o">,</span> <span class="nx">ldelim</span><span class="o">,</span> <span class="nx">rdelim</span><span class="o">)</span> <span class="o">{</span> |
|
97 <span class="k">var</span> <span class="nx">i</span><span class="o">,</span> <span class="nx">j</span><span class="o">,</span> <span class="nx">k</span><span class="o">,</span> <span class="nx">key</span><span class="o">,</span> <span class="nx">v</span><span class="o">,</span> <span class="nx">meta</span><span class="o">,</span> <span class="nx">saved</span><span class="o">=[],</span> <span class="nx">token</span><span class="o">,</span> <span class="nx">dump</span><span class="o">;</span> |
|
98 <span class="nx">ldelim</span> <span class="o">=</span> <span class="nx">ldelim</span> <span class="o">||</span> <span class="nx">LBRACE</span><span class="o">;</span> |
|
99 <span class="nx">rdelim</span> <span class="o">=</span> <span class="nx">rdelim</span> <span class="o">||</span> <span class="nx">RBRACE</span><span class="o">;</span> |
|
100 |
|
101 <span class="k">for</span> <span class="o">(;;)</span> <span class="o">{</span> |
|
102 <span class="nx">i</span> <span class="o">=</span> <span class="nx">s</span><span class="o">.</span><span class="nx">lastIndexOf</span><span class="o">(</span><span class="nx">ldelim</span><span class="o">);</span> |
|
103 <span class="k">if</span> <span class="o">(</span><span class="nx">i</span> <span class="o"><</span> <span class="m">0</span><span class="o">)</span> <span class="o">{</span> |
|
104 <span class="k">break</span><span class="o">;</span> |
|
105 <span class="o">}</span> |
|
106 <span class="nx">j</span> <span class="o">=</span> <span class="nx">s</span><span class="o">.</span><span class="nx">indexOf</span><span class="o">(</span><span class="nx">rdelim</span><span class="o">,</span> <span class="nx">i</span><span class="o">);</span> |
|
107 <span class="k">if</span> <span class="o">(</span><span class="nx">i</span> <span class="o">+</span> <span class="m">1</span> <span class="o">>=</span> <span class="nx">j</span><span class="o">)</span> <span class="o">{</span> |
|
108 <span class="k">break</span><span class="o">;</span> |
|
109 <span class="o">}</span> |
|
110 |
|
111 <span class="c">//Extract key and meta info </span> |
|
112 <span class="c"></span> <span class="nx">token</span> <span class="o">=</span> <span class="nx">s</span><span class="o">.</span><span class="nx">substring</span><span class="o">(</span><span class="nx">i</span> <span class="o">+</span> <span class="m">1</span><span class="o">,</span> <span class="nx">j</span><span class="o">);</span> |
|
113 <span class="nx">key</span> <span class="o">=</span> <span class="nx">token</span><span class="o">;</span> |
|
114 <span class="nx">meta</span> <span class="o">=</span> <span class="kc">null</span><span class="o">;</span> |
|
115 <span class="nx">k</span> <span class="o">=</span> <span class="nx">key</span><span class="o">.</span><span class="nx">indexOf</span><span class="o">(</span><span class="nx">SPACE</span><span class="o">);</span> |
|
116 <span class="k">if</span> <span class="o">(</span><span class="nx">k</span> <span class="o">></span> <span class="o">-</span><span class="m">1</span><span class="o">)</span> <span class="o">{</span> |
|
117 <span class="nx">meta</span> <span class="o">=</span> <span class="nx">key</span><span class="o">.</span><span class="nx">substring</span><span class="o">(</span><span class="nx">k</span> <span class="o">+</span> <span class="m">1</span><span class="o">);</span> |
|
118 <span class="nx">key</span> <span class="o">=</span> <span class="nx">key</span><span class="o">.</span><span class="nx">substring</span><span class="o">(</span><span class="m">0</span><span class="o">,</span> <span class="nx">k</span><span class="o">);</span> |
|
119 <span class="o">}</span> |
|
120 |
|
121 <span class="c">// lookup the value</span> |
|
122 <span class="c"></span> <span class="nx">v</span> <span class="o">=</span> <span class="nx">o</span><span class="o">[</span><span class="nx">key</span><span class="o">];</span> |
|
123 |
|
124 <span class="c">// if a substitution function was provided, execute it</span> |
|
125 <span class="c"></span> <span class="k">if</span> <span class="o">(</span><span class="nx">f</span><span class="o">)</span> <span class="o">{</span> |
|
126 <span class="nx">v</span> <span class="o">=</span> <span class="nx">f</span><span class="o">(</span><span class="nx">key</span><span class="o">,</span> <span class="nx">v</span><span class="o">,</span> <span class="nx">meta</span><span class="o">);</span> |
|
127 <span class="o">}</span> |
|
128 |
|
129 <span class="k">if</span> <span class="o">(</span><span class="nx">L</span><span class="o">.</span><span class="nx">isObject</span><span class="o">(</span><span class="nx">v</span><span class="o">))</span> <span class="o">{</span> |
|
130 <span class="k">if</span> <span class="o">(!</span><span class="nx">Y</span><span class="o">.</span><span class="nx">dump</span><span class="o">)</span> <span class="o">{</span> |
|
131 <span class="nx">v</span> <span class="o">=</span> <span class="nx">v</span><span class="o">.</span><span class="nx">toString</span><span class="o">();</span> |
|
132 <span class="o">}</span> <span class="k">else</span> <span class="o">{</span> |
|
133 <span class="k">if</span> <span class="o">(</span><span class="nx">L</span><span class="o">.</span><span class="nx">isArray</span><span class="o">(</span><span class="nx">v</span><span class="o">))</span> <span class="o">{</span> |
|
134 <span class="nx">v</span> <span class="o">=</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">dump</span><span class="o">(</span><span class="nx">v</span><span class="o">,</span> <span class="nb">parseInt</span><span class="o">(</span><span class="nx">meta</span><span class="o">,</span> <span class="m">10</span><span class="o">));</span> |
|
135 <span class="o">}</span> <span class="k">else</span> <span class="o">{</span> |
|
136 <span class="nx">meta</span> <span class="o">=</span> <span class="nx">meta</span> <span class="o">||</span> <span class="s2">""</span><span class="o">;</span> |
|
137 |
|
138 <span class="c">// look for the keyword 'dump', if found force obj dump</span> |
|
139 <span class="c"></span> <span class="nx">dump</span> <span class="o">=</span> <span class="nx">meta</span><span class="o">.</span><span class="nx">indexOf</span><span class="o">(</span><span class="nx">DUMP</span><span class="o">);</span> |
|
140 <span class="k">if</span> <span class="o">(</span><span class="nx">dump</span> <span class="o">></span> <span class="o">-</span><span class="m">1</span><span class="o">)</span> <span class="o">{</span> |
|
141 <span class="nx">meta</span> <span class="o">=</span> <span class="nx">meta</span><span class="o">.</span><span class="nx">substring</span><span class="o">(</span><span class="m">4</span><span class="o">);</span> |
|
142 <span class="o">}</span> |
|
143 |
|
144 <span class="c">// use the toString if it is not the Object toString </span> |
|
145 <span class="c"></span> <span class="c">// and the 'dump' meta info was not found</span> |
|
146 <span class="c"></span> <span class="k">if</span> <span class="o">(</span><span class="nx">v</span><span class="o">.</span><span class="nx">toString</span><span class="o">===</span><span class="nb">Object</span><span class="o">.</span><span class="nx">prototype</span><span class="o">.</span><span class="nx">toString</span><span class="o">||</span><span class="nx">dump</span><span class="o">>-</span><span class="m">1</span><span class="o">)</span> <span class="o">{</span> |
|
147 <span class="nx">v</span> <span class="o">=</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">dump</span><span class="o">(</span><span class="nx">v</span><span class="o">,</span> <span class="nb">parseInt</span><span class="o">(</span><span class="nx">meta</span><span class="o">,</span> <span class="m">10</span><span class="o">));</span> |
|
148 <span class="o">}</span> <span class="k">else</span> <span class="o">{</span> |
|
149 <span class="nx">v</span> <span class="o">=</span> <span class="nx">v</span><span class="o">.</span><span class="nx">toString</span><span class="o">();</span> |
|
150 <span class="o">}</span> |
|
151 <span class="o">}</span> |
|
152 <span class="o">}</span> |
|
153 <span class="o">}</span> <span class="k">else</span> <span class="k">if</span> <span class="o">(!</span><span class="nx">L</span><span class="o">.</span><span class="nx">isString</span><span class="o">(</span><span class="nx">v</span><span class="o">)</span> <span class="o">&&</span> <span class="o">!</span><span class="nx">L</span><span class="o">.</span><span class="nx">isNumber</span><span class="o">(</span><span class="nx">v</span><span class="o">))</span> <span class="o">{</span> |
|
154 <span class="c">// This {block} has no replace string. Save it for later.</span> |
|
155 <span class="c"></span> <span class="nx">v</span> <span class="o">=</span> <span class="s2">"~-"</span> <span class="o">+</span> <span class="nx">saved</span><span class="o">.</span><span class="nx">length</span> <span class="o">+</span> <span class="s2">"-~"</span><span class="o">;</span> |
|
156 <span class="nx">saved</span><span class="o">[</span><span class="nx">saved</span><span class="o">.</span><span class="nx">length</span><span class="o">]</span> <span class="o">=</span> <span class="nx">token</span><span class="o">;</span> |
|
157 |
|
158 <span class="c">// break;</span> |
|
159 <span class="c"></span> <span class="o">}</span> |
|
160 |
|
161 <span class="nx">s</span> <span class="o">=</span> <span class="nx">s</span><span class="o">.</span><span class="nx">substring</span><span class="o">(</span><span class="m">0</span><span class="o">,</span> <span class="nx">i</span><span class="o">)</span> <span class="o">+</span> <span class="nx">v</span> <span class="o">+</span> <span class="nx">s</span><span class="o">.</span><span class="nx">substring</span><span class="o">(</span><span class="nx">j</span> <span class="o">+</span> <span class="m">1</span><span class="o">);</span> |
|
162 |
|
163 <span class="o">}</span> |
|
164 |
|
165 <span class="c">// restore saved {block}s</span> |
|
166 <span class="c"></span> <span class="k">for</span> <span class="o">(</span><span class="nx">i</span><span class="o">=</span><span class="nx">saved</span><span class="o">.</span><span class="nx">length</span><span class="o">-</span><span class="m">1</span><span class="o">;</span> <span class="nx">i</span><span class="o">>=</span><span class="m">0</span><span class="o">;</span> <span class="nx">i</span><span class="o">=</span><span class="nx">i</span><span class="o">-</span><span class="m">1</span><span class="o">)</span> <span class="o">{</span> |
|
167 <span class="nx">s</span> <span class="o">=</span> <span class="nx">s</span><span class="o">.</span><span class="nx">replace</span><span class="o">(</span><span class="k">new</span> <span class="nb">RegExp</span><span class="o">(</span><span class="s2">"~-"</span> <span class="o">+</span> <span class="nx">i</span> <span class="o">+</span> <span class="s2">"-~"</span><span class="o">),</span> <span class="nx">ldelim</span> <span class="o">+</span> <span class="nx">saved</span><span class="o">[</span><span class="nx">i</span><span class="o">]</span> <span class="o">+</span> <span class="nx">rdelim</span><span class="o">,</span> <span class="s2">"g"</span><span class="o">);</span> |
|
168 <span class="o">}</span> |
|
169 |
|
170 <span class="k">return</span> <span class="nx">s</span><span class="o">;</span> |
|
171 |
|
172 <span class="o">};</span> |
|
173 |
|
174 <span class="nx">Y</span><span class="o">.</span><span class="nx">substitute</span> <span class="o">=</span> <span class="nx">substitute</span><span class="o">;</span> |
|
175 <span class="nx">L</span><span class="o">.</span><span class="nx">substitute</span> <span class="o">=</span> <span class="nx">substitute</span><span class="o">;</span> |
|
176 </pre></div> |
|
177 |
|
178 </div> |
|
179 </div> |
|
180 </div> |
|
181 <div class="yui-b"> |
|
182 <div class="nav"> |
|
183 |
|
184 <div id="moduleList" class="module"> |
|
185 <h4>Modules</h4> |
|
186 <ul class="content"> |
|
187 <li class=""><a href="module_anim.html" title="anim">anim</a></li> |
|
188 <li class=""><a href="module_async-queue.html" title="async-queue">async-queue</a></li> |
|
189 <li class=""><a href="module_attribute.html" title="attribute">attribute</a></li> |
|
190 <li class=""><a href="module_base.html" title="base">base</a></li> |
|
191 <li class=""><a href="module_cache.html" title="cache">cache</a></li> |
|
192 <li class=""><a href="module_classnamemanager.html" title="classnamemanager">classnamemanager</a></li> |
|
193 <li class=""><a href="module_collection.html" title="collection">collection</a></li> |
|
194 <li class=""><a href="module_console.html" title="console">console</a></li> |
|
195 <li class=""><a href="module_console-filters.html" title="console-filters">console-filters</a></li> |
|
196 <li class=""><a href="module_cookie.html" title="cookie">cookie</a></li> |
|
197 <li class=""><a href="module_dataschema.html" title="dataschema">dataschema</a></li> |
|
198 <li class=""><a href="module_datasource.html" title="datasource">datasource</a></li> |
|
199 <li class=""><a href="module_datatype.html" title="datatype">datatype</a></li> |
|
200 <li class=""><a href="module_dd.html" title="dd">dd</a></li> |
|
201 <li class=""><a href="module_dom.html" title="dom">dom</a></li> |
|
202 <li class=""><a href="module_dump.html" title="dump">dump</a></li> |
|
203 <li class=""><a href="module_event.html" title="event">event</a></li> |
|
204 <li class=""><a href="module_event-custom.html" title="event-custom">event-custom</a></li> |
|
205 <li class=""><a href="module_event-simulate.html" title="event-simulate">event-simulate</a></li> |
|
206 <li class=""><a href="module_history.html" title="history">history</a></li> |
|
207 <li class=""><a href="module_imageloader.html" title="imageloader">imageloader</a></li> |
|
208 <li class=""><a href="module_io.html" title="io">io</a></li> |
|
209 <li class=""><a href="module_json.html" title="json">json</a></li> |
|
210 <li class=""><a href="module_node.html" title="node">node</a></li> |
|
211 <li class=""><a href="module_node-focusmanager.html" title="node-focusmanager">node-focusmanager</a></li> |
|
212 <li class=""><a href="module_node-menunav.html" title="node-menunav">node-menunav</a></li> |
|
213 <li class=""><a href="module_oop.html" title="oop">oop</a></li> |
|
214 <li class=""><a href="module_overlay.html" title="overlay">overlay</a></li> |
|
215 <li class=""><a href="module_plugin.html" title="plugin">plugin</a></li> |
|
216 <li class=""><a href="module_profiler.html" title="profiler">profiler</a></li> |
|
217 <li class=""><a href="module_queue-promote.html" title="queue-promote">queue-promote</a></li> |
|
218 <li class=""><a href="module_slider.html" title="slider">slider</a></li> |
|
219 <li class=""><a href="module_stylesheet.html" title="stylesheet">stylesheet</a></li> |
|
220 <li class="selected"><a href="module_substitute.html" title="substitute">substitute</a></li> |
|
221 <li class=""><a href="module_test.html" title="test">test</a></li> |
|
222 <li class=""><a href="module_widget.html" title="widget">widget</a></li> |
|
223 <li class=""><a href="module_widget-position.html" title="widget-position">widget-position</a></li> |
|
224 <li class=""><a href="module_widget-position-ext.html" title="widget-position-ext">widget-position-ext</a></li> |
|
225 <li class=""><a href="module_widget-stack.html" title="widget-stack">widget-stack</a></li> |
|
226 <li class=""><a href="module_widget-stdmod.html" title="widget-stdmod">widget-stdmod</a></li> |
|
227 <li class=""><a href="module_yui.html" title="yui">yui</a></li> |
|
228 </ul> |
|
229 </div> |
|
230 |
|
231 <div id="classList" class="module"> |
|
232 <h4>Classes</h4> |
|
233 <ul class="content"> |
|
234 <li class=""><a href="YUI~substitute.html" title="YUI~substitute">YUI~substitute</a></li> |
|
235 </ul> |
|
236 </div> |
|
237 |
|
238 <div id="fileList" class="module"> |
|
239 <h4>Files</h4> |
|
240 <ul class="content"> |
|
241 <li class="selected"><a href="substitute.js.html" title="substitute.js">substitute.js</a></li> |
|
242 </ul> |
|
243 </div> |
|
244 |
|
245 |
|
246 |
|
247 |
|
248 |
|
249 </div> |
|
250 </div> |
|
251 </div> |
|
252 <div id="ft"> |
|
253 <hr /> |
|
254 Copyright © 2009 Yahoo! Inc. All rights reserved. |
|
255 </div> |
|
256 </div> |
|
257 <script type="text/javascript"> |
|
258 ALL_YUI_PROPS = [{"access": "", "host": "YUI~substitute", "name": "substitute", "url": "YUI~substitute.html#method_substitute", "type": "method"}]; |
|
259 </script> |
|
260 </body> |
|
261 </html> |