index.html 5.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/html; charset=gbk" />
  5. <meta name="language" content="zh-cn" />
  6. <link rel="stylesheet" type="text/css" href="css/style.css" />
  7. <link rel="stylesheet" type="text/css" href="css/api.css" />
  8. <script type="text/javascript" src="js/jquery.js"></script>
  9. <title>Xunsearch PHP-SDK API 文档</title>
  10. </head>
  11. <body>
  12. <div id="apiPage">
  13. <div id="apiHeader">
  14. <a href="http://www.xunsearch.com" target="_blank">Xunsearch PHP-SDK</a> v1.3.2 API 参考文档
  15. </div><!-- end of header -->
  16. <div id="content" class="api-index">
  17. <h1>API 参考文档</h1>
  18. <table class="summaryTable docIndex">
  19. <colgroup>
  20. <col class="col-package" />
  21. <col class="col-class" />
  22. <col class="col-description" />
  23. </colgroup>
  24. <tr>
  25. <th>包</th><th>类对象</th><th>描述</th>
  26. </tr>
  27. <tr>
  28. <td rowspan="11"><a name="XS"></a>XS</td>
  29. <td><a href="XS.html">XS</a></td>
  30. <td>XS 搜索项目主类</td>
  31. </tr>
  32. <tr>
  33. <td><a href="XSCommand.html">XSCommand</a></td>
  34. <td>XSCommand 命令对象</td>
  35. </tr>
  36. <tr>
  37. <td><a href="XSComponent.html">XSComponent</a></td>
  38. <td>XS 组件基类</td>
  39. </tr>
  40. <tr>
  41. <td><a href="XSDocument.html">XSDocument</a></td>
  42. <td>文档用于描述检索/索引的基础对象, 包含一组字段及其值, 相当于常规SQL数据表中的一行记录.</td>
  43. </tr>
  44. <tr>
  45. <td><a href="XSErrorException.html">XSErrorException</a></td>
  46. <td>XS 错误异常类定义, XS 所有操作过程发生错误均抛出该实例</td>
  47. </tr>
  48. <tr>
  49. <td><a href="XSException.html">XSException</a></td>
  50. <td>XS 异常类定义, XS 所有操作过程发生异常均抛出该实例</td>
  51. </tr>
  52. <tr>
  53. <td><a href="XSFieldMeta.html">XSFieldMeta</a></td>
  54. <td>数据字段结构元数据</td>
  55. </tr>
  56. <tr>
  57. <td><a href="XSFieldScheme.html">XSFieldScheme</a></td>
  58. <td>XS 数据字段方案</td>
  59. </tr>
  60. <tr>
  61. <td><a href="XSIndex.html">XSIndex</a></td>
  62. <td>XS 索引管理</td>
  63. </tr>
  64. <tr>
  65. <td><a href="XSSearch.html">XSSearch</a></td>
  66. <td>XS 搜索类, 执行搜索功能</td>
  67. </tr>
  68. <tr>
  69. <td><a href="XSServer.html">XSServer</a></td>
  70. <td>XSServer 服务器操作对象</td>
  71. </tr>
  72. <tr>
  73. <td rowspan="7"><a name="XS.tokenizer"></a>XS.tokenizer</td>
  74. <td><a href="XSTokenizer.html">XSTokenizer</a></td>
  75. <td>自定义字段词法分析器接口</td>
  76. </tr>
  77. <tr>
  78. <td><a href="XSTokenizerFull.html">XSTokenizerFull</a></td>
  79. <td>内置整值分词器</td>
  80. </tr>
  81. <tr>
  82. <td><a href="XSTokenizerNone.html">XSTokenizerNone</a></td>
  83. <td>内置空分词器</td>
  84. </tr>
  85. <tr>
  86. <td><a href="XSTokenizerScws.html">XSTokenizerScws</a></td>
  87. <td>SCWS - 分词器(与搜索服务端通讯)</td>
  88. </tr>
  89. <tr>
  90. <td><a href="XSTokenizerSplit.html">XSTokenizerSplit</a></td>
  91. <td>内置的分割分词器</td>
  92. </tr>
  93. <tr>
  94. <td><a href="XSTokenizerXlen.html">XSTokenizerXlen</a></td>
  95. <td>内置的定长分词器</td>
  96. </tr>
  97. <tr>
  98. <td><a href="XSTokenizerXstep.html">XSTokenizerXstep</a></td>
  99. <td>内置的步长分词器</td>
  100. </tr>
  101. <tr>
  102. <td rowspan="6"><a name="XS.util"></a>XS.util</td>
  103. <td><a href="XSCsvDataSource.html">XSCsvDataSource</a></td>
  104. <td>CSV 数据源</td>
  105. </tr>
  106. <tr>
  107. <td><a href="XSDataFilter.html">XSDataFilter</a></td>
  108. <td>数据过滤器的接口</td>
  109. </tr>
  110. <tr>
  111. <td><a href="XSDatabaseDataSource.html">XSDatabaseDataSource</a></td>
  112. <td>SQL 数据库源</td>
  113. </tr>
  114. <tr>
  115. <td><a href="XSDebugFilter.html">XSDebugFilter</a></td>
  116. <td>内置调试过滤器, 直接打印数据内容</td>
  117. </tr>
  118. <tr>
  119. <td><a href="XSJsonDataSource.html">XSJsonDataSource</a></td>
  120. <td>JSON 数据源</td>
  121. </tr>
  122. <tr>
  123. <td><a href="XSUtil.html">XSUtil</a></td>
  124. <td>XSUtil 工具程序通用代码</td>
  125. </tr>
  126. <tr>
  127. <td rowspan="8"><a name="XS.util.db"></a>XS.util.db</td>
  128. <td><a href="XSDatabase.html">XSDatabase</a></td>
  129. <td>数据库操作基类</td>
  130. </tr>
  131. <tr>
  132. <td><a href="XSDatabaseMySQL.html">XSDatabaseMySQL</a></td>
  133. <td>使用传统 MySQL 扩展</td>
  134. </tr>
  135. <tr>
  136. <td><a href="XSDatabaseMySQLI.html">XSDatabaseMySQLI</a></td>
  137. <td>面向对象的 MySQLI 扩展</td>
  138. </tr>
  139. <tr>
  140. <td><a href="XSDatabasePDO.html">XSDatabasePDO</a></td>
  141. <td>面向对象的 PDO 扩展基类</td>
  142. </tr>
  143. <tr>
  144. <td><a href="XSDatabasePDO_MySQL.html">XSDatabasePDO_MySQL</a></td>
  145. <td>PDO.MySQL 实现</td>
  146. </tr>
  147. <tr>
  148. <td><a href="XSDatabasePDO_SQLite.html">XSDatabasePDO_SQLite</a></td>
  149. <td>PDO.SQLite 实现</td>
  150. </tr>
  151. <tr>
  152. <td><a href="XSDatabaseSQLite.html">XSDatabaseSQLite</a></td>
  153. <td>使用传统的 SQLite 扩展</td>
  154. </tr>
  155. <tr>
  156. <td><a href="XSDatabaseSQLite3.html">XSDatabaseSQLite3</a></td>
  157. <td>面向对象的 SQLite3 扩展</td>
  158. </tr>
  159. <tr>
  160. <td rowspan="1"><a name="XS.utilf"></a>XS.utilf</td>
  161. <td><a href="XSDataSource.html">XSDataSource</a></td>
  162. <td>索引数据源抽象基类</td>
  163. </tr>
  164. </table>
  165. </div><!-- end of content -->
  166. <div id="apiFooter">
  167. Copyright &copy; 2008-2011 by <a href="http://www.xunsearch.com" target="_blank">杭州云圣网络科技有限公司</a><br/>
  168. All Rights Reserved.<br/>
  169. </div><!-- end of footer -->
  170. <script type="text/javascript">
  171. /*<![CDATA[*/
  172. $("a.toggle").toggle(function(){
  173. $(this).text($(this).text().replace(/Hide/,'Show'));
  174. $(this).parents(".summary").find(".inherited").hide();
  175. },function(){
  176. $(this).text($(this).text().replace(/Show/,'Hide'));
  177. $(this).parents(".summary").find(".inherited").show();
  178. });
  179. $(".sourceCode a.show").toggle(function(){
  180. $(this).text($(this).text().replace(/show/,'hide'));
  181. $(this).parents(".sourceCode").find("div.code").show();
  182. },function(){
  183. $(this).text($(this).text().replace(/hide/,'show'));
  184. $(this).parents(".sourceCode").find("div.code").hide();
  185. });
  186. $("a.sourceLink").click(function(){
  187. $(this).attr('target','_blank');
  188. });
  189. /*]]>*/
  190. </script>
  191. </div><!-- end of page -->
  192. </body>
  193. </html>