/libs/googleTranslate-1.7/docs/elementindex_GoogleTranslateWrapper.html

https://github.com/quimateur/SIFO · HTML · 212 lines · 210 code · 1 blank · 1 comment · 0 complexity · 54072e0f0b0483e60d4099dc961eda97 MD5 · raw file

  1. <?xml version="1.0" encoding="iso-8859-1"?>
  2. <!DOCTYPE html
  3. PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  4. "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  5. <html xmlns="http://www.w3.org/1999/xhtml">
  6. <head>
  7. <title></title>
  8. <link rel="stylesheet" href="media/stylesheet.css" />
  9. <!-- template designed by Julien Damon based on PHPEdit's generated templates, and tweaked by Greg Beaver -->
  10. <body bgcolor="#ffffff" ><a name="top"></a>
  11. <h2>Element Index, Package GoogleTranslateWrapper</h2>
  12. <ul>
  13. </ul>
  14. <a href="elementindex.html"><strong>Index of all elements</strong></a>
  15. <br />
  16. <a href="elementindex_GoogleTranslateWrapper.html#d">d</a>
  17. <a href="elementindex_GoogleTranslateWrapper.html#g">g</a>
  18. <a href="elementindex_GoogleTranslateWrapper.html#i">i</a>
  19. <a href="elementindex_GoogleTranslateWrapper.html#s">s</a>
  20. <a href="elementindex_GoogleTranslateWrapper.html#t">t</a>
  21. <a href="elementindex_GoogleTranslateWrapper.html#_">_</a>
  22. <br /><br />
  23. <table border="0" width="100%">
  24. <thead>
  25. <tr>
  26. <td><strong>_</strong></td>
  27. <td align='right'><a name="_">&nbsp; </a>
  28. <a href="#top">top</a><br /></td>
  29. </tr>
  30. </thead>
  31. <tbody>
  32. <tr>
  33. <td>&nbsp;&nbsp;&nbsp;<strong>$_apiKey</strong></td>
  34. <td width="100%" align="left" valign="top">in file googleTranslate.class.php, variable <a href="GoogleTranslateWrapper/GoogleTranslateWrapper.html#var$_apiKey">GoogleTranslateWrapper::$_apiKey</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Google API key</td>
  35. </tr>
  36. <tr>
  37. <td>&nbsp;&nbsp;&nbsp;<strong>$_chunks</strong></td>
  38. <td width="100%" align="left" valign="top">in file googleTranslate.class.php, variable <a href="GoogleTranslateWrapper/GoogleTranslateWrapper.html#var$_chunks">GoogleTranslateWrapper::$_chunks</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Chunk array</td>
  39. </tr>
  40. <tr>
  41. <td>&nbsp;&nbsp;&nbsp;<strong>$_currentChunk</strong></td>
  42. <td width="100%" align="left" valign="top">in file googleTranslate.class.php, variable <a href="GoogleTranslateWrapper/GoogleTranslateWrapper.html#var$_currentChunk">GoogleTranslateWrapper::$_currentChunk</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Current data chunk</td>
  43. </tr>
  44. <tr>
  45. <td>&nbsp;&nbsp;&nbsp;<strong>$_detectedSourceLanguage</strong></td>
  46. <td width="100%" align="left" valign="top">in file googleTranslate.class.php, variable <a href="GoogleTranslateWrapper/GoogleTranslateWrapper.html#var$_detectedSourceLanguage">GoogleTranslateWrapper::$_detectedSourceLanguage</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Detected source language</td>
  47. </tr>
  48. <tr>
  49. <td>&nbsp;&nbsp;&nbsp;<strong>$_fromLang</strong></td>
  50. <td width="100%" align="left" valign="top">in file googleTranslate.class.php, variable <a href="GoogleTranslateWrapper/GoogleTranslateWrapper.html#var$_fromLang">GoogleTranslateWrapper::$_fromLang</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Language to translate from</td>
  51. </tr>
  52. <tr>
  53. <td>&nbsp;&nbsp;&nbsp;<strong>$_googleDetectUrl</strong></td>
  54. <td width="100%" align="left" valign="top">in file googleTranslate.class.php, variable <a href="GoogleTranslateWrapper/GoogleTranslateWrapper.html#var$_googleDetectUrl">GoogleTranslateWrapper::$_googleDetectUrl</a><br>&nbsp;&nbsp;&nbsp;&nbsp;URL of Google language detection</td>
  55. </tr>
  56. <tr>
  57. <td>&nbsp;&nbsp;&nbsp;<strong>$_googleTranslateUrl</strong></td>
  58. <td width="100%" align="left" valign="top">in file googleTranslate.class.php, variable <a href="GoogleTranslateWrapper/GoogleTranslateWrapper.html#var$_googleTranslateUrl">GoogleTranslateWrapper::$_googleTranslateUrl</a><br>&nbsp;&nbsp;&nbsp;&nbsp;URL of Google translate</td>
  59. </tr>
  60. <tr>
  61. <td>&nbsp;&nbsp;&nbsp;<strong>$_ip</strong></td>
  62. <td width="100%" align="left" valign="top">in file googleTranslate.class.php, variable <a href="GoogleTranslateWrapper/GoogleTranslateWrapper.html#var$_ip">GoogleTranslateWrapper::$_ip</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Host IP address</td>
  63. </tr>
  64. <tr>
  65. <td>&nbsp;&nbsp;&nbsp;<strong>$_postFields</strong></td>
  66. <td width="100%" align="left" valign="top">in file googleTranslate.class.php, variable <a href="GoogleTranslateWrapper/GoogleTranslateWrapper.html#var$_postFields">GoogleTranslateWrapper::$_postFields</a><br>&nbsp;&nbsp;&nbsp;&nbsp;POST fields</td>
  67. </tr>
  68. <tr>
  69. <td>&nbsp;&nbsp;&nbsp;<strong>$_serviceError</strong></td>
  70. <td width="100%" align="left" valign="top">in file googleTranslate.class.php, variable <a href="GoogleTranslateWrapper/GoogleTranslateWrapper.html#var$_serviceError">GoogleTranslateWrapper::$_serviceError</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Service Error</td>
  71. </tr>
  72. <tr>
  73. <td>&nbsp;&nbsp;&nbsp;<strong>$_siteUrl</strong></td>
  74. <td width="100%" align="left" valign="top">in file googleTranslate.class.php, variable <a href="GoogleTranslateWrapper/GoogleTranslateWrapper.html#var$_siteUrl">GoogleTranslateWrapper::$_siteUrl</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Site url using the code</td>
  75. </tr>
  76. <tr>
  77. <td>&nbsp;&nbsp;&nbsp;<strong>$_stringLimit</strong></td>
  78. <td width="100%" align="left" valign="top">in file googleTranslate.class.php, variable <a href="GoogleTranslateWrapper/GoogleTranslateWrapper.html#var$_stringLimit">GoogleTranslateWrapper::$_stringLimit</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Translation character limit.</td>
  79. </tr>
  80. <tr>
  81. <td>&nbsp;&nbsp;&nbsp;<strong>$_success</strong></td>
  82. <td width="100%" align="left" valign="top">in file googleTranslate.class.php, variable <a href="GoogleTranslateWrapper/GoogleTranslateWrapper.html#var$_success">GoogleTranslateWrapper::$_success</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Translation success</td>
  83. </tr>
  84. <tr>
  85. <td>&nbsp;&nbsp;&nbsp;<strong>$_text</strong></td>
  86. <td width="100%" align="left" valign="top">in file googleTranslate.class.php, variable <a href="GoogleTranslateWrapper/GoogleTranslateWrapper.html#var$_text">GoogleTranslateWrapper::$_text</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Text to translate</td>
  87. </tr>
  88. <tr>
  89. <td>&nbsp;&nbsp;&nbsp;<strong>$_toLang</strong></td>
  90. <td width="100%" align="left" valign="top">in file googleTranslate.class.php, variable <a href="GoogleTranslateWrapper/GoogleTranslateWrapper.html#var$_toLang">GoogleTranslateWrapper::$_toLang</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Language to translate to</td>
  91. </tr>
  92. <tr>
  93. <td>&nbsp;&nbsp;&nbsp;<strong>$_totalChunks</strong></td>
  94. <td width="100%" align="left" valign="top">in file googleTranslate.class.php, variable <a href="GoogleTranslateWrapper/GoogleTranslateWrapper.html#var$_totalChunks">GoogleTranslateWrapper::$_totalChunks</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Total chunks</td>
  95. </tr>
  96. <tr>
  97. <td>&nbsp;&nbsp;&nbsp;<strong>$_translatedText</strong></td>
  98. <td width="100%" align="left" valign="top">in file googleTranslate.class.php, variable <a href="GoogleTranslateWrapper/GoogleTranslateWrapper.html#var$_translatedText">GoogleTranslateWrapper::$_translatedText</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Translated Text</td>
  99. </tr>
  100. <tr>
  101. <td>&nbsp;&nbsp;&nbsp;<strong>$_version</strong></td>
  102. <td width="100%" align="left" valign="top">in file googleTranslate.class.php, variable <a href="GoogleTranslateWrapper/GoogleTranslateWrapper.html#var$_version">GoogleTranslateWrapper::$_version</a><br>&nbsp;&nbsp;&nbsp;&nbsp;API version</td>
  103. </tr>
  104. <tr>
  105. <td>&nbsp;&nbsp;&nbsp;<strong>_composeUrl</strong></td>
  106. <td width="100%" align="left" valign="top">in file googleTranslate.class.php, method <a href="GoogleTranslateWrapper/GoogleTranslateWrapper.html#method_composeUrl">GoogleTranslateWrapper::_composeUrl()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Build a POST url to query Google</td>
  107. </tr>
  108. <tr>
  109. <td>&nbsp;&nbsp;&nbsp;<strong>_remoteQuery</strong></td>
  110. <td width="100%" align="left" valign="top">in file googleTranslate.class.php, method <a href="GoogleTranslateWrapper/GoogleTranslateWrapper.html#method_remoteQuery">GoogleTranslateWrapper::_remoteQuery()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Process the built query using cURL and POST</td>
  111. </tr>
  112. <tr>
  113. <td>&nbsp;&nbsp;&nbsp;<strong>_remoteQueryDetect</strong></td>
  114. <td width="100%" align="left" valign="top">in file googleTranslate.class.php, method <a href="GoogleTranslateWrapper/GoogleTranslateWrapper.html#method_remoteQueryDetect">GoogleTranslateWrapper::_remoteQueryDetect()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Process the built query using cURL and GET</td>
  115. </tr>
  116. </tbody>
  117. <thead>
  118. <tr>
  119. <td><strong>d</strong></td>
  120. <td align='right'><a name="d">&nbsp; </a>
  121. <a href="#top">top</a><br /></td>
  122. </tr>
  123. </thead>
  124. <tbody>
  125. <tr>
  126. <td>&nbsp;&nbsp;&nbsp;<strong>DETECT</strong></td>
  127. <td width="100%" align="left" valign="top">in file googleTranslate.class.php, class constant <a href="GoogleTranslateWrapper/GoogleTranslateWrapper.html#constDETECT">GoogleTranslateWrapper::DETECT</a></td>
  128. </tr>
  129. <tr>
  130. <td>&nbsp;&nbsp;&nbsp;<strong>detectLanguage</strong></td>
  131. <td width="100%" align="left" valign="top">in file googleTranslate.class.php, method <a href="GoogleTranslateWrapper/GoogleTranslateWrapper.html#methoddetectLanguage">GoogleTranslateWrapper::detectLanguage()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Detect the language of the given text</td>
  132. </tr>
  133. </tbody>
  134. <thead>
  135. <tr>
  136. <td><strong>g</strong></td>
  137. <td align='right'><a name="g">&nbsp; </a>
  138. <a href="#top">top</a><br /></td>
  139. </tr>
  140. </thead>
  141. <tbody>
  142. <tr>
  143. <td>&nbsp;&nbsp;&nbsp;<strong>getDetectedSource</strong></td>
  144. <td width="100%" align="left" valign="top">in file googleTranslate.class.php, method <a href="GoogleTranslateWrapper/GoogleTranslateWrapper.html#methodgetDetectedSource">GoogleTranslateWrapper::getDetectedSource()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Get the detected source language, if the source is not provided during query</td>
  145. </tr>
  146. <tr>
  147. <td>&nbsp;&nbsp;&nbsp;<strong>getLastError</strong></td>
  148. <td width="100%" align="left" valign="top">in file googleTranslate.class.php, method <a href="GoogleTranslateWrapper/GoogleTranslateWrapper.html#methodgetLastError">GoogleTranslateWrapper::getLastError()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Get the last generated service error</td>
  149. </tr>
  150. <tr>
  151. <td>&nbsp;&nbsp;&nbsp;<strong>googleTranslate.class.php</strong></td>
  152. <td width="100%" align="left" valign="top">procedural page <a href="GoogleTranslateWrapper/_googleTranslate.class.php.html">googleTranslate.class.php</a></td>
  153. </tr>
  154. <tr>
  155. <td>&nbsp;&nbsp;&nbsp;<strong>GoogleTranslateWrapper</strong></td>
  156. <td width="100%" align="left" valign="top">in file googleTranslate.class.php, class <a href="GoogleTranslateWrapper/GoogleTranslateWrapper.html">GoogleTranslateWrapper</a><br>&nbsp;&nbsp;&nbsp;&nbsp;GoogleTranslateWrapper Main Class</td>
  157. </tr>
  158. </tbody>
  159. <thead>
  160. <tr>
  161. <td><strong>i</strong></td>
  162. <td align='right'><a name="i">&nbsp; </a>
  163. <a href="#top">top</a><br /></td>
  164. </tr>
  165. </thead>
  166. <tbody>
  167. <tr>
  168. <td>&nbsp;&nbsp;&nbsp;<strong>isSuccess</strong></td>
  169. <td width="100%" align="left" valign="top">in file googleTranslate.class.php, method <a href="GoogleTranslateWrapper/GoogleTranslateWrapper.html#methodisSuccess">GoogleTranslateWrapper::isSuccess()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Check if the last translation was a success</td>
  170. </tr>
  171. </tbody>
  172. <thead>
  173. <tr>
  174. <td><strong>s</strong></td>
  175. <td align='right'><a name="s">&nbsp; </a>
  176. <a href="#top">top</a><br /></td>
  177. </tr>
  178. </thead>
  179. <tbody>
  180. <tr>
  181. <td>&nbsp;&nbsp;&nbsp;<strong>selfTest</strong></td>
  182. <td width="100%" align="left" valign="top">in file googleTranslate.class.php, method <a href="GoogleTranslateWrapper/GoogleTranslateWrapper.html#methodselfTest">GoogleTranslateWrapper::selfTest()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Self test the class</td>
  183. </tr>
  184. <tr>
  185. <td>&nbsp;&nbsp;&nbsp;<strong>setCredentials</strong></td>
  186. <td width="100%" align="left" valign="top">in file googleTranslate.class.php, method <a href="GoogleTranslateWrapper/GoogleTranslateWrapper.html#methodsetCredentials">GoogleTranslateWrapper::setCredentials()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Set credentials (optional) when accessing Google translation services</td>
  187. </tr>
  188. <tr>
  189. <td>&nbsp;&nbsp;&nbsp;<strong>setReferrer</strong></td>
  190. <td width="100%" align="left" valign="top">in file googleTranslate.class.php, method <a href="GoogleTranslateWrapper/GoogleTranslateWrapper.html#methodsetReferrer">GoogleTranslateWrapper::setReferrer()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Set Referrer header</td>
  191. </tr>
  192. </tbody>
  193. <thead>
  194. <tr>
  195. <td><strong>t</strong></td>
  196. <td align='right'><a name="t">&nbsp; </a>
  197. <a href="#top">top</a><br /></td>
  198. </tr>
  199. </thead>
  200. <tbody>
  201. <tr>
  202. <td>&nbsp;&nbsp;&nbsp;<strong>translate</strong></td>
  203. <td width="100%" align="left" valign="top">in file googleTranslate.class.php, method <a href="GoogleTranslateWrapper/GoogleTranslateWrapper.html#methodtranslate">GoogleTranslateWrapper::translate()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Translate the given text</td>
  204. </tr>
  205. <tr>
  206. <td>&nbsp;&nbsp;&nbsp;<strong>TRANSLATE</strong></td>
  207. <td width="100%" align="left" valign="top">in file googleTranslate.class.php, class constant <a href="GoogleTranslateWrapper/GoogleTranslateWrapper.html#constTRANSLATE">GoogleTranslateWrapper::TRANSLATE</a></td>
  208. </tr>
  209. </tbody>
  210. </table></body>
  211. </html>