docs/api/modules/luci.i18n.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
   2    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   3 <html>
   4 <head>
   5     <title>Reference</title>
   6     <link rel="stylesheet" href="../luadoc.css" type="text/css" />
   7         <!--meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/-->
   8 </head>
   9
  10 <body>
  11 <div id="container">
  12
  13 <div id="product">
  14         <div id="product_logo"></div>
  15         <div id="product_name"><big><b></b></big></div>
  16         <div id="product_description"></div>
  17 </div> <!-- id="product" -->
  18
  19 <div id="main">
  20
  21 <div id="navigation">
  22
  23
  24 <h1>LuaDoc</h1>
  25 <ul>
  26
  27         <li><a href="../index.html">Index</a></li>
  28
  29 </ul>
  30
  31
  32 <!-- Module list -->
  33
  34 <h1>Modules</h1>
  35 <ul>
  36
  37         <li>
  38                 <a href="../modules/luci.dispatcher.html">luci.dispatcher</a>
  39         </li>
  40
  41         <li>
  42                 <a href="../modules/luci.http.html">luci.http</a>
  43         </li>
  44
  45         <li>
  46                 <a href="../modules/luci.http.conditionals.html">luci.http.conditionals</a>
  47         </li>
  48
  49         <li>
  50                 <a href="../modules/luci.http.date.html">luci.http.date</a>
  51         </li>
  52
  53         <li>
  54                 <a href="../modules/luci.http.mime.html">luci.http.mime</a>
  55         </li>
  56
  57         <li><strong>luci.i18n</strong></li>
  58
  59         <li>
  60                 <a href="../modules/luci.ip.html">luci.ip</a>
  61         </li>
  62
  63         <li>
  64                 <a href="../modules/luci.ip.cidr.html">luci.ip.cidr</a>
  65         </li>
  66
  67         <li>
  68                 <a href="../modules/luci.json.html">luci.json</a>
  69         </li>
  70
  71         <li>
  72                 <a href="../modules/luci.jsonc.html">luci.jsonc</a>
  73         </li>
  74
  75         <li>
  76                 <a href="../modules/luci.jsonc.parser.html">luci.jsonc.parser</a>
  77         </li>
  78
  79         <li>
  80                 <a href="../modules/luci.model.ipkg.html">luci.model.ipkg</a>
  81         </li>
  82
  83         <li>
  84                 <a href="../modules/luci.model.uci.html">luci.model.uci</a>
  85         </li>
  86
  87         <li>
  88                 <a href="../modules/luci.rpcc.html">luci.rpcc</a>
  89         </li>
  90
  91         <li>
  92                 <a href="../modules/luci.rpcc.ruci.html">luci.rpcc.ruci</a>
  93         </li>
  94
  95         <li>
  96                 <a href="../modules/luci.sys.html">luci.sys</a>
  97         </li>
  98
  99         <li>
 100                 <a href="../modules/luci.sys.init.html">luci.sys.init</a>
 101         </li>
 102
 103         <li>
 104                 <a href="../modules/luci.sys.iptparser.html">luci.sys.iptparser</a>
 105         </li>
 106
 107         <li>
 108                 <a href="../modules/luci.sys.net.html">luci.sys.net</a>
 109         </li>
 110
 111         <li>
 112                 <a href="../modules/luci.sys.process.html">luci.sys.process</a>
 113         </li>
 114
 115         <li>
 116                 <a href="../modules/luci.sys.user.html">luci.sys.user</a>
 117         </li>
 118
 119         <li>
 120                 <a href="../modules/luci.sys.wifi.html">luci.sys.wifi</a>
 121         </li>
 122
 123         <li>
 124                 <a href="../modules/luci.util.html">luci.util</a>
 125         </li>
 126
 127         <li>
 128                 <a href="../modules/nixio.html">nixio</a>
 129         </li>
 130
 131         <li>
 132                 <a href="../modules/nixio.CHANGELOG.html">nixio.CHANGELOG</a>
 133         </li>
 134
 135         <li>
 136                 <a href="../modules/nixio.CryptoHash.html">nixio.CryptoHash</a>
 137         </li>
 138
 139         <li>
 140                 <a href="../modules/nixio.File.html">nixio.File</a>
 141         </li>
 142
 143         <li>
 144                 <a href="../modules/nixio.README.html">nixio.README</a>
 145         </li>
 146
 147         <li>
 148                 <a href="../modules/nixio.Socket.html">nixio.Socket</a>
 149         </li>
 150
 151         <li>
 152                 <a href="../modules/nixio.TLSContext.html">nixio.TLSContext</a>
 153         </li>
 154
 155         <li>
 156                 <a href="../modules/nixio.TLSSocket.html">nixio.TLSSocket</a>
 157         </li>
 158
 159         <li>
 160                 <a href="../modules/nixio.UnifiedIO.html">nixio.UnifiedIO</a>
 161         </li>
 162
 163         <li>
 164                 <a href="../modules/nixio.bin.html">nixio.bin</a>
 165         </li>
 166
 167         <li>
 168                 <a href="../modules/nixio.bit.html">nixio.bit</a>
 169         </li>
 170
 171         <li>
 172                 <a href="../modules/nixio.crypto.html">nixio.crypto</a>
 173         </li>
 174
 175         <li>
 176                 <a href="../modules/nixio.fs.html">nixio.fs</a>
 177         </li>
 178
 179 </ul>
 180
 181
 182
 183 <!-- File list -->
 184
 185
 186
 187
 188
 189
 190
 191 </div><!-- id="navigation" -->
 192
 193 <div id="content">
 194
 195 <h1>Class <code>luci.i18n</code></h1>
 196
 197 <p></p>
 198
 199
 200
 201
 202
 203
 204
 205 <h2>Functions</h2>
 206 <table class="function_list">
 207
 208         <tr>
 209         <td class="name" nowrap><a href="#dump">dump</a>&nbsp;()</td>
 210         <td class="summary">
 211
 212 Return all currently loaded translation strings as a key-value table.</td>
 213         </tr>
 214
 215         <tr>
 216         <td class="name" nowrap><a href="#setlanguage">setlanguage</a>&nbsp;(lang)</td>
 217         <td class="summary">
 218
 219 Set the context default translation language.</td>
 220         </tr>
 221
 222         <tr>
 223         <td class="name" nowrap><a href="#translate">translate</a>&nbsp;(key)</td>
 224         <td class="summary">
 225
 226 Return the translated value for a specific translation key.</td>
 227         </tr>
 228
 229         <tr>
 230         <td class="name" nowrap><a href="#translatef">translatef</a>&nbsp;(key, ...)</td>
 231         <td class="summary">
 232
 233 Return the translated value for a specific translation key and use it as sprintf pattern.</td>
 234         </tr>
 235
 236 </table>
 237
 238
 239
 240
 241
 242
 243 <br/>
 244 <br/>
 245
 246
 247 <h2><a name="functions"></a>Functions</h2>
 248 <dl class="function">
 249
 250
 251
 252 <dt><a name="dump"></a><strong>dump</strong>&nbsp;()</dt>
 253 <dd>
 254
 255
 256 Return all currently loaded translation strings as a key-value table. The key is the
 257 hexadecimal representation of the translation key while the value is the translated
 258 text content.
 259
 260
 261
 262
 263
 264
 265
 266
 267 <h3>Return value:</h3>
 268 Key-value translation string table.
 269
 270
 271
 272 </dd>
 273
 274
 275
 276
 277 <dt><a name="setlanguage"></a><strong>setlanguage</strong>&nbsp;(lang)</dt>
 278 <dd>
 279
 280
 281 Set the context default translation language.
 282
 283
 284
 285 <h3>Parameters</h3>
 286 <ul>
 287
 288         <li>
 289           lang: An IETF/BCP 47 language tag or ISO3166 country code, e.g. "en-US" or "de"
 290         </li>
 291
 292 </ul>
 293
 294
 295
 296
 297
 298
 299 <h3>Return value:</h3>
 300 The effective loaded language, e.g. "en" for "en-US" - or nil on failure
 301
 302
 303
 304 </dd>
 305
 306
 307
 308
 309 <dt><a name="translate"></a><strong>translate</strong>&nbsp;(key)</dt>
 310 <dd>
 311
 312
 313 Return the translated value for a specific translation key.
 314
 315
 316
 317 <h3>Parameters</h3>
 318 <ul>
 319
 320         <li>
 321           key: Default translation text
 322         </li>
 323
 324 </ul>
 325
 326
 327
 328
 329
 330
 331 <h3>Return value:</h3>
 332 Translated string
 333
 334
 335
 336 </dd>
 337
 338
 339
 340
 341 <dt><a name="translatef"></a><strong>translatef</strong>&nbsp;(key, ...)</dt>
 342 <dd>
 343
 344
 345 Return the translated value for a specific translation key and use it as sprintf pattern.
 346
 347
 348
 349 <h3>Parameters</h3>
 350 <ul>
 351
 352         <li>
 353           key: Default translation text
 354         </li>
 355
 356         <li>
 357           ...: Format parameters
 358         </li>
 359
 360 </ul>
 361
 362
 363
 364
 365
 366
 367 <h3>Return value:</h3>
 368 Translated and formatted string
 369
 370
 371
 372 </dd>
 373
 374
 375 </dl>
 376
 377
 378
 379
 380
 381 </div> <!-- id="content" -->
 382
 383 </div> <!-- id="main" -->
 384
 385 <div id="about">
 386         <p><a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" /></a></p>
 387 </div> <!-- id="about" -->
 388
 389 </div> <!-- id="container" -->
 390 </body>
 391 </html>