[Sommaire] [Imprimer]

   1  <?xml version="1.0" encoding="iso-8859-1"?>
   2  <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3    <html xmlns="http://www.w3.org/1999/xhtml">
   4          <head>
   5              <!-- template designed by Marco Von Ballmoos -->
   6              <title>Docs For Class TGlobalization</title>
   7              <link rel="stylesheet" href="../media/stylesheet.css" />
   8              <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
   9          </head>
  10          <body>
  11              <div class="page-body">            
  12  <h2 class="class-name">Class TGlobalization</h2>
  13  
  14  <a name="sec-description"></a>
  15  <div class="info-box">
  16      <div class="info-box-title">Description</div>
  17      <div class="nav-bar">
  18                      <span class="disabled">Description</span> |
  19                              <a href="#sec-descendents">Descendents</a>
  20              |                                                    <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  21                          
  22                      </div>
  23      <div class="info-box-body">
  24                  <!-- ========== Info from phpDoc block ========= -->
  25  <p class="short-description">TGlobalization contains settings for Culture, Charset  and TranslationConfiguration.</p>
  26  <p class="description"><p>TGlobalization can be subclassed to change how the Culture, Charset  are determined. See TGlobalizationAutoDetect for example of  setting the Culture based on browser settings.</p></p>
  27      <ul class="tags">
  28                  <li><span class="field">since:</span> 3.0</li>
  29                  <li><span class="field">version:</span> $Revision: 1.66 $  $Date: $DATE} $TIME} $</li>
  30                  <li><span class="field">author:</span> Wei Zhuo&lt;<a href="mailto:weizhuo[at]gmail[dot]com">weizhuo[at]gmail[dot]com</a>&gt;</li>
  31              </ul>
  32          <p class="notes">
  33              Located in <a class="field" href="_I18N_TGlobalization_php.html">/I18N/TGlobalization.php</a> (line <span class="field">27</span>)
  34          </p>
  35          
  36                  
  37          <pre><a href="../System/TComponent.html">TComponent</a>
  38     |
  39     --<a href="../System/TApplicationComponent.html">TApplicationComponent</a>
  40        |
  41        --<a href="../System/TModule.html">TModule</a>
  42           |
  43           --TGlobalization</pre>
  44      
  45              </div>
  46  </div>
  47  
  48      <a name="sec-descendents"></a>
  49      <div class="info-box">
  50          <div class="info-box-title">Direct descendents</div>
  51          <div class="nav-bar">
  52              <a href="#sec-description">Description</a> |
  53              <span class="disabled">Descendents</span>
  54              |                                                            <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  55                              
  56                                  </div>
  57          <div class="info-box-body">
  58              <table cellpadding="2" cellspacing="0" class="class-table">
  59                  <tr>
  60                      <th class="class-table-header">Class</th>
  61                      <th class="class-table-header">Description</th>
  62                  </tr>
  63                                  <tr>
  64                      <td style="padding-right: 2em"><a href="../System.I18N/TGlobalizationAutoDetect.html">TGlobalizationAutoDetect</a></td>
  65                      <td>
  66                                              TGlobalizationAutoDetect class will automatically try to resolve the default  culture using the user browser language settings.
  67                                          </td>
  68                  </tr>
  69                              </table>
  70          </div>
  71      </div>
  72  
  73  
  74  
  75      <a name="sec-method-summary"></a>
  76      <div class="info-box">
  77          <div class="info-box-title">Method Summary</span></div>
  78          <div class="nav-bar">
  79              <a href="#sec-description">Description</a> |
  80                              <a href="#sec-descendents">Descendents</a> |
  81                                                  <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  82          </div>
  83          <div class="info-box-body">            
  84              <div class="method-summary">
  85                                  
  86                  <div class="method-definition">
  87                                              <span class="method-result">string</span>
  88                                          <a href="#getCharset" title="details" class="method-name">getCharset</a>
  89                                          ()
  90                                      </div>
  91                                  
  92                  <div class="method-definition">
  93                                              <span class="method-result">string</span>
  94                                          <a href="#getCulture" title="details" class="method-name">getCulture</a>
  95                                          ()
  96                                      </div>
  97                                  
  98                  <div class="method-definition">
  99                                              <span class="method-result">array</span>
 100                                          <a href="#getCultureVariants" title="details" class="method-name">getCultureVariants</a>
 101                                              ([<span class="var-type">string</span>&nbsp;<span class="var-name">$culture</span> = <span class="var-default">null</span>])
 102                                      </div>
 103                                  
 104                  <div class="method-definition">
 105                                              <span class="method-result">string</span>
 106                                          <a href="#getDefaultCharset" title="details" class="method-name">getDefaultCharset</a>
 107                                          ()
 108                                      </div>
 109                                  
 110                  <div class="method-definition">
 111                                              <span class="method-result">string</span>
 112                                          <a href="#getDefaultCulture" title="details" class="method-name">getDefaultCulture</a>
 113                                          ()
 114                                      </div>
 115                                  
 116                  <div class="method-definition">
 117                                              <span class="method-result">array</span>
 118                                          <a href="#getLocalizedResource" title="details" class="method-name">getLocalizedResource</a>
 119                                              (<span class="var-type">string</span>&nbsp;<span class="var-name">$file</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$culture</span> = <span class="var-default">null</span>])
 120                                      </div>
 121                                  
 122                  <div class="method-definition">
 123                                              <span class="method-result">string</span>
 124                                          <a href="#getTranslationCatalogue" title="details" class="method-name">getTranslationCatalogue</a>
 125                                          ()
 126                                      </div>
 127                                  
 128                  <div class="method-definition">
 129                                              <span class="method-result"><a href="../System.Collections/TMap.html">TMap</a></span>
 130                                          <a href="#getTranslationConfiguration" title="details" class="method-name">getTranslationConfiguration</a>
 131                                          ()
 132                                      </div>
 133                                  
 134                  <div class="method-definition">
 135                                              <span class="method-result">void</span>
 136                                          <a href="#init" title="details" class="method-name">init</a>
 137                                              (<span class="var-type"><a href="../System.Xml/TXmlElement.html">TXmlElement</a></span>&nbsp;<span class="var-name">$xml</span>)
 138                                      </div>
 139                                  
 140                  <div class="method-definition">
 141                                              <span class="method-result">void</span>
 142                                          <a href="#setCharset" title="details" class="method-name">setCharset</a>
 143                                              (<span class="var-type">string</span>&nbsp;<span class="var-name">$charset</span>)
 144                                      </div>
 145                                  
 146                  <div class="method-definition">
 147                                              <span class="method-result">void</span>
 148                                          <a href="#setCulture" title="details" class="method-name">setCulture</a>
 149                                              (<span class="var-type">string</span>&nbsp;<span class="var-name">$culture</span>)
 150                                      </div>
 151                                  
 152                  <div class="method-definition">
 153                                              <span class="method-result">void</span>
 154                                          <a href="#setDefaultCharset" title="details" class="method-name">setDefaultCharset</a>
 155                                              (<span class="var-type">string</span>&nbsp;<span class="var-name">$charset</span>)
 156                                      </div>
 157                                  
 158                  <div class="method-definition">
 159                                              <span class="method-result">void</span>
 160                                          <a href="#setDefaultCulture" title="details" class="method-name">setDefaultCulture</a>
 161                                              (<span class="var-type">string</span>&nbsp;<span class="var-name">$culture</span>)
 162                                      </div>
 163                                  
 164                  <div class="method-definition">
 165                                              <span class="method-result">void</span>
 166                                          <a href="#setTranslationCatalogue" title="details" class="method-name">setTranslationCatalogue</a>
 167                                              (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
 168                                      </div>
 169                                  
 170                  <div class="method-definition">
 171                                              <span class="method-result">void</span>
 172                                          <a href="#setTranslationConfiguration" title="details" class="method-name">setTranslationConfiguration</a>
 173                                              (<span class="var-type">TMap</span>&nbsp;<span class="var-name">$config</span>)
 174                                      </div>
 175                              </div>
 176          </div>
 177      </div>        
 178  
 179      
 180      <a name="sec-methods"></a>
 181      <div class="info-box">
 182          <div class="info-box-title">Methods</div>
 183          <div class="nav-bar">
 184              <a href="#sec-description">Description</a> |
 185                              <a href="#sec-descendents">Descendents</a> |
 186                                                                  <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
 187                          
 188          </div>
 189          <div class="info-box-body">
 190              <A NAME='method_detail'></A>
 191  <a name="methodgetCharset" id="getCharset"><!-- --></a>
 192  <div class="oddrow">
 193      
 194      <div class="method-header">
 195          <span class="method-title">getCharset</span> (line <span class="line-number">134</span>)
 196      </div> 
 197      
 198      <!-- ========== Info from phpDoc block ========= -->
 199      <ul class="tags">
 200                  <li><span class="field">return:</span> localization charset</li>
 201                  <li><span class="field">access:</span> public</li>
 202              </ul>
 203      
 204      <div class="method-signature">
 205          <span class="method-result">string</span>
 206          <span class="method-name">
 207              getCharset
 208          </span>
 209                  ()
 210              </div>
 211      
 212          
 213          
 214      </div>
 215  <a name="methodgetCulture" id="getCulture"><!-- --></a>
 216  <div class="evenrow">
 217      
 218      <div class="method-header">
 219          <span class="method-title">getCulture</span> (line <span class="line-number">118</span>)
 220      </div> 
 221      
 222      <!-- ========== Info from phpDoc block ========= -->
 223      <ul class="tags">
 224                  <li><span class="field">return:</span> current application culture</li>
 225                  <li><span class="field">access:</span> public</li>
 226              </ul>
 227      
 228      <div class="method-signature">
 229          <span class="method-result">string</span>
 230          <span class="method-name">
 231              getCulture
 232          </span>
 233                  ()
 234              </div>
 235      
 236          
 237          
 238      </div>
 239  <a name="methodgetCultureVariants" id="getCultureVariants"><!-- --></a>
 240  <div class="oddrow">
 241      
 242      <div class="method-header">
 243          <span class="method-title">getCultureVariants</span> (line <span class="line-number">224</span>)
 244      </div> 
 245      
 246      <!-- ========== Info from phpDoc block ========= -->
 247  <p class="short-description">Gets all the variants of a specific culture. If the parameter  $culture is null, the current culture is used.</p>
 248      <ul class="tags">
 249                  <li><span class="field">return:</span> variants of the culture.</li>
 250                  <li><span class="field">access:</span> public</li>
 251              </ul>
 252      
 253      <div class="method-signature">
 254          <span class="method-result">array</span>
 255          <span class="method-name">
 256              getCultureVariants
 257          </span>
 258                      ([<span class="var-type">string</span>&nbsp;<span class="var-name">$culture</span> = <span class="var-default">null</span>])
 259              </div>
 260      
 261              <ul class="parameters">
 262                      <li>
 263                  <span class="var-type">string</span>
 264                  <span class="var-name">$culture</span><span class="var-description">: the Culture string</span>            </li>
 265                  </ul>
 266          
 267          
 268      </div>
 269  <a name="methodgetDefaultCharset" id="getDefaultCharset"><!-- --></a>
 270  <div class="evenrow">
 271      
 272      <div class="method-header">
 273          <span class="method-title">getDefaultCharset</span> (line <span class="line-number">102</span>)
 274      </div> 
 275      
 276      <!-- ========== Info from phpDoc block ========= -->
 277      <ul class="tags">
 278                  <li><span class="field">return:</span> default charset set</li>
 279                  <li><span class="field">access:</span> public</li>
 280              </ul>
 281      
 282      <div class="method-signature">
 283          <span class="method-result">string</span>
 284          <span class="method-name">
 285              getDefaultCharset
 286          </span>
 287                  ()
 288              </div>
 289      
 290          
 291          
 292      </div>
 293  <a name="methodgetDefaultCulture" id="getDefaultCulture"><!-- --></a>
 294  <div class="oddrow">
 295      
 296      <div class="method-header">
 297          <span class="method-title">getDefaultCulture</span> (line <span class="line-number">86</span>)
 298      </div> 
 299      
 300      <!-- ========== Info from phpDoc block ========= -->
 301      <ul class="tags">
 302                  <li><span class="field">return:</span> default culture</li>
 303                  <li><span class="field">access:</span> public</li>
 304              </ul>
 305      
 306      <div class="method-signature">
 307          <span class="method-result">string</span>
 308          <span class="method-name">
 309              getDefaultCulture
 310          </span>
 311                  ()
 312              </div>
 313      
 314          
 315          
 316      </div>
 317  <a name="methodgetLocalizedResource" id="getLocalizedResource"><!-- --></a>
 318  <div class="evenrow">
 319      
 320      <div class="method-header">
 321          <span class="method-title">getLocalizedResource</span> (line <span class="line-number">253</span>)
 322      </div> 
 323      
 324      <!-- ========== Info from phpDoc block ========= -->
 325  <p class="short-description">Returns a list of possible localized files. Example</p>
 326  <p class="description"><p><pre><ol><code><pre><li> <span class="src-var">$files </span>= <span class="src-var">$app</span><span class="src-sym">-&gt;</span><a href="../System.I18N/TGlobalization.html#methodgetLocalizedResource">getLocalizedResource</a><span class="src-sym">(</span><span class="src-str">&quot;path/to/Home.page&quot;</span><span class="src-sym">,</span><span class="src-str">&quot;en_US&quot;</span><span class="src-sym">)</span><span class="src-sym">;</span></li>
 327  </pre></code></ol></pre>  will return  <pre> array
 328     0 => 'path/to/en_US/Home.page'
 329     1 => 'path/to/en/Home.page'
 330     2 => 'path/to/Home.en_US.page'
 331     3 => 'path/to/Home.en.page'
 332     4 => 'path/to/Home.page'</pre>  Note that you still need to verify the existance of these files.</p></p>
 333      <ul class="tags">
 334                  <li><span class="field">return:</span> list of possible localized resource files.</li>
 335                  <li><span class="field">access:</span> public</li>
 336              </ul>
 337      
 338      <div class="method-signature">
 339          <span class="method-result">array</span>
 340          <span class="method-name">
 341              getLocalizedResource
 342          </span>
 343                      (<span class="var-type">string</span>&nbsp;<span class="var-name">$file</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$culture</span> = <span class="var-default">null</span>])
 344              </div>
 345      
 346              <ul class="parameters">
 347                      <li>
 348                  <span class="var-type">string</span>
 349                  <span class="var-name">$file</span><span class="var-description">: filename</span>            </li>
 350                      <li>
 351                  <span class="var-type">string</span>
 352                  <span class="var-name">$culture</span><span class="var-description">: culture string, null to use current culture</span>            </li>
 353                  </ul>
 354          
 355          
 356      </div>
 357  <a name="methodgetTranslationCatalogue" id="getTranslationCatalogue"><!-- --></a>
 358  <div class="oddrow">
 359      
 360      <div class="method-header">
 361          <span class="method-title">getTranslationCatalogue</span> (line <span class="line-number">205</span>)
 362      </div> 
 363      
 364      <!-- ========== Info from phpDoc block ========= -->
 365      <ul class="tags">
 366                  <li><span class="field">return:</span> current translation catalogue.</li>
 367                  <li><span class="field">access:</span> public</li>
 368              </ul>
 369      
 370      <div class="method-signature">
 371          <span class="method-result">string</span>
 372          <span class="method-name">
 373              getTranslationCatalogue
 374          </span>
 375                  ()
 376              </div>
 377      
 378          
 379          
 380      </div>
 381  <a name="methodgetTranslationConfiguration" id="getTranslationConfiguration"><!-- --></a>
 382  <div class="evenrow">
 383      
 384      <div class="method-header">
 385          <span class="method-title">getTranslationConfiguration</span> (line <span class="line-number">150</span>)
 386      </div> 
 387      
 388      <!-- ========== Info from phpDoc block ========= -->
 389      <ul class="tags">
 390                  <li><span class="field">return:</span> translation source configuration.</li>
 391                  <li><span class="field">access:</span> public</li>
 392              </ul>
 393      
 394      <div class="method-signature">
 395          <span class="method-result"><a href="../System.Collections/TMap.html">TMap</a></span>
 396          <span class="method-name">
 397              getTranslationConfiguration
 398          </span>
 399                  ()
 400              </div>
 401      
 402          
 403          
 404      </div>
 405  <a name="methodinit" id="init"><!-- --></a>
 406  <div class="oddrow">
 407      
 408      <div class="method-header">
 409          <span class="method-title">init</span> (line <span class="line-number">67</span>)
 410      </div> 
 411      
 412      <!-- ========== Info from phpDoc block ========= -->
 413  <p class="short-description">Initialize the Culture and Charset for this application.</p>
 414  <p class="description"><p>You should override this method if you want a different way of  setting the Culture and/or Charset for your application.  If you override this method, call parent::init($xml) first.</p></p>
 415      <ul class="tags">
 416                  <li><span class="field">access:</span> public</li>
 417              </ul>
 418      
 419      <div class="method-signature">
 420          <span class="method-result">void</span>
 421          <span class="method-name">
 422              init
 423          </span>
 424                      (<span class="var-type"><a href="../System.Xml/TXmlElement.html">TXmlElement</a></span>&nbsp;<span class="var-name">$xml</span>)
 425              </div>
 426      
 427              <ul class="parameters">
 428                      <li>
 429                  <span class="var-type"><a href="../System.Xml/TXmlElement.html">TXmlElement</a></span>
 430                  <span class="var-name">$xml</span><span class="var-description">: application configuration</span>            </li>
 431                  </ul>
 432          
 433              <hr class="separator" />
 434          <div class="notes">Redefinition of:</div>
 435          <dl>
 436              <dt><a href="../System/TModule.html#methodinit">TModule::init()</a></dt>
 437                          <dd>Initializes the module.</dd>
 438                      </dl>
 439          
 440              <hr class="separator" />
 441          <div class="notes">Redefined in descendants as:</div>
 442          <ul class="redefinitions">
 443                      <li>
 444                  <a href="../System.I18N/TGlobalizationAutoDetect.html#methodinit">TGlobalizationAutoDetect::init()</a>
 445                              </li>
 446                  </ul>
 447      </div>
 448  <a name="methodsetCharset" id="setCharset"><!-- --></a>
 449  <div class="evenrow">
 450      
 451      <div class="method-header">
 452          <span class="method-title">setCharset</span> (line <span class="line-number">142</span>)
 453      </div> 
 454      
 455      <!-- ========== Info from phpDoc block ========= -->
 456      <ul class="tags">
 457                  <li><span class="field">access:</span> public</li>
 458              </ul>
 459      
 460      <div class="method-signature">
 461          <span class="method-result">void</span>
 462          <span class="method-name">
 463              setCharset
 464          </span>
 465                      (<span class="var-type">string</span>&nbsp;<span class="var-name">$charset</span>)
 466              </div>
 467      
 468              <ul class="parameters">
 469                      <li>
 470                  <span class="var-type">string</span>
 471                  <span class="var-name">$charset</span><span class="var-description">: localization charset, e.g. &lt;tt&gt;UTF-8&lt;/tt&gt;</span>            </li>
 472                  </ul>
 473          
 474          
 475      </div>
 476  <a name="methodsetCulture" id="setCulture"><!-- --></a>
 477  <div class="oddrow">
 478      
 479      <div class="method-header">
 480          <span class="method-title">setCulture</span> (line <span class="line-number">126</span>)
 481      </div> 
 482      
 483      <!-- ========== Info from phpDoc block ========= -->
 484      <ul class="tags">
 485                  <li><span class="field">access:</span> public</li>
 486              </ul>
 487      
 488      <div class="method-signature">
 489          <span class="method-result">void</span>
 490          <span class="method-name">
 491              setCulture
 492          </span>
 493                      (<span class="var-type">string</span>&nbsp;<span class="var-name">$culture</span>)
 494              </div>
 495      
 496              <ul class="parameters">
 497                      <li>
 498                  <span class="var-type">string</span>
 499                  <span class="var-name">$culture</span><span class="var-description">: culture, e.g. &lt;tt&gt;en_US&lt;/tt&gt; for American English</span>            </li>
 500                  </ul>
 501          
 502          
 503      </div>
 504  <a name="methodsetDefaultCharset" id="setDefaultCharset"><!-- --></a>
 505  <div class="evenrow">
 506      
 507      <div class="method-header">
 508          <span class="method-title">setDefaultCharset</span> (line <span class="line-number">110</span>)
 509      </div> 
 510      
 511      <!-- ========== Info from phpDoc block ========= -->
 512      <ul class="tags">
 513                  <li><span class="field">access:</span> public</li>
 514              </ul>
 515      
 516      <div class="method-signature">
 517          <span class="method-result">void</span>
 518          <span class="method-name">
 519              setDefaultCharset
 520          </span>
 521                      (<span class="var-type">string</span>&nbsp;<span class="var-name">$charset</span>)
 522              </div>
 523      
 524              <ul class="parameters">
 525                      <li>
 526                  <span class="var-type">string</span>
 527                  <span class="var-name">$charset</span><span class="var-description">: default localization charset, e.g. &lt;tt&gt;UTF-8&lt;/tt&gt;</span>            </li>
 528                  </ul>
 529          
 530          
 531      </div>
 532  <a name="methodsetDefaultCulture" id="setDefaultCulture"><!-- --></a>
 533  <div class="oddrow">
 534      
 535      <div class="method-header">
 536          <span class="method-title">setDefaultCulture</span> (line <span class="line-number">94</span>)
 537      </div> 
 538      
 539      <!-- ========== Info from phpDoc block ========= -->
 540      <ul class="tags">
 541                  <li><span class="field">access:</span> public</li>
 542              </ul>
 543      
 544      <div class="method-signature">
 545          <span class="method-result">void</span>
 546          <span class="method-name">
 547              setDefaultCulture
 548          </span>
 549                      (<span class="var-type">string</span>&nbsp;<span class="var-name">$culture</span>)
 550              </div>
 551      
 552              <ul class="parameters">
 553                      <li>
 554                  <span class="var-type">string</span>
 555                  <span class="var-name">$culture</span><span class="var-description">: default culture, e.g. &lt;tt&gt;en_US&lt;/tt&gt; for American English</span>            </li>
 556                  </ul>
 557          
 558          
 559      </div>
 560  <a name="methodsetTranslationCatalogue" id="setTranslationCatalogue"><!-- --></a>
 561  <div class="evenrow">
 562      
 563      <div class="method-header">
 564          <span class="method-title">setTranslationCatalogue</span> (line <span class="line-number">213</span>)
 565      </div> 
 566      
 567      <!-- ========== Info from phpDoc block ========= -->
 568      <ul class="tags">
 569                  <li><span class="field">access:</span> public</li>
 570              </ul>
 571      
 572      <div class="method-signature">
 573          <span class="method-result">void</span>
 574          <span class="method-name">
 575              setTranslationCatalogue
 576          </span>
 577                      (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
 578              </div>
 579      
 580              <ul class="parameters">
 581                      <li>
 582                  <span class="var-type">string</span>
 583                  <span class="var-name">$value</span><span class="var-description">: update the translation catalogue.</span>            </li>
 584                  </ul>
 585          
 586          
 587      </div>
 588  <a name="methodsetTranslationConfiguration" id="setTranslationConfiguration"><!-- --></a>
 589  <div class="oddrow">
 590      
 591      <div class="method-header">
 592          <span class="method-title">setTranslationConfiguration</span> (line <span class="line-number">168</span>)
 593      </div> 
 594      
 595      <!-- ========== Info from phpDoc block ========= -->
 596  <p class="short-description">Sets the translation configuration. Example configuration:</p>
 597  <p class="description"><p><pre><ol><code><pre><li> <span class="src-var">$config</span><span class="src-sym">[</span><span class="src-str">'type'</span><span class="src-sym">] </span>= <span class="src-str">'XLIFF'</span><span class="src-sym">; </span><span class="src-comm">//XLIFF, gettext, mysql or sqlite</span></li>
 598  <li>  <span class="src-var">$config</span><span class="src-sym">[</span><span class="src-str">'source'</span><span class="src-sym">] </span>= <span class="src-str">'Path.to.directory'</span><span class="src-sym">; </span><span class="src-comm">//or database connection string</span></li>
 599  <li>  <span class="src-var">$config</span><span class="src-sym">[</span><span class="src-str">'catalogue'</span><span class="src-sym">] </span>= <span class="src-str">'messages'</span><span class="src-sym">; </span><span class="src-comm">//default catalog</span></li>
 600  <li>  <span class="src-var">$config</span><span class="src-sym">[</span><span class="src-str">'autosave'</span><span class="src-sym">] </span>= <span class="src-str">'true'</span><span class="src-sym">; </span><span class="src-comm">//save untranslated message</span></li>
 601  <li>  <span class="src-var">$config</span><span class="src-sym">[</span><span class="src-str">'cache'</span><span class="src-sym">] </span>= <span class="src-str">'true'</span><span class="src-sym">; </span><span class="src-comm">//cache translated message</span></li>
 602  <li>  <span class="src-var">$config</span><span class="src-sym">[</span><span class="src-str">'marker'</span><span class="src-sym">] </span>= <span class="src-str">'@@'</span><span class="src-sym">; </span><span class="src-comm">// surround untranslated text with '@@'</span></li>
 603  </pre></code></ol></pre>  Throws exception is source is not found.</p></p>
 604      <ul class="tags">
 605                  <li><span class="field">access:</span> protected</li>
 606              </ul>
 607      
 608      <div class="method-signature">
 609          <span class="method-result">void</span>
 610          <span class="method-name">
 611              setTranslationConfiguration
 612          </span>
 613                      (<span class="var-type">TMap</span>&nbsp;<span class="var-name">$config</span>)
 614              </div>
 615      
 616              <ul class="parameters">
 617                      <li>
 618                  <span class="var-type"><a href="../System.Collections/TMap.html">TMap</a></span>
 619                  <span class="var-name">$config</span><span class="var-description">: configuration options</span>            </li>
 620                  </ul>
 621          
 622          
 623      </div>
 624                              <h4>Inherited Methods</h4>
 625                  <a name='inherited_methods'><!-- --></a>    
 626                                      <!-- =========== Summary =========== -->
 627                      <p>Inherited From <span class="classname"><a href="../System/TModule.html">TModule</a></span></p>
 628                      <blockquote>
 629                                                      <span class="method-name"><a href="../System/TModule.html#methodgetID">TModule::getID()</a></span><br>
 630                                                      <span class="method-name"><a href="../System/TModule.html#methodinit">TModule::init()</a></span><br>
 631                                                      <span class="method-name"><a href="../System/TModule.html#methodsetID">TModule::setID()</a></span><br>
 632                                              </blockquote>
 633                                      <!-- =========== Summary =========== -->
 634                      <p>Inherited From <span class="classname"><a href="../System/TApplicationComponent.html">TApplicationComponent</a></span></p>
 635                      <blockquote>
 636                                                      <span class="method-name"><a href="../System/TApplicationComponent.html#methodgetApplication">TApplicationComponent::getApplication()</a></span><br>
 637                                                      <span class="method-name"><a href="../System/TApplicationComponent.html#methodgetRequest">TApplicationComponent::getRequest()</a></span><br>
 638                                                      <span class="method-name"><a href="../System/TApplicationComponent.html#methodgetResponse">TApplicationComponent::getResponse()</a></span><br>
 639                                                      <span class="method-name"><a href="../System/TApplicationComponent.html#methodgetService">TApplicationComponent::getService()</a></span><br>
 640                                                      <span class="method-name"><a href="../System/TApplicationComponent.html#methodgetSession">TApplicationComponent::getSession()</a></span><br>
 641                                                      <span class="method-name"><a href="../System/TApplicationComponent.html#methodgetUser">TApplicationComponent::getUser()</a></span><br>
 642                                                      <span class="method-name"><a href="../System/TApplicationComponent.html#methodpublishAsset">TApplicationComponent::publishAsset()</a></span><br>
 643                                                      <span class="method-name"><a href="../System/TApplicationComponent.html#methodpublishFilePath">TApplicationComponent::publishFilePath()</a></span><br>
 644                                              </blockquote>
 645                                      <!-- =========== Summary =========== -->
 646                      <p>Inherited From <span class="classname"><a href="../System/TComponent.html">TComponent</a></span></p>
 647                      <blockquote>
 648                                                      <span class="method-name"><a href="../System/TComponent.html#methodaddParsedObject">TComponent::addParsedObject()</a></span><br>
 649                                                      <span class="method-name"><a href="../System/TComponent.html#methodattachEventHandler">TComponent::attachEventHandler()</a></span><br>
 650                                                      <span class="method-name"><a href="../System/TComponent.html#methodcanGetProperty">TComponent::canGetProperty()</a></span><br>
 651                                                      <span class="method-name"><a href="../System/TComponent.html#methodcanSetProperty">TComponent::canSetProperty()</a></span><br>
 652                                                      <span class="method-name"><a href="../System/TComponent.html#methodcreatedOnTemplate">TComponent::createdOnTemplate()</a></span><br>
 653                                                      <span class="method-name"><a href="../System/TComponent.html#methoddetachEventHandler">TComponent::detachEventHandler()</a></span><br>
 654                                                      <span class="method-name"><a href="../System/TComponent.html#methodevaluateExpression">TComponent::evaluateExpression()</a></span><br>
 655                                                      <span class="method-name"><a href="../System/TComponent.html#methodevaluateStatements">TComponent::evaluateStatements()</a></span><br>
 656                                                      <span class="method-name"><a href="../System/TComponent.html#methodgetEventHandlers">TComponent::getEventHandlers()</a></span><br>
 657                                                      <span class="method-name"><a href="../System/TComponent.html#methodgetSubProperty">TComponent::getSubProperty()</a></span><br>
 658                                                      <span class="method-name"><a href="../System/TComponent.html#methodhasEvent">TComponent::hasEvent()</a></span><br>
 659                                                      <span class="method-name"><a href="../System/TComponent.html#methodhasEventHandler">TComponent::hasEventHandler()</a></span><br>
 660                                                      <span class="method-name"><a href="../System/TComponent.html#methodhasProperty">TComponent::hasProperty()</a></span><br>
 661                                                      <span class="method-name"><a href="../System/TComponent.html#methodraiseEvent">TComponent::raiseEvent()</a></span><br>
 662                                                      <span class="method-name"><a href="../System/TComponent.html#methodsetSubProperty">TComponent::setSubProperty()</a></span><br>
 663                                                      <span class="method-name"><a href="../System/TComponent.html#method__get">TComponent::__get()</a></span><br>
 664                                                      <span class="method-name"><a href="../System/TComponent.html#method__set">TComponent::__set()</a></span><br>
 665                                              </blockquote>
 666                                          
 667          </div>
 668      </div>
 669  
 670  
 671      <p class="notes" id="credit">
 672          Documentation generated on Mon, 04 Dec 2006 11:26:40 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC4</a>
 673      </p>
 674      </div></body>
 675  </html>