[Xunsearch PHP-SDK](http://www.xunsearch.com) v1.4.8 權威指南
1. [主要參數和選項](#)
1. [經典用法示例](#)
1. [生成的代碼介紹](#)
# 生成搜索骨架代碼
前面已經把 `Xunsearch PHP-SDK` 相關的基礎文檔全面講了一通,您完全可以根據文檔和自動生成的 `API` 文檔進行搜索開發了。
但根據我們研發 [Xungle 項目](http://www.xungle.com) 的實踐經驗,絕大多數搜索項目的前端代碼都類似,不同的均為細節顯示、字段使用等。因此為了更快的加速用戶開發速度,我們特地推出這個代碼生成工具。
這個工具讀取并分析項目配置文件(`*.ini`),生成通用的搜索骨架代碼,即使您不做任何修改,也能使用它并看到基礎的搜索效果、界面。強烈建議所有的搜索項目都在生成的骨架代碼上進行二次開發,節省大量寶貴時間。
運行腳本工具的 --help 選項可查看內置的幫助和說明,輸出文字編碼強制為 UTF-8。
~~~
$prefix/sdk/php/util/SearchSkel.php --help
~~~
### 1. 主要參數和選項[?]()
要使用本工具,必須先指定的項目名稱或配置文件,它將根據該項目的情況生成代碼,主要選項如下:
-
*-p|--project <name|file>* 指定項目名稱或配置文件路徑,參數名可以省略不寫,如果僅指定項目名稱,那么將使用 $prefix/sdk/php/app/.ini 文件。
-
*-o|--output <..dir..>* 指定生成的代碼目錄的存放位置,默認放在當前目錄中,生成的代碼本身包含一層以項目名稱命名的目錄。建議直接將目錄指定到 web 可訪問目錄。
### 2. 經典用法示例[?]()
~~~
# 在當前目錄下生成 demo 項目的搜索代碼
util/SearchSkel.php demo
# 在指定的 /path/to/web 目錄生成 demo 搜索代碼,代碼目錄為:/path/to/web/demo
util/SearchSkel.php demo /path/to/web
# 使用選項指定方式
util/SearchSkel.php -p demo -o /path/to/web
~~~
### 3. 生成的代碼介紹[?]()
工具運行完畢后,立即生成以下三個文件于目錄中,如果文件已經存在,則會把舊有文件保存為 `.bak` 文件用于備份。
~~~
[demo]
|- search.php # 搜索功能入口
|- search.tpl # 搜索結果輸出模板文件
\- suggest.php # 提取搜索輸入框下拉建議,通過 autocomplete 組件自動調用
~~~
您可以直接通過瀏覽器訪問:search.php 試用搜索。
> **Note:** 生成的代碼中關于搜索建議的部分,采用 jQuery-UI 的 autocomplete 并且從 Google 提供的代碼庫 直接加載,如果您的不能連網將可能無法看到部分效果。您可以將相關的 js/css 下載到本地并替換模板代碼。
$Id$
[? Quest 搜索測試工具](#)
[IniWizzard 配置文件向導 ?](#)
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 授權許可證