[Xunsearch PHP-SDK](http://www.xunsearch.com) v1.4.8 权威指南
# 基础对象概述
`Xunsearch PHP-SDK` 全面采用面向对象(`OOP`)的开发方式。本章节将简单介绍开发过程中要接触到的几个重要对象(类)。
- [XS](#) 搜索项目的总对象,所有操作均基于此对象或其属性。
- [XSException](#) 所有操作中出现的异常、错误均抛出此类型的异常,搜索代码中应该尝试捕捉该异常以确定操作是否成功。
- [XSDocument](#) 文档用于描述检索/索引的基础对象,包含一组字段及其值,相当于常规SQL数据表中的一行记录。
- [XSIndex](#) 提供索引添加/删除/修改功能,通常以 `XS` 对象的属性方式出现,参见 [XS::index](#)。
- [XSSearch](#) 提供各种搜索功能,通常以 `XS` 对象的属性方式出现,参见 [XS::search](#)。
- [XSTokenizer](#) 自定义字段词法分析器接口。
### 类对象中的魔术属性
通过 PHP 对象中的 __get 和 __set 技巧,我们针对所有 [XSComponent](#) 的子类实现了对象的模拟属性。这类读取或写入属性值时实际上是隐含调用了相应的 getter/setter 方法,这类属性不区分大小写。
~~~
$a = $obj->text; // $a 值等于 $obj->getText() 的返回值
$obj->text = $a; // 等同事调用 $obj->setText($a)
~~~
支持这类属性的对象主要包括以下几个(不全,仅挑重要的列出):
- [XS::index](#) 项目索引对象:$xs->index
- [XS::search](#) 项目搜索对象:$xs->search
- [XS::defaultCharset](#) 项目默认字符集:$xs->defaultCharset
- [XSSearch::dbTotal](#) 搜索数据库内的数据总量:$xs->search->dbTotal
- [XSSearch::lastCount](#) 最近一次搜索的结果匹配总数估算值:$xs->search->lastCount
- [XSSearch::query](#) 搜索语句:$xs->search->query
$Id$
[« 开发流程](#)
[XS 项目 »](#)
Copyright © 2008-2011 by [杭州云圣网络科技有限公司](http://www.xunsearch.com)
All Rights Reserved.
![](https://box.kancloud.cn/2015-09-10_55f11d01ace58.gif)
![](https://box.kancloud.cn/2015-09-10_55f11d01b9bb8.gif)
![](https://box.kancloud.cn/2015-09-10_55f11d01c0ffe.gif)
- 权威指南
- 新手上路
- 最新主要变动
- 概述
- 关于 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 授权许可证