[Xunsearch PHP-SDK](http://www.xunsearch.com) v1.4.8 API 参考文档
# API 参考文档
<table class="summaryTable docIndex"><colgroup><col class="col-package" /><col class="col-class" /><col class="col-description" /></colgroup><tr><th>包</th><th>类对象</th><th>描述</th></tr><tr><td rowspan="11"><a name="XS" id="XS"></a>XS</td> <td><a href="XS.html">XS</a></td> <td>XS 搜索项目主类</td></tr><tr><td><a href="XSCommand.html">XSCommand</a></td> <td>XSCommand 命令对象</td></tr><tr><td><a href="XSComponent.html">XSComponent</a></td> <td>XS 组件基类</td></tr><tr><td><a href="XSDocument.html">XSDocument</a></td> <td>文档用于描述检索/索引的基础对象, 包含一组字段及其值, 相当于常规SQL数据表中的一行记录.</td></tr><tr><td><a href="XSErrorException.html">XSErrorException</a></td> <td>XS 错误异常类定义, XS 所有操作过程发生错误均抛出该实例</td></tr><tr><td><a href="XSException.html">XSException</a></td> <td>XS 异常类定义, XS 所有操作过程发生异常均抛出该实例</td></tr><tr><td><a href="XSFieldMeta.html">XSFieldMeta</a></td> <td>数据字段结构元数据</td></tr><tr><td><a href="XSFieldScheme.html">XSFieldScheme</a></td> <td>XS 数据字段方案</td></tr><tr><td><a href="XSIndex.html">XSIndex</a></td> <td>XS 索引管理</td></tr><tr><td><a href="XSSearch.html">XSSearch</a></td> <td>XS 搜索类, 执行搜索功能</td></tr><tr><td><a href="XSServer.html">XSServer</a></td> <td>XSServer 服务器操作对象</td></tr><tr><td rowspan="7"><a name="XS.tokenizer" id="XS.tokenizer"></a>XS.tokenizer</td> <td><a href="XSTokenizer.html">XSTokenizer</a></td> <td>自定义字段词法分析器接口</td></tr><tr><td><a href="XSTokenizerFull.html">XSTokenizerFull</a></td> <td>内置整值分词器</td></tr><tr><td><a href="XSTokenizerNone.html">XSTokenizerNone</a></td> <td>内置空分词器</td></tr><tr><td><a href="XSTokenizerScws.html">XSTokenizerScws</a></td> <td>SCWS - 分词器(与搜索服务端通讯)</td></tr><tr><td><a href="XSTokenizerSplit.html">XSTokenizerSplit</a></td> <td>内置的分割分词器</td></tr><tr><td><a href="XSTokenizerXlen.html">XSTokenizerXlen</a></td> <td>内置的定长分词器</td></tr><tr><td><a href="XSTokenizerXstep.html">XSTokenizerXstep</a></td> <td>内置的步长分词器</td></tr><tr><td rowspan="6"><a name="XS.util" id="XS.util"></a>XS.util</td> <td><a href="XSCsvDataSource.html">XSCsvDataSource</a></td> <td>CSV 数据源</td></tr><tr><td><a href="XSDataFilter.html">XSDataFilter</a></td> <td>数据过滤器的接口</td></tr><tr><td><a href="XSDatabaseDataSource.html">XSDatabaseDataSource</a></td> <td>SQL 数据库源</td></tr><tr><td><a href="XSDebugFilter.html">XSDebugFilter</a></td> <td>内置调试过滤器, 直接打印数据内容</td></tr><tr><td><a href="XSJsonDataSource.html">XSJsonDataSource</a></td> <td>JSON 数据源</td></tr><tr><td><a href="XSUtil.html">XSUtil</a></td> <td>XSUtil 工具程序通用代码</td></tr><tr><td rowspan="10"><a name="XS.util.db" id="XS.util.db"></a>XS.util.db</td> <td><a href="XSDatabase.html">XSDatabase</a></td> <td>数据库操作基类</td></tr><tr><td><a href="XSDatabaseMySQL.html">XSDatabaseMySQL</a></td> <td>使用传统 MySQL 扩展</td></tr><tr><td><a href="XSDatabaseMySQLI.html">XSDatabaseMySQLI</a></td> <td>面向对象的 MySQLI 扩展</td></tr><tr><td><a href="XSDatabasePDO.html">XSDatabasePDO</a></td> <td>面向对象的 PDO 扩展基类</td></tr><tr><td><a href="XSDatabasePDO_MySQL.html">XSDatabasePDO_MySQL</a></td> <td>PDO.MySQL 实现</td></tr><tr><td><a href="XSDatabasePDO_PgSQL.html">XSDatabasePDO_PgSQL</a></td> <td>PDO.Pgsql 实现</td></tr><tr><td><a href="XSDatabasePDO_SQLite.html">XSDatabasePDO_SQLite</a></td> <td>PDO.SQLite 实现</td></tr><tr><td><a href="XSDatabasePgSQL.html">XSDatabasePgSQL</a></td> <td>面向对象的 PostgreSQL 扩展</td></tr><tr><td><a href="XSDatabaseSQLite.html">XSDatabaseSQLite</a></td> <td>使用传统的 SQLite 扩展</td></tr><tr><td><a href="XSDatabaseSQLite3.html">XSDatabaseSQLite3</a></td> <td>面向对象的 SQLite3 扩展</td></tr><tr><td rowspan="1"><a name="XS.utilf" id="XS.utilf"></a>XS.utilf</td> <td><a href="XSDataSource.html">XSDataSource</a></td> <td>索引数据源抽象基类</td></tr></table>
Copyright © 2008-2011 by [杭州云圣网络科技有限公司](http://www.xunsearch.com)
All Rights Reserved.
- 权威指南
- 新手上路
- 最新主要变动
- 概述
- 关于 Xunsearch PHP-SDK
- 安装、升级
- 体验 demo 项目
- 开发规范
- 开发流程
- 了解基础对象
- 基础对象概述
- XS 项目
- XSException 异常
- XSDocument 文档
- XSIndex 索引管理
- XSSearch 搜索
- XSTokenizer 分词接口
- 编写项目配置文件
- 项目配置详解
- 自定义分词器
- 编写第一个配置文件
- 管理索引
- 索引概述
- 添加文档
- 更新、修改文档
- 删除文档
- 清空索引
- 平滑重建索引
- 使用索引缓冲区
- 自定义SCWS词库
- 使用搜索
- 搜索概述
- 构建搜索语句
- 获取搜索匹配结果
- 获取搜索匹配数量
- 获取热门搜索词
- 获取相关搜索词
- 搜索建议和纠错
- 按字段值分面搜索
- 使用辅助工具
- RequiredCheck 运行检测
- Indexer 索引管理器
- Quest 搜索测试工具
- SearchSkel 生成搜索代码
- IniWizzard 配置文件向导
- Logger 搜索日志管理
- 专题
- 同义词搜索功能
- 在SDK中使用SCWS分词
- API 指南
- XS
- XS
- XSCommand
- XSComponent
- XSDocument
- XSErrorException
- XSException
- XSFieldMeta
- XSFieldScheme
- XSIndex
- XSSearch
- XSServer
- XS.tokenizer
- XSTokenizer
- XSTokenizerFull
- XSTokenizerNone
- XSTokenizerScws
- XSTokenizerSplit
- XSTokenizerXlen
- XSTokenizerXstep
- XS.util
- XSCsvDataSource
- XSDataFilter
- XSDatabaseDataSource
- XSDebugFilter
- XSJsonDataSource
- XSUtil
- XS.util.db
- XSDatabase
- XSDatabaseMySQL
- XSDatabaseMySQLI
- XSDatabasePDO
- XSDatabasePDO_MySQL
- XSDatabasePDO_PgSQL
- XSDatabasePDO_SQLite
- XSDatabasePgSQL
- XSDatabaseSQLite
- XSDatabaseSQLite3
- XS.utilf
- XSDataSource
- 其它文档
- 关于 xunsearch
- 特色和优势
- Xunsearch 架构简图
- 下载 Xunsearch
- 商业服务与支持
- XunSearch 授权许可证