home *** CD-ROM | disk | FTP | other *** search
/ Enter 2004 June / ENTER.ISO / files / xampp-win32-1.4.5-installer.exe / xampp / Translation_str_mgmt_php.html < prev    next >
Encoding:
Extensible Markup Language  |  2004-03-24  |  12.7 KB  |  264 lines
  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 page translation.str_mgmt.php</title>
  7.             <link rel="stylesheet" href="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="file-name">Translation/translation.str_mgmt.php</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-includes">Includes</a>
  20.             |                                            <a href="#sec-functions">Functions</a>
  21.             </div>
  22.     <div class="info-box-body">
  23.         <!-- ========== Info from phpDoc block ========= -->
  24. <p class="short-description">File translation.str_mgmt.php</p>
  25. <p class="description"><p>Additional functions for Translation class</p><p>Functions allowing user to create the new language, translation for specific  strings and full management of the languages database.</p></p>
  26.     <ul class="tags">
  27.                 <li><span class="field">access:</span> public</li>
  28.                 <li><span class="field">version:</span> 1.3</li>
  29.                 <li><span class="field">author:</span> Lorenzo Alberton   <<a href="mailto:l dot alberton at quipo dot it">mailto:l dot alberton at quipo dot it</a>></li>
  30.                 <li><span class="field">author:</span> Wojciech Zieli±ski <<a href="mailto:voyteck@caffe.com.pl">mailto:voyteck@caffe.com.pl</a>></li>
  31.             </ul>
  32.  
  33.             </div>
  34. </div>
  35.  
  36.  
  37.     <a name="sec-includes"></a>
  38.     <div class="info-box">
  39.         <div class="info-box-title">Includes</div>
  40.         <div class="nav-bar">
  41.             <a href="#sec-description">Description</a> |
  42.                         <span class="disabled">Includes</span>
  43.             |                                                    <a href="#sec-functions">Functions</a>
  44.                     </div>
  45.         <div class="info-box-body">
  46.             <a name="_DB_php"><!-- --></a>
  47. <div class="oddrow">
  48.  
  49.     <div>
  50.         <span class="include-title">
  51.             <span class="include-type">require_once</span>
  52.             (<span class="include-name">'DB.php'</span>)
  53.             (line <span class="line-number">19</span>)
  54.         </span>
  55.     </div>
  56.  
  57.     <!-- ========== Info from phpDoc block ========= -->
  58. <p class="short-description">require PEAR::DB</p>
  59.  
  60. </div>
  61.         </div>
  62.     </div>
  63.  
  64.  
  65.  
  66.     <a name="sec-functions"></a>
  67.     <div class="info-box">
  68.         <div class="info-box-title">Functions</div>
  69.         <div class="nav-bar">
  70.             <a href="#sec-description">Description</a> |
  71.                                         <a href="#sec-includes">Includes</a>
  72.                 |                                                <span class="disabled">Functions</span>
  73.         </div>
  74.         <div class="info-box-body">
  75.             <a name="functionaddTranslation" id="functionaddTranslation"><!-- --></a>
  76. <div class="evenrow">
  77.  
  78.     <div>
  79.         <span class="method-title">addTranslation</span> (line <span class="line-number">213</span>)
  80.     </div>
  81.  
  82.     <!-- ========== Info from phpDoc block ========= -->
  83. <p class="short-description">Translation adding  Adds string to one or more language tables.</p>
  84.     <ul class="tags">
  85.                 <li><span class="field">return:</span> Return 1 if everything went OK, a PEAR::DB_Error object if not.</li>
  86.             </ul>
  87.  
  88.     <div class="method-signature">
  89.         <span class="method-result">mixed</span>
  90.         <span class="method-name">
  91.             addTranslation
  92.         </span>
  93.                     (<span class="var-type">string</span> <span class="var-name">$PageID</span>, <span class="var-type">string</span> <span class="var-name">$StringID</span>, <span class="var-type">array</span> <span class="var-name">$String</span>, <span class="var-type">string</span> <span class="var-name">$pear_DSN</span>, [<span class="var-type">array</span> <span class="var-name">$CustomTables</span> = <span class="var-default">0</span>])
  94.             </div>
  95.  
  96.             <ul class="parameters">
  97.                     <li>
  98.                 <span class="var-type">string</span>
  99.                 <span class="var-name">$PageID</span><span class="var-description">: page identifier. Might be "" if the string is to be                          available from any page, independendly from translation                          object creation parameters.</span>            </li>
  100.                     <li>
  101.                 <span class="var-type">string</span>
  102.                 <span class="var-name">$StringID</span><span class="var-description">: string identifier. Must be unique for the same PageID                          and strings that were created without PageID's.                          This rule must be respected to prevent ambiguities.</span>            </li>
  103.                     <li>
  104.                 <span class="var-type">array</span>
  105.                 <span class="var-name">$String</span><span class="var-description">: array of strings - the array keys should be languages id's,                          the values - the sttrings in these languages - e.g.:                          ("en"->"English text", "pl"->"Tekst polski", ...)</span>            </li>
  106.                     <li>
  107.                 <span class="var-type">string</span>
  108.                 <span class="var-name">$pear_DSN</span><span class="var-description">: PEAR DSN string for database connection</span>            </li>
  109.                     <li>
  110.                 <span class="var-type">array</span>
  111.                 <span class="var-name">$CustomTables</span><span class="var-description">: Custom table definitions</span>            </li>
  112.                 </ul>
  113.  
  114.  
  115. </div>
  116. <a name="functioncreateNewLang" id="functioncreateNewLang"><!-- --></a>
  117. <div class="oddrow">
  118.  
  119.     <div>
  120.         <span class="method-title">createNewLang</span> (line <span class="line-number">85</span>)
  121.     </div>
  122.  
  123.     <!-- ========== Info from phpDoc block ========= -->
  124. <p class="short-description">New language creation</p>
  125. <p class="description"><p>Creates new language in the system.  Creates lang entry in the languages table and the table for language strings.  If other langs have been created before and their tables were filled with  strings, function addTranslation should be executed for each of the added  strings just after calling this function and before using the Translation class  for any purpose.</p></p>
  126.     <ul class="tags">
  127.                 <li><span class="field">return:</span> Return 1 if everything went OK, a PEAR::DB_Error object if not.</li>
  128.             </ul>
  129.  
  130.     <div class="method-signature">
  131.         <span class="method-result">mixed</span>
  132.         <span class="method-name">
  133.             createNewLang
  134.         </span>
  135.                     (<span class="var-type">string</span> <span class="var-name">$LangID</span>, <span class="var-type">string</span> <span class="var-name">$LangName</span>, <span class="var-type">string</span> <span class="var-name">$METATags</span>, <span class="var-type">string</span> <span class="var-name">$pear_DSN</span>, [<span class="var-type">array</span> <span class="var-name">$CustomTables</span> = <span class="var-default">0</span>])
  136.             </div>
  137.  
  138.             <ul class="parameters">
  139.                     <li>
  140.                 <span class="var-type">string</span>
  141.                 <span class="var-name">$LangID</span><span class="var-description">: Language identifier</span>            </li>
  142.                     <li>
  143.                 <span class="var-type">string</span>
  144.                 <span class="var-name">$LangName</span><span class="var-description">: Language name - store the language name of the lang,                          possibly in the language described. This name can be later                          retrieved by calling getLangName and getOtherLangs methods                          and used for hyperlinks changing the site language.</span>            </li>
  145.                     <li>
  146.                 <span class="var-type">string</span>
  147.                 <span class="var-name">$METATags</span><span class="var-description">: Tags that may describe the language codepage etc.                          These tags can be retrieved by calling getMetaTags method.</span>            </li>
  148.                     <li>
  149.                 <span class="var-type">string</span>
  150.                 <span class="var-name">$pear_DSN</span><span class="var-description">: PEAR DSN string for database connection</span>            </li>
  151.                     <li>
  152.                 <span class="var-type">array</span>
  153.                 <span class="var-name">$CustomTables</span><span class="var-description">: Custom table definitions</span>            </li>
  154.                 </ul>
  155.  
  156.  
  157. </div>
  158. <a name="functionremoveLang" id="functionremoveLang"><!-- --></a>
  159. <div class="evenrow">
  160.  
  161.     <div>
  162.         <span class="method-title">removeLang</span> (line <span class="line-number">154</span>)
  163.     </div>
  164.  
  165.     <!-- ========== Info from phpDoc block ========= -->
  166. <p class="short-description">Language removal</p>
  167. <p class="description"><p>Removes language from system.  This function should be used carefully - it will permanently remove all the  strings that has been added to the language table by dropping this table.  If other langs are stored in the table, then only this lang column will be dropped.</p></p>
  168.     <ul class="tags">
  169.                 <li><span class="field">return:</span> Return 1 if everything went OK, a PEAR::DB_Error object if not.</li>
  170.             </ul>
  171.  
  172.     <div class="method-signature">
  173.         <span class="method-result">mixed</span>
  174.         <span class="method-name">
  175.             removeLang
  176.         </span>
  177.                     (<span class="var-type">string</span> <span class="var-name">$LangID</span>, <span class="var-type">string</span> <span class="var-name">$pear_DSN</span>, [<span class="var-type">array</span> <span class="var-name">$CustomTables</span> = <span class="var-default">0</span>], [<span class="var-type">boolean</span> <span class="var-name">$force</span> = <span class="var-default">false</span>])
  178.             </div>
  179.  
  180.             <ul class="parameters">
  181.                     <li>
  182.                 <span class="var-type">string</span>
  183.                 <span class="var-name">$LangID</span><span class="var-description">: Language identifier</span>            </li>
  184.                     <li>
  185.                 <span class="var-type">string</span>
  186.                 <span class="var-name">$pear_DSN</span><span class="var-description">: PEAR DSN string for database connection</span>            </li>
  187.                     <li>
  188.                 <span class="var-type">array</span>
  189.                 <span class="var-name">$CustomTables</span><span class="var-description">: Custom table definitions</span>            </li>
  190.                     <li>
  191.                 <span class="var-type">boolean</span>
  192.                 <span class="var-name">$force</span><span class="var-description">: If true, the table is dropped without checks</span>            </li>
  193.                 </ul>
  194.  
  195.  
  196. </div>
  197. <a name="functionremoveTranslation" id="functionremoveTranslation"><!-- --></a>
  198. <div class="oddrow">
  199.  
  200.     <div>
  201.         <span class="method-title">removeTranslation</span> (line <span class="line-number">255</span>)
  202.     </div>
  203.  
  204.     <!-- ========== Info from phpDoc block ========= -->
  205. <p class="short-description">Translation removal</p>
  206. <p class="description"><p>Removes string from all of string tables</p></p>
  207.     <ul class="tags">
  208.                 <li><span class="field">return:</span> Return 1 if everything went OK, a PEAR::DB_Error object if not.</li>
  209.             </ul>
  210.  
  211.     <div class="method-signature">
  212.         <span class="method-result">mixed</span>
  213.         <span class="method-name">
  214.             removeTranslation
  215.         </span>
  216.                     (<span class="var-type">string</span> <span class="var-name">$PageID</span>, <span class="var-type">string</span> <span class="var-name">$StringID</span>, <span class="var-type">string</span> <span class="var-name">$pear_DSN</span>, [<span class="var-type">array</span> <span class="var-name">$CustomTables</span> = <span class="var-default">0</span>])
  217.             </div>
  218.  
  219.             <ul class="parameters">
  220.                     <li>
  221.                 <span class="var-type">string</span>
  222.                 <span class="var-name">$PageID</span><span class="var-description">: page identifier.</span>            </li>
  223.                     <li>
  224.                 <span class="var-type">string</span>
  225.                 <span class="var-name">$StringID</span><span class="var-description">: string identifier.</span>            </li>
  226.                     <li>
  227.                 <span class="var-type">string</span>
  228.                 <span class="var-name">$pear_DSN</span><span class="var-description">: PEAR DSN string for database connection</span>            </li>
  229.                     <li>
  230.                 <span class="var-type">array</span>
  231.                 <span class="var-name">$CustomTables</span><span class="var-description">: Custom table definitions</span>            </li>
  232.                 </ul>
  233.  
  234.  
  235. </div>
  236. <a name="functionsetDefaultTableDefinitions" id="functionsetDefaultTableDefinitions"><!-- --></a>
  237. <div class="evenrow">
  238.  
  239.     <div>
  240.         <span class="method-title">setDefaultTableDefinitions</span> (line <span class="line-number">24</span>)
  241.     </div>
  242.  
  243.     <!-- ========== Info from phpDoc block ========= -->
  244. <p class="short-description">helper method</p>
  245.  
  246.     <div class="method-signature">
  247.         <span class="method-result">void</span>
  248.         <span class="method-name">
  249.             setDefaultTableDefinitions
  250.         </span>
  251.                     (<span class="var-type">mixed</span> <span class="var-name">$LangID</span>, <span class="var-type">mixed</span> <span class="var-name">$CustomTables</span>)
  252.             </div>
  253.  
  254.  
  255.  
  256. </div>
  257.         </div>
  258.     </div>
  259.  
  260.     <p class="notes" id="credit">
  261.         Documentation generated on Tue, 20 Jan 2004 22:54:55 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.3</a>
  262.     </p>
  263.     </div></body>
  264. </html>