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