[Xunsearch PHP-SDK](http://www.xunsearch.com) v1.4.8 權威指南
1. [創建 XS 對象](#)
1. [重要屬性](#)
# XS 項目
[XS](#) 是搜索項目的總對象,所有操作均基于此對象或其屬性,在此我們只挑最常用的一些屬性、方法進行介紹。
### 1. 創建 XS 對象[?]()
創建 XS 對象的唯一參數是項目配置文件的可訪問路徑,或者項目名,也可以是項目配置文件的內容。如果給出的參數是項目名則自動使用 `$prefix/sdk/php/app/項目名.ini`,例子代碼如下:
~~~
require_once '$prefix/sdk/php/lib/XS.php';
$xs = new XS('demo'); // 自動使用 $prefix/sdk/php/app/demo.ini 作項目配置文件
$xs = new XS('/path/to/demo.ini'); // 使用 /path/to/demo.ini
~~~
### 2. 重要屬性[?]()
-
[XS::defaultCharset](#)**項目默認字符集**影響范圍包括使用時的輸入數據以及搜索結果的輸出數據,該屬性默認由配置文件中的`project.default_charset` 指定,如有必要可以自行修改,但要確保在使用索引、搜索對象之前。
-
[XS::index](#)**索引管理對象**類型為 [XSIndex](#),比如用下面代碼可以清空項目索引內容:
~~~
$xs->index->clean();
~~~
-
[XS::search](#)**搜索對象**類型為 [XSSearch](#),比如用下面代碼可以快速檢索包含 `hightman` 的結果
~~~
$docs = $xs->search->search('hightman');
print_r($docs);
~~~
$Id$
[? 基礎對象概述](#)
[XSException 異常 ?](#)
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 授權許可證