PageRenderTime 54ms CodeModel.GetById 25ms RepoModel.GetById 1ms app.codeStats 0ms

/docs/gem.http_accept_language-1.0.2/classes/HttpAcceptLanguage.html

https://github.com/toy/rb
HTML | 256 lines | 174 code | 82 blank | 0 comment | 0 complexity | e936a210907f2abb20ee035b1498844c MD5 | raw file
    

  1. <?xml version="1.0" encoding="utf-8"?>
    2. 

  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    3. 

  3.     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    4. 

  4. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
    5. 

  5. <head>
    6. 

  6.     <title>HttpAcceptLanguage</title>
    7. 

  7.     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    8. 

  8.     <link rel="stylesheet" href="../css/reset.css" type="text/css" media="screen" />
    9. 

  9.     <link rel="stylesheet" href="../css/main.css" type="text/css" media="screen" />
    10. 

  10.     <script src="../js/jquery-1.3.2.min.js" type="text/javascript" charset="utf-8"></script>
    11. 

  11.     <script src="../js/jquery-effect.js" type="text/javascript" charset="utf-8"></script>
    12. 

  12.     <script src="../js/main.js" type="text/javascript" charset="utf-8"></script>
    13. 

  13. </head>
    14. 

  14. 

  15. <body>     
    16. 

  16.     <div class="banner">
    17. 

  17.         <h1>
    18. 

  18.             <span class="type">Module</span> 
    19. 

  19.             HttpAcceptLanguage 
    20. 

  20.             
    21. 

  21.         </h1>
    22. 

  22.         <ul class="files">
    23. 

  23.             
    24. 

  24.             <li><a href="../files/lib/http_accept_language_rb.html">lib/http_accept_language.rb</a></li>
    25. 

  25.             
    26. 

  26.         </ul>
    27. 

  27.     </div>
    28. 

  28.     <div id="bodyContent">
    29. 

  29.         <div id="content">
    30. 

  30.     
    31. 

  31. 

  32.     
    33. 

  33. 

  34.     
    35. 

  35.     
    36. 

  36. 

  37.     
    38. 

  38.     
    39. 

  39.     <div class="sectiontitle">Methods</div>
    40. 

  40.     <dl class="methods">
    41. 

  41.     
    42. 

  42.         <dt>C</dt>
    43. 

  43.         <dd>
    44. 

  44.             <ul>
    45. 

  45.                 
    46. 

  46.                 <li><a href="#M000003">compatible_language_from</a></li>
    47. 

  47.                 
    48. 

  48.             </ul>
    49. 

  49.         </dd>
    50. 

  50.     
    51. 

  51.         <dt>P</dt>
    52. 

  52.         <dd>
    53. 

  53.             <ul>
    54. 

  54.                 
    55. 

  55.                 <li><a href="#M000002">preferred_language_from</a></li>
    56. 

  56.                 
    57. 

  57.             </ul>
    58. 

  58.         </dd>
    59. 

  59.     
    60. 

  60.         <dt>U</dt>
    61. 

  61.         <dd>
    62. 

  62.             <ul>
    63. 

  63.                 
    64. 

  64.                 <li><a href="#M000000">user_preferred_languages</a>,</li>
    65. 

  65.                 
    66. 

  66.                 <li><a href="#M000001">user_preferred_languages=</a></li>
    67. 

  67.                 
    68. 

  68.             </ul>
    69. 

  69.         </dd>
    70. 

  70.     
    71. 

  71.     </dl>
    72. 

  72.     
    73. 

  73. 

  74.     
    75. 

  75. 

  76.     
    77. 

  77. 

  78.     
    79. 

  79. 

  80.     
    81. 

  81. 

  82.     
    83. 

  83. 

  84.     
    85. 

  85.             <div class="sectiontitle">Instance Public methods</div>
    86. 

  86.             
    87. 

  87.             <div class="method">
    88. 

  88.                 <div class="title" id="M000003">
    89. 

  89.                     
    90. 

  90.                     <a name="M000003"></a><b>compatible_language_from</b>(available_languages)
    91. 

  91.                     
    92. 

  92.                 </div>
    93. 

  93.                 
    94. 

  94.                 <div class="description">
    95. 

  95.                   <p>
    96. 

  96. Returns the first of the <a
    97. 

  97. href="HttpAcceptLanguage.html#M000000">user_preferred_languages</a> that is
    98. 

  98. compatible with the available locales. Ignores region.
    99. 

  99. </p>
    100. 

  100. <p>
    101. 

  101. Example:
    102. 

  102. </p>
    103. 

  103. <pre>
    104. 

  104.   request.compatible_language_from I18n.available_locales
    105. 

  105. </pre>
    106. 

  106. 

  107.                 </div>
    108. 

  108.                 
    109. 

  109.                 
    110. 

  110.                 
    111. 

  111.                 
    112. 

  112.                 <div class="sourcecode">
    113. 

  113.                     <p class="source-link">
    114. 

  114.                         Source: <a href="javascript:toggleSource('M000003_source')" id="l_M000003_source">show</a>
    115. 

  115.                         
    116. 

  116.                     </p>
    117. 

  117.                     <div id="M000003_source" class="dyn-source">
    118. 

  118.                         <pre>    <span class="ruby-comment cmt"># File lib/http_accept_language.rb, line 49</span>
    119. 

  119. 49:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">compatible_language_from</span>(<span class="ruby-identifier">available_languages</span>)
    120. 

  120. 50:     <span class="ruby-identifier">user_preferred_languages</span>.<span class="ruby-identifier">map</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">x</span><span class="ruby-operator">|</span> <span class="ruby-comment cmt">#en-US</span>
    121. 

  121. 51:       <span class="ruby-identifier">available_languages</span>.<span class="ruby-identifier">find</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">y</span><span class="ruby-operator">|</span> <span class="ruby-comment cmt"># en</span>
    122. 

  122. 52:         <span class="ruby-identifier">y</span> = <span class="ruby-identifier">y</span>.<span class="ruby-identifier">to_s</span>
    123. 

  123. 53:         <span class="ruby-identifier">x</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">y</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">x</span>.<span class="ruby-identifier">split</span>(<span class="ruby-value str">'-'</span>, <span class="ruby-value">2</span>).<span class="ruby-identifier">first</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">y</span>.<span class="ruby-identifier">split</span>(<span class="ruby-value str">'-'</span>, <span class="ruby-value">2</span>).<span class="ruby-identifier">first</span>
    124. 

  124. 54:       <span class="ruby-keyword kw">end</span>
    125. 

  125. 55:     <span class="ruby-keyword kw">end</span>.<span class="ruby-identifier">compact</span>.<span class="ruby-identifier">first</span>
    126. 

  126. 56:   <span class="ruby-keyword kw">end</span></pre>
    127. 

  127.                     </div>
    128. 

  128.                 </div>
    129. 

  129.                 
    130. 

  130.             </div>
    131. 

  131.             
    132. 

  132.             <div class="method">
    133. 

  133.                 <div class="title" id="M000002">
    134. 

  134.                     
    135. 

  135.                     <a name="M000002"></a><b>preferred_language_from</b>(array)
    136. 

  136.                     
    137. 

  137.                 </div>
    138. 

  138.                 
    139. 

  139.                 <div class="description">
    140. 

  140.                   <p>
    141. 

  141. Finds the locale specifically requested by the browser.
    142. 

  142. </p>
    143. 

  143. <p>
    144. 

  144. Example:
    145. 

  145. </p>
    146. 

  146. <pre>
    147. 

  147.   request.preferred_language_from I18n.available_locales
    148. 

  148.   # =&gt; 'nl'
    149. 

  149. </pre>
    150. 

  150. 

  151.                 </div>
    152. 

  152.                 
    153. 

  153.                 
    154. 

  154.                 
    155. 

  155.                 
    156. 

  156.                 <div class="sourcecode">
    157. 

  157.                     <p class="source-link">
    158. 

  158.                         Source: <a href="javascript:toggleSource('M000002_source')" id="l_M000002_source">show</a>
    159. 

  159.                         
    160. 

  160.                     </p>
    161. 

  161.                     <div id="M000002_source" class="dyn-source">
    162. 

  162.                         <pre>    <span class="ruby-comment cmt"># File lib/http_accept_language.rb, line 38</span>
    163. 

  163. 38:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">preferred_language_from</span>(<span class="ruby-identifier">array</span>)
    164. 

  164. 39:     (<span class="ruby-identifier">user_preferred_languages</span> <span class="ruby-operator">&amp;</span> <span class="ruby-identifier">array</span>.<span class="ruby-identifier">collect</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">i</span><span class="ruby-operator">|</span> <span class="ruby-identifier">i</span>.<span class="ruby-identifier">to_s</span> }).<span class="ruby-identifier">first</span>
    165. 

  165. 40:   <span class="ruby-keyword kw">end</span></pre>
    166. 

  166.                     </div>
    167. 

  167.                 </div>
    168. 

  168.                 
    169. 

  169.             </div>
    170. 

  170.             
    171. 

  171.             <div class="method">
    172. 

  172.                 <div class="title" id="M000000">
    173. 

  173.                     
    174. 

  174.                     <a name="M000000"></a><b>user_preferred_languages</b>()
    175. 

  175.                     
    176. 

  176.                 </div>
    177. 

  177.                 
    178. 

  178.                 <div class="description">
    179. 

  179.                   <p>
    180. 

  180. Returns a sorted array based on user preference in HTTP_ACCEPT_LANGUAGE.
    181. 

  181. Browsers send this HTTP header, so don&#8217;t think this is holy.
    182. 

  182. </p>
    183. 

  183. <p>
    184. 

  184. Example:
    185. 

  185. </p>
    186. 

  186. <pre>
    187. 

  187.   request.user_preferred_languages
    188. 

  188.   # =&gt; [ 'nl-NL', 'nl-BE', 'nl', 'en-US', 'en' ]
    189. 

  189. </pre>
    190. 

  190. 

  191.                 </div>
    192. 

  192.                 
    193. 

  193.                 
    194. 

  194.                 
    195. 

  195.                 
    196. 

  196.                 <div class="sourcecode">
    197. 

  197.                     <p class="source-link">
    198. 

  198.                         Source: <a href="javascript:toggleSource('M000000_source')" id="l_M000000_source">show</a>
    199. 

  199.                         
    200. 

  200.                     </p>
    201. 

  201.                     <div id="M000000_source" class="dyn-source">
    202. 

  202.                         <pre>    <span class="ruby-comment cmt"># File lib/http_accept_language.rb, line 11</span>
    203. 

  203. 11:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">user_preferred_languages</span>
    204. 

  204. 12:     <span class="ruby-ivar">@user_preferred_languages</span> <span class="ruby-operator">||=</span> <span class="ruby-identifier">env</span>[<span class="ruby-value str">'HTTP_ACCEPT_LANGUAGE'</span>].<span class="ruby-identifier">split</span>(<span class="ruby-regexp re">/\s*,\s*/</span>).<span class="ruby-identifier">collect</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">l</span><span class="ruby-operator">|</span>
    205. 

  205. 13:       <span class="ruby-identifier">l</span> <span class="ruby-operator">+=</span> <span class="ruby-value str">';q=1.0'</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">l</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/;q=\d+\.\d+$/</span>
    206. 

  206. 14:       <span class="ruby-identifier">l</span>.<span class="ruby-identifier">split</span>(<span class="ruby-value str">';q='</span>)
    207. 

  207. 15:     <span class="ruby-keyword kw">end</span>.<span class="ruby-identifier">sort</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">x</span>,<span class="ruby-identifier">y</span><span class="ruby-operator">|</span>
    208. 

  208. 16:       <span class="ruby-identifier">raise</span> <span class="ruby-value str">&quot;Not correctly formatted&quot;</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">x</span>.<span class="ruby-identifier">first</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/^[a-z\-]+$/i</span>
    209. 

  209. 17:       <span class="ruby-identifier">y</span>.<span class="ruby-identifier">last</span>.<span class="ruby-identifier">to_f</span> <span class="ruby-operator">&lt;=&gt;</span> <span class="ruby-identifier">x</span>.<span class="ruby-identifier">last</span>.<span class="ruby-identifier">to_f</span>
    210. 

  210. 18:     <span class="ruby-keyword kw">end</span>.<span class="ruby-identifier">collect</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">l</span><span class="ruby-operator">|</span>
    211. 

  211. 19:       <span class="ruby-identifier">l</span>.<span class="ruby-identifier">first</span>.<span class="ruby-identifier">downcase</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp re">/-[a-z]+$/i</span>) { <span class="ruby-operator">|</span><span class="ruby-identifier">x</span><span class="ruby-operator">|</span> <span class="ruby-identifier">x</span>.<span class="ruby-identifier">upcase</span> }
    212. 

  212. 20:     <span class="ruby-keyword kw">end</span>
    213. 

  213. 21:   <span class="ruby-keyword kw">rescue</span> <span class="ruby-comment cmt"># Just rescue anything if the browser messed up badly.</span>
    214. 

  214. 22:     []
    215. 

  215. 23:   <span class="ruby-keyword kw">end</span></pre>
    216. 

  216.                     </div>
    217. 

  217.                 </div>
    218. 

  218.                 
    219. 

  219.             </div>
    220. 

  220.             
    221. 

  221.             <div class="method">
    222. 

  222.                 <div class="title" id="M000001">
    223. 

  223.                     
    224. 

  224.                     <a name="M000001"></a><b>user_preferred_languages=</b>(languages)
    225. 

  225.                     
    226. 

  226.                 </div>
    227. 

  227.                 
    228. 

  228.                 <div class="description">
    229. 

  229.                   <p>
    230. 

  230. Sets the user languages preference, overiding the browser
    231. 

  231. </p>
    232. 

  232. 

  233.                 </div>
    234. 

  234.                 
    235. 

  235.                 
    236. 

  236.                 
    237. 

  237.                 
    238. 

  238.                 <div class="sourcecode">
    239. 

  239.                     <p class="source-link">
    240. 

  240.                         Source: <a href="javascript:toggleSource('M000001_source')" id="l_M000001_source">show</a>
    241. 

  241.                         
    242. 

  242.                     </p>
    243. 

  243.                     <div id="M000001_source" class="dyn-source">
    244. 

  244.                         <pre>    <span class="ruby-comment cmt"># File lib/http_accept_language.rb, line 27</span>
    245. 

  245. 27:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">user_preferred_languages=</span>(<span class="ruby-identifier">languages</span>)
    246. 

  246. 28:     <span class="ruby-ivar">@user_preferred_languages</span> = <span class="ruby-identifier">languages</span>
    247. 

  247. 29:   <span class="ruby-keyword kw">end</span></pre>
    248. 

  248.                     </div>
    249. 

  249.                 </div>
    250. 

  250.                 
    251. 

  251.             </div>
    252. 

  252.             
    253. 

  253. </div>
    254. 

  254.     </div>
    255. 

  255.   </body>
    256. 

  256. </html>    
    257.