[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.
![](https://box.kancloud.cn/2015-09-10_55f11d0580ed6.gif)
![](https://box.kancloud.cn/2015-09-10_55f11d05881e9.gif)
![](https://box.kancloud.cn/2015-09-10_55f11d058eb73.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 授权许可证