[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.



- 權威指南
- 新手上路
- 最新主要變動
- 概述
- 關于 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 授權許可證