<h1 >XSSearch</h1><p><a href="http://www.xunsearch.com/doc/php/api/" >All Packages</a>|<a href="http://www.xunsearch.com/doc/php/api/XSSearch#properties" >属性</a>|<a href="http://www.xunsearch.com/doc/php/api/XSSearch#methods" >方法(函数)</a></p><table class="summaryTable docClass" width="1903" ><colgroup ><col class="col-name" /><col class="col-value" /></colgroup><tbody ><tr class="firstRow"><th >包</th><td ><a href="http://www.xunsearch.com/doc/php/api/#XS" >XS</a></td></tr><tr ><th >继承关系</th><td >class XSSearch »<a href="http://www.xunsearch.com/doc/php/api/XSServer" >XSServer</a>»<a href="http://www.xunsearch.com/doc/php/api/XSComponent" >XSComponent</a></td></tr><tr ><th >版本</th><td >1.0.0</td></tr><tr ><th >源代码</th><td ><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php" >sdk/php/lib/XSSearch.class.php</a></td></tr></tbody></table><p>XS 搜索类, 执行搜索功能 有部分方法支持串接操作</p><pre >$xs->search->setQuery($str)->setLimit(10,10)->search();
$xs->close();</pre><p><a ></a><span ></span></p><h2 >Public 属性</h2><p ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="toggle" >隐去继承来的属性</a></p><table class="summaryTable" width="1903" ><colgroup ><col class="col-property" /><col class="col-type" /><col class="col-description" /><col class="col-defined" /></colgroup><tbody ><tr class="firstRow"><th >名称</th><th >类型</th><th >描述</th><th >定义于</th></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#allSynonyms-detail" >allSynonyms</a></td><td >array</td><td >获取当前库内的全部同义词列表</td><td >XSSearch</td></tr><tr class="inherited" ><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer#connString-detail" >connString</a></td><td >string</td><td >连接字符串</td><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer" >XSServer</a></td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#correctedQuery-detail" >correctedQuery</a></td><td >array</td><td >获取修正后的搜索词列表</td><td >XSSearch</td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#dbTotal-detail" >dbTotal</a></td><td >int</td><td >获取搜索数据库内的数据总量</td><td >XSSearch</td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#facets-detail" >facets</a></td><td >array</td><td >读取最近一次分面搜索记数</td><td >XSSearch</td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#hotQuery-detail" >hotQuery</a></td><td >array</td><td >获取热门搜索词列表</td><td >XSSearch</td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#lastCount-detail" >lastCount</a></td><td >int</td><td >获取最近那次搜索的匹配总数估值</td><td >XSSearch</td></tr><tr class="inherited" ><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer#project-detail" >project</a></td><td >string</td><td >获取当前项目名称</td><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer" >XSServer</a></td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#query-detail" >query</a></td><td >string</td><td >获取解析后的搜索语句</td><td >XSSearch</td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#relatedQuery-detail" >relatedQuery</a></td><td >array</td><td >获取相关搜索词列表</td><td >XSSearch</td></tr><tr class="inherited" ><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer#respond-detail" >respond</a></td><td ><a href="http://www.xunsearch.com/doc/php/api/XSCommand" >XSCommand</a></td><td >从服务器读取响应指令</td><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer" >XSServer</a></td></tr><tr class="inherited" ><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer#socket-detail" >socket</a></td><td >mixed</td><td >获取连接资源描述符</td><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer" >XSServer</a></td></tr><tr class="inherited" ><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer#xs-detail" >xs</a></td><td ><a href="http://www.xunsearch.com/doc/php/api/XS" >XS</a></td><td >服务端关联的 XS 对象</td><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer" >XSServer</a></td></tr></tbody></table><h2 >Protected 属性</h2><p ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="toggle" >隐去继承来的属性</a></p><table class="summaryTable" width="1903" ><colgroup ><col class="col-property" /><col class="col-type" /><col class="col-description" /><col class="col-defined" /></colgroup><tbody ><tr class="firstRow"><th >名称</th><th >类型</th><th >描述</th><th >定义于</th></tr><tr class="inherited" ><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer#_conn-detail" >_conn</a></td><td ><br/></td><td ><br/></td><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer" >XSServer</a></td></tr><tr class="inherited" ><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer#_flag-detail" >_flag</a></td><td ><br/></td><td ><br/></td><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer" >XSServer</a></td></tr><tr class="inherited" ><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer#_project-detail" >_project</a></td><td ><br/></td><td ><br/></td><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer" >XSServer</a></td></tr><tr class="inherited" ><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer#_sendBuffer-detail" >_sendBuffer</a></td><td ><br/></td><td ><br/></td><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer" >XSServer</a></td></tr><tr class="inherited" ><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer#_sock-detail" >_sock</a></td><td ><br/></td><td ><br/></td><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer" >XSServer</a></td></tr></tbody></table><p><a ></a><span ></span></p><h2 >Public 方法</h2><p ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="toggle" >隐去继承来的方法</a></p><table class="summaryTable" width="1903" ><colgroup ><col class="col-method" /><col class="col-description" /><col class="col-defined" /></colgroup><tbody ><tr class="firstRow"><th >名称</th><th >描述</th><th >定义于</th></tr><tr class="inherited" ><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer#__construct-detail" >__construct()</a></td><td >构造函数, 打开连接</td><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer" >XSServer</a></td></tr><tr class="inherited" ><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer#__destruct-detail" >__destruct()</a></td><td >析构函数, 关闭连接</td><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer" >XSServer</a></td></tr><tr class="inherited" ><td ><a href="http://www.xunsearch.com/doc/php/api/XSComponent#__get-detail" >__get()</a></td><td >魔术方法 __get</td><td ><a href="http://www.xunsearch.com/doc/php/api/XSComponent" >XSComponent</a></td></tr><tr class="inherited" ><td ><a href="http://www.xunsearch.com/doc/php/api/XSComponent#__isset-detail" >__isset()</a></td><td >魔术方法 __isset</td><td ><a href="http://www.xunsearch.com/doc/php/api/XSComponent" >XSComponent</a></td></tr><tr class="inherited" ><td ><a href="http://www.xunsearch.com/doc/php/api/XSComponent#__set-detail" >__set()</a></td><td >魔术方法 __set</td><td ><a href="http://www.xunsearch.com/doc/php/api/XSComponent" >XSComponent</a></td></tr><tr class="inherited" ><td ><a href="http://www.xunsearch.com/doc/php/api/XSComponent#__unset-detail" >__unset()</a></td><td >魔术方法 __unset</td><td ><a href="http://www.xunsearch.com/doc/php/api/XSComponent" >XSComponent</a></td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#addDb-detail" >addDb()</a></td><td >添加搜索的数据库名, 支持多库同时搜索</td><td >XSSearch</td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#addQueryString-detail" >addQueryString()</a></td><td >增加默认搜索语句</td><td >XSSearch</td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#addQueryTerm-detail" >addQueryTerm()</a></td><td >增加默认搜索词汇</td><td >XSSearch</td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#addRange-detail" >addRange()</a></td><td >添加搜索过滤区间或范围</td><td >XSSearch</td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#addSearchLog-detail" >addSearchLog()</a></td><td >添加搜索日志关键词到缓冲区里</td><td >XSSearch</td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#addWeight-detail" >addWeight()</a></td><td >添加权重索引词</td><td >XSSearch</td></tr><tr class="inherited" ><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer#close-detail" >close()</a></td><td >关闭连接</td><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer" >XSServer</a></td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#count-detail" >count()</a></td><td >估算搜索语句的匹配数据量</td><td >XSSearch</td></tr><tr class="inherited" ><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer#execCommand-detail" >execCommand()</a></td><td >执行服务端指令并获取返回值</td><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer" >XSServer</a></td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#getAllSynonyms-detail" >getAllSynonyms()</a></td><td >获取当前库内的全部同义词列表</td><td >XSSearch</td></tr><tr class="inherited" ><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer#getConnString-detail" >getConnString()</a></td><td >Returns 连接字符串</td><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer" >XSServer</a></td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#getCorrectedQuery-detail" >getCorrectedQuery()</a></td><td >获取修正后的搜索词列表</td><td >XSSearch</td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#getDbTotal-detail" >getDbTotal()</a></td><td >获取搜索数据库内的数据总量</td><td >XSSearch</td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#getExpandedQuery-detail" >getExpandedQuery()</a></td><td >获取展开的搜索词列表</td><td >XSSearch</td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#getFacets-detail" >getFacets()</a></td><td >读取最近一次分面搜索记数</td><td >XSSearch</td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#getHotQuery-detail" >getHotQuery()</a></td><td >获取热门搜索词列表</td><td >XSSearch</td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#getLastCount-detail" >getLastCount()</a></td><td >获取最近那次搜索的匹配总数估值</td><td >XSSearch</td></tr><tr class="inherited" ><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer#getProject-detail" >getProject()</a></td><td >获取当前项目名称</td><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer" >XSServer</a></td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#getQuery-detail" >getQuery()</a></td><td >获取解析后的搜索语句</td><td >XSSearch</td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#getRelatedQuery-detail" >getRelatedQuery()</a></td><td >获取相关搜索词列表</td><td >XSSearch</td></tr><tr class="inherited" ><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer#getRespond-detail" >getRespond()</a></td><td >从服务器读取响应指令</td><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer" >XSServer</a></td></tr><tr class="inherited" ><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer#getSocket-detail" >getSocket()</a></td><td >获取连接资源描述符</td><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer" >XSServer</a></td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#getSynonyms-detail" >getSynonyms()</a></td><td >获取指定词汇的同义词列表</td><td >XSSearch</td></tr><tr class="inherited" ><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer#hasRespond-detail" >hasRespond()</a></td><td >判断服务端是否有可读数据</td><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer" >XSServer</a></td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#highlight-detail" >highlight()</a></td><td >搜索结果字符串高亮处理</td><td >XSSearch</td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#markResetScheme-detail" >markResetScheme()</a></td><td >标记字段方案重置</td><td >XSSearch</td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#open-detail" >open()</a></td><td >连接搜索服务端并初始化</td><td >XSSearch</td></tr><tr class="inherited" ><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer#reopen-detail" >reopen()</a></td><td >重新打开连接</td><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer" >XSServer</a></td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#search-detail" >search()</a></td><td >获取匹配的搜索结果文档</td><td >XSSearch</td></tr><tr class="inherited" ><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer#sendCommand-detail" >sendCommand()</a></td><td >往服务器直接发送指令 (无缓存)</td><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer" >XSServer</a></td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#setAutoSynonyms-detail" >setAutoSynonyms()</a></td><td >开启自动同义词搜索功能</td><td >XSSearch</td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#setCharset-detail" >setCharset()</a></td><td >设置字符集</td><td >XSSearch</td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#setCollapse-detail" >setCollapse()</a></td><td >设置折叠搜索结果</td><td >XSSearch</td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#setCutOff-detail" >setCutOff()</a></td><td >设置百分比/权重剔除参数</td><td >XSSearch</td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#setDb-detail" >setDb()</a></td><td >设置要搜索的数据库名</td><td >XSSearch</td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#setDocOrder-detail" >setDocOrder()</a></td><td >设置结果按索引入库先后排序</td><td >XSSearch</td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#setFacets-detail" >setFacets()</a></td><td >设置分面搜索记数</td><td >XSSearch</td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#setFuzzy-detail" >setFuzzy()</a></td><td >开启模糊搜索</td><td >XSSearch</td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#setGeodistSort-detail" >setGeodistSort()</a></td><td >设置地理位置距离排序方式</td><td >XSSearch</td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#setLimit-detail" >setLimit()</a></td><td >设置搜索结果的数量和偏移</td><td >XSSearch</td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#setMultiSort-detail" >setMultiSort()</a></td><td >设置多字段组合排序方式</td><td >XSSearch</td></tr><tr class="inherited" ><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer#setProject-detail" >setProject()</a></td><td >设置当前项目</td><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer" >XSServer</a></td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#setQuery-detail" >setQuery()</a></td><td >设置默认搜索语句</td><td >XSSearch</td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#setRequireMatchedTerm-detail" >setRequireMatchedTerm()</a></td><td >设置在搜索结果文档中返回匹配词表</td><td >XSSearch</td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#setScwsMulti-detail" >setScwsMulti()</a></td><td >设置当前搜索语句的分词复合等级</td><td >XSSearch</td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#setSort-detail" >setSort()</a></td><td >设置搜索结果的排序方式</td><td >XSSearch</td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#setSynonymScale-detail" >setSynonymScale()</a></td><td >设置同义词搜索的权重比例</td><td >XSSearch</td></tr><tr class="inherited" ><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer#setTimeout-detail" >setTimeout()</a></td><td >设置服务端超时秒数</td><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer" >XSServer</a></td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#setWeightingScheme-detail" >setWeightingScheme()</a></td><td >设置检索匹配的权重方案</td><td >XSSearch</td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#terms-detail" >terms()</a></td><td >获取搜索语句中的高亮词条列表</td><td >XSSearch</td></tr></tbody></table><h2 >Protected 方法</h2><p ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="toggle" >隐去继承来的方法</a></p><table class="summaryTable" width="1903" ><colgroup ><col class="col-method" /><col class="col-description" /><col class="col-defined" /></colgroup><tbody ><tr class="firstRow"><th >名称</th><th >描述</th><th >定义于</th></tr><tr class="inherited" ><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer#check-detail" >check()</a></td><td >检测服务端的连接情况</td><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer" >XSServer</a></td></tr><tr class="inherited" ><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer#connect-detail" >connect()</a></td><td >连接服务端</td><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer" >XSServer</a></td></tr><tr class="inherited" ><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer#read-detail" >read()</a></td><td >读取数据</td><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer" >XSServer</a></td></tr><tr class="inherited" ><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer#write-detail" >write()</a></td><td >写入数据</td><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer" >XSServer</a></td></tr></tbody></table><p><a ></a><span ></span></p><h2 >属性明细</h2><p>allSynonyms<span class="detailHeaderTag" >属性<em >只读</em>(自版本 v1.3.0 起可用)</span></p><p>public array<a href="http://www.xunsearch.com/doc/php/api/XSSearch#getAllSynonyms" ><strong >getAllSynonyms</strong></a>(int $limit=0, int $offset=0, bool $stemmed=false)</p><p >获取当前库内的全部同义词列表</p><p>correctedQuery<span class="detailHeaderTag" >属性<em >只读</em></span></p><p>public array<a href="http://www.xunsearch.com/doc/php/api/XSSearch#getCorrectedQuery" ><strong >getCorrectedQuery</strong></a>(string $query=NULL)</p><p >获取修正后的搜索词列表 通常当某次检索结果数量偏少时, 可以用该函数设计 "你是不是要找: ..." 功能</p><p>dbTotal<span class="detailHeaderTag" >属性<em >只读</em></span></p><p>public int<a href="http://www.xunsearch.com/doc/php/api/XSSearch#getDbTotal" ><strong >getDbTotal</strong></a>()</p><p >获取搜索数据库内的数据总量</p><p>facets<span class="detailHeaderTag" >属性 (自版本 v1.1.0 起可用)</span></p><p>public array<a href="http://www.xunsearch.com/doc/php/api/XSSearch#getFacets" ><strong >getFacets</strong></a>(string $field=NULL)<br/>public XSSearch<a href="http://www.xunsearch.com/doc/php/api/XSSearch#setFacets" ><strong >setFacets</strong></a>(mixed $field, bool $exact=false)</p><p >读取最近一次分面搜索记数 必须在某一次<a href="http://www.xunsearch.com/doc/php/api/XSSearch#search" >search</a>之后调用本函数才有意义</p><p>hotQuery<span class="detailHeaderTag" >属性<em >只读</em></span></p><p>public array<a href="http://www.xunsearch.com/doc/php/api/XSSearch#getHotQuery" ><strong >getHotQuery</strong></a>(int $limit=6, string $type='total')</p><p >获取热门搜索词列表</p><p>lastCount<span class="detailHeaderTag" >属性<em >只读</em></span></p><p>public int<a href="http://www.xunsearch.com/doc/php/api/XSSearch#getLastCount" ><strong >getLastCount</strong></a>()</p><p >获取最近那次搜索的匹配总数估值</p><h4 >参见</h4><ul class=" list-paddingleft-2"><li><p><a href="http://www.xunsearch.com/doc/php/api/XSSearch#search" >search</a></p></li></ul><p>query<span class="detailHeaderTag" >属性</span></p><p>public string<a href="http://www.xunsearch.com/doc/php/api/XSSearch#getQuery" ><strong >getQuery</strong></a>(string $query=NULL)<br/>public XSSearch<a href="http://www.xunsearch.com/doc/php/api/XSSearch#setQuery" ><strong >setQuery</strong></a>(string $query)</p><p >获取解析后的搜索语句</p><p>relatedQuery<span class="detailHeaderTag" >属性<em >只读</em></span></p><p>public array<a href="http://www.xunsearch.com/doc/php/api/XSSearch#getRelatedQuery" ><strong >getRelatedQuery</strong></a>(string $query=NULL, int $limit=6)</p><p >获取相关搜索词列表</p><h2 >方法明细</h2><p>addDb()<span class="detailHeaderTag" >方法</span></p><table class="summaryTable" width="1903" ><tbody ><tr class="firstRow"><td colspan="3" ><p>public XSSearch<strong >addDb</strong>(string $name)</p></td></tr><tr ><td class="paramNameCol" >$name</td><td class="paramTypeCol" >string</td><td class="paramDescCol" ><br/></td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >XSSearch</td><td class="paramDescCol" >返回对象本身以支持串接操作</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L555" >sdk/php/lib/XSSearch.class.php#L555</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >添加搜索的数据库名, 支持多库同时搜索</p><h4 >参见</h4><ul class=" list-paddingleft-2"><li><p><a href="http://www.xunsearch.com/doc/php/api/XSSearch#setDb" >setDb</a></p></li></ul><p>addQueryString()<span class="detailHeaderTag" >方法</span></p><table class="summaryTable" width="1903" ><tbody ><tr class="firstRow"><td colspan="3" ><p>public string<strong >addQueryString</strong>(string $query, int $addOp=0, float $scale=1)</p></td></tr><tr ><td class="paramNameCol" >$query</td><td class="paramTypeCol" >string</td><td class="paramDescCol" >搜索语句</td></tr><tr ><td class="paramNameCol" >$addOp</td><td class="paramTypeCol" >int</td><td class="paramDescCol" >与旧语句的结合操作符, 如果无旧语句或为空则这此无意义, 支持的操作符有: XS_CMD_QUERY_OP_AND XS_CMD_QUERY_OP_OR XS_CMD_QUERY_OP_AND_NOT XS_CMD_QUERY_OP_XOR XS_CMD_QUERY_OP_AND_MAYBE XS_CMD_QUERY_OP_FILTER</td></tr><tr ><td class="paramNameCol" >$scale</td><td class="paramTypeCol" >float</td><td class="paramDescCol" >权重计算缩放比例, 默认为 1表示不缩放, 其它值范围 0.xx ~ 655.35</td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >string</td><td class="paramDescCol" >修正后的搜索语句</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L1012" >sdk/php/lib/XSSearch.class.php#L1012</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >增加默认搜索语句</p><p>addQueryTerm()<span class="detailHeaderTag" >方法</span></p><table class="summaryTable" width="1903" ><tbody ><tr class="firstRow"><td colspan="3" ><p>public XSSearch<strong >addQueryTerm</strong>(string $field, string|array $term, int $addOp=0, float $scale=1)</p></td></tr><tr ><td class="paramNameCol" >$field</td><td class="paramTypeCol" >string</td><td class="paramDescCol" >索引词所属的字段, 若为混合区词汇可设为 null 或 body 型的字段名</td></tr><tr ><td class="paramNameCol" >$term</td><td class="paramTypeCol" >string|array</td><td class="paramDescCol" >索引词或列表</td></tr><tr ><td class="paramNameCol" >$addOp</td><td class="paramTypeCol" >int</td><td class="paramDescCol" >与旧语句的结合操作符, 如果无旧语句或为空则这此无意义, 支持的操作符有:</td></tr><tr ><td class="paramNameCol" >$scale</td><td class="paramTypeCol" >float</td><td class="paramDescCol" >权重计算缩放比例, 默认为 1表示不缩放, 其它值范围 0.xx ~ 655.35</td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >XSSearch</td><td class="paramDescCol" >返回对象本身以支持串接操作</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L1033" >sdk/php/lib/XSSearch.class.php#L1033</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >增加默认搜索词汇</p><h4 >参见</h4><ul class=" list-paddingleft-2"><li><p><a href="http://www.xunsearch.com/doc/php/api/XSSearch#addQueryString" >注：自 v1.4.10 起，允许传入数组，多词之间通过 defaultOp 连接，并且这些词不会再被分词。</a></p></li></ul><p>addRange()<span class="detailHeaderTag" >方法</span></p><table class="summaryTable" width="1903" ><tbody ><tr class="firstRow"><td colspan="3" ><p>public XSSearch<strong >addRange</strong>(string $field, mixed $from, mixed $to)</p></td></tr><tr ><td class="paramNameCol" >$field</td><td class="paramTypeCol" >string</td><td class="paramDescCol" ><br/></td></tr><tr ><td class="paramNameCol" >$from</td><td class="paramTypeCol" >mixed</td><td class="paramDescCol" >起始值(不包含), 若设为 null 则相当于匹配 <= to (字典顺序)</td></tr><tr ><td class="paramNameCol" >$to</td><td class="paramTypeCol" >mixed</td><td class="paramDescCol" >结束值(包含), 若设为 null 则相当于匹配 >= from (字典顺序)</td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >XSSearch</td><td class="paramDescCol" >返回对象本身以支持串接操作</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L410" >sdk/php/lib/XSSearch.class.php#L410</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >添加搜索过滤区间或范围</p><p>addSearchLog()<span class="detailHeaderTag" >方法 (自版本 v1.1.1 起可用)</span></p><table class="summaryTable" width="1903" ><tbody ><tr class="firstRow"><td colspan="3" ><p>public void<strong >addSearchLog</strong>(string $query, int $wdf=1)</p></td></tr><tr ><td class="paramNameCol" >$query</td><td class="paramTypeCol" >string</td><td class="paramDescCol" >需要记录的数据</td></tr><tr ><td class="paramNameCol" >$wdf</td><td class="paramTypeCol" >int</td><td class="paramDescCol" >需要记录的次数, 默认为 1</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L894" >sdk/php/lib/XSSearch.class.php#L894</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >添加搜索日志关键词到缓冲区里 需要调用<a href="http://www.xunsearch.com/doc/php/api/XSIndex#flushLogging" >XSIndex::flushLogging</a>才能确保立即刷新, 否则要隔一段时间</p><p>addWeight()<span class="detailHeaderTag" >方法</span></p><table class="summaryTable" width="1903" ><tbody ><tr class="firstRow"><td colspan="3" ><p>public XSSearch<strong >addWeight</strong>(string $field, string $term, float $weight=1)</p></td></tr><tr ><td class="paramNameCol" >$field</td><td class="paramTypeCol" >string</td><td class="paramDescCol" >索引词所属的字段</td></tr><tr ><td class="paramNameCol" >$term</td><td class="paramTypeCol" >string</td><td class="paramDescCol" >索引词</td></tr><tr ><td class="paramNameCol" >$weight</td><td class="paramTypeCol" >float</td><td class="paramDescCol" >权重计算缩放比例</td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >XSSearch</td><td class="paramDescCol" >返回对象本身以支持串接操作</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L447" >sdk/php/lib/XSSearch.class.php#L447</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >添加权重索引词 无论是否包含这种词都不影响搜索匹配, 但会参与计算结果权重, 使结果的相关度更高</p><h4 >参见</h4><ul class=" list-paddingleft-2"><li><p><a href="http://www.xunsearch.com/doc/php/api/XSSearch#addQueryTerm" >addQueryTerm</a></p></li></ul><p>count()<span class="detailHeaderTag" >方法</span></p><table class="summaryTable" width="1903" ><tbody ><tr class="firstRow"><td colspan="3" ><p>public int<strong >count</strong>(string $query=NULL)</p></td></tr><tr ><td class="paramNameCol" >$query</td><td class="paramTypeCol" >string</td><td class="paramDescCol" >搜索语句, 若传入 null 使用默认语句, 调用后会还原默认排序方式 如果搜索语句和最近一次<a href="http://www.xunsearch.com/doc/php/api/XSSearch#search" >search</a>的语句一样, 请改用<a href="http://www.xunsearch.com/doc/php/api/XSSearch#getLastCount" >getLastCount</a>以提升效率 最大长度为 80 字节</td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >int</td><td class="paramDescCol" >匹配的搜索结果数量, 估算数值</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L610" >sdk/php/lib/XSSearch.class.php#L610</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >估算搜索语句的匹配数据量</p><p>getAllSynonyms()<span class="detailHeaderTag" >方法 (自版本 v1.3.0 起可用)</span></p><table class="summaryTable" width="1903" ><tbody ><tr class="firstRow"><td colspan="3" ><p>public array<strong >getAllSynonyms</strong>(int $limit=0, int $offset=0, bool $stemmed=false)</p></td></tr><tr ><td class="paramNameCol" >$limit</td><td class="paramTypeCol" >int</td><td class="paramDescCol" >数量上限, 若设为 0 则启用默认值 100 个</td></tr><tr ><td class="paramNameCol" >$offset</td><td class="paramTypeCol" >int</td><td class="paramDescCol" >偏移量, 即跳过的结果数量, 默认为 0</td></tr><tr ><td class="paramNameCol" >$stemmed</td><td class="paramTypeCol" >bool</td><td class="paramDescCol" >是否包含处理过的词根同义词, 默认为 false 表示否</td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >array</td><td class="paramDescCol" >同义词记录数组, 每个词条为键, 同义词条组成的数组为值</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L179" >sdk/php/lib/XSSearch.class.php#L179</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >获取当前库内的全部同义词列表</p><p>getCorrectedQuery()<span class="detailHeaderTag" >方法</span></p><table class="summaryTable" width="1903" ><tbody ><tr class="firstRow"><td colspan="3" ><p>public array<strong >getCorrectedQuery</strong>(string $query=NULL)</p></td></tr><tr ><td class="paramNameCol" >$query</td><td class="paramTypeCol" >string</td><td class="paramDescCol" >需要展开的前缀, 可为拼音、英文、中文</td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >array</td><td class="paramDescCol" >返回搜索词组成的数组</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L858" >sdk/php/lib/XSSearch.class.php#L858</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >获取修正后的搜索词列表 通常当某次检索结果数量偏少时, 可以用该函数设计 "你是不是要找: ..." 功能</p><p>getDbTotal()<span class="detailHeaderTag" >方法</span></p><table class="summaryTable" width="1903" ><tbody ><tr class="firstRow"><td colspan="3" ><p>public int<strong >getDbTotal</strong>()</p></td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >int</td><td class="paramDescCol" >数据总量</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L722" >sdk/php/lib/XSSearch.class.php#L722</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >获取搜索数据库内的数据总量</p><p>getExpandedQuery()<span class="detailHeaderTag" >方法</span></p><table class="summaryTable" width="1903" ><tbody ><tr class="firstRow"><td colspan="3" ><p>public array<strong >getExpandedQuery</strong>(string $query, int $limit=10)</p></td></tr><tr ><td class="paramNameCol" >$query</td><td class="paramTypeCol" >string</td><td class="paramDescCol" >需要展开的前缀, 可为拼音、英文、中文</td></tr><tr ><td class="paramNameCol" >$limit</td><td class="paramTypeCol" >int</td><td class="paramDescCol" >需要返回的搜索词数量上限, 默认为 10, 最大值为 20</td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >array</td><td class="paramDescCol" >返回搜索词组成的数组</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L818" >sdk/php/lib/XSSearch.class.php#L818</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >获取展开的搜索词列表</p><p>getFacets()<span class="detailHeaderTag" >方法 (自版本 v1.1.0 起可用)</span></p><table class="summaryTable" width="1903" ><tbody ><tr class="firstRow"><td colspan="3" ><p>public array<strong >getFacets</strong>(string $field=NULL)</p></td></tr><tr ><td class="paramNameCol" >$field</td><td class="paramTypeCol" >string</td><td class="paramDescCol" >读取分面记数的字段, 若为 null 则返回全部分面搜索记录</td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >array</td><td class="paramDescCol" >返回由值和计数组成的关联数组, 若不存在或未曾登记过则返回空数组</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L490" >sdk/php/lib/XSSearch.class.php#L490</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >读取最近一次分面搜索记数 必须在某一次<a href="http://www.xunsearch.com/doc/php/api/XSSearch#search" >search</a>之后调用本函数才有意义</p><p>getHotQuery()<span class="detailHeaderTag" >方法</span></p><table class="summaryTable" width="1903" ><tbody ><tr class="firstRow"><td colspan="3" ><p>public array<strong >getHotQuery</strong>(int $limit=6, string $type='total')</p></td></tr><tr ><td class="paramNameCol" >$limit</td><td class="paramTypeCol" >int</td><td class="paramDescCol" >需要返回的热门搜索数量上限, 默认为 6, 最大值为 50</td></tr><tr ><td class="paramNameCol" >$type</td><td class="paramTypeCol" >string</td><td class="paramDescCol" >排序类型, 默认为 total(搜索总量), 可选值还有 lastnum(上周), currnum(本周)</td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >array</td><td class="paramDescCol" >返回以搜索词为键, 搜索指数为值的关联数组</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L736" >sdk/php/lib/XSSearch.class.php#L736</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >获取热门搜索词列表</p><p>getLastCount()<span class="detailHeaderTag" >方法</span></p><table class="summaryTable" width="1903" ><tbody ><tr class="firstRow"><td colspan="3" ><p>public int<strong >getLastCount</strong>()</p></td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >int</td><td class="paramDescCol" >匹配数据量, 如从未搜索则返回 false</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L713" >sdk/php/lib/XSSearch.class.php#L713</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >获取最近那次搜索的匹配总数估值</p><h4 >参见</h4><ul class=" list-paddingleft-2"><li><p><a href="http://www.xunsearch.com/doc/php/api/XSSearch#search" >search</a></p></li></ul><p>getQuery()<span class="detailHeaderTag" >方法</span></p><table class="summaryTable" width="1903" ><tbody ><tr class="firstRow"><td colspan="3" ><p>public string<strong >getQuery</strong>(string $query=NULL)</p></td></tr><tr ><td class="paramNameCol" >$query</td><td class="paramTypeCol" >string</td><td class="paramDescCol" >搜索语句, 若传入 null 使用默认语句</td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >string</td><td class="paramDescCol" >返回解析后的搜索语句</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L219" >sdk/php/lib/XSSearch.class.php#L219</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >获取解析后的搜索语句</p><p>getRelatedQuery()<span class="detailHeaderTag" >方法</span></p><table class="summaryTable" width="1903" ><tbody ><tr class="firstRow"><td colspan="3" ><p>public array<strong >getRelatedQuery</strong>(string $query=NULL, int $limit=6)</p></td></tr><tr ><td class="paramNameCol" >$query</td><td class="paramTypeCol" >string</td><td class="paramDescCol" >搜索语句, 若传入 null 使用默认语句</td></tr><tr ><td class="paramNameCol" >$limit</td><td class="paramTypeCol" >int</td><td class="paramDescCol" >需要返回的相关搜索数量上限, 默认为 6, 最大值为 20</td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >array</td><td class="paramDescCol" >返回搜索词组成的数组</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L770" >sdk/php/lib/XSSearch.class.php#L770</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >获取相关搜索词列表</p><p>getSynonyms()<span class="detailHeaderTag" >方法 (自版本 v1.4.9 起可用)</span></p><table class="summaryTable" width="1903" ><tbody ><tr class="firstRow"><td colspan="3" ><p>public array<strong >getSynonyms</strong>(string $term)</p></td></tr><tr ><td class="paramNameCol" >$term</td><td class="paramTypeCol" >string</td><td class="paramDescCol" >要查询同义词的原词</td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >array</td><td class="paramDescCol" >同义词记录数组, 不存在同义词则返回空数组</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L202" >sdk/php/lib/XSSearch.class.php#L202</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >获取指定词汇的同义词列表</p><p>highlight()<span class="detailHeaderTag" >方法</span></p><table class="summaryTable" width="1903" ><tbody ><tr class="firstRow"><td colspan="3" ><p>public string<strong >highlight</strong>(string $value, $strtr=false)</p></td></tr><tr ><td class="paramNameCol" >$value</td><td class="paramTypeCol" >string</td><td class="paramDescCol" >需要处理的数据</td></tr><tr ><td class="paramNameCol" >$strtr</td><td class="paramTypeCol" ><br/></td><td class="paramDescCol" ><br/></td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >string</td><td class="paramDescCol" >高亮后的数据</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L909" >sdk/php/lib/XSSearch.class.php#L909</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >搜索结果字符串高亮处理 对搜索结果文档的字段进行高亮、飘红处理, 高亮部分加上 em 标记</p><p>markResetScheme()<span class="detailHeaderTag" >方法</span></p><table class="summaryTable" width="1903" ><tbody ><tr class="firstRow"><td colspan="3" ><p>public void<strong >markResetScheme</strong>()</p></td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L567" >sdk/php/lib/XSSearch.class.php#L567</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >标记字段方案重置</p><h4 >参见</h4><ul class=" list-paddingleft-2"><li><p><a href="http://www.xunsearch.com/doc/php/api/XS#setScheme" >XS::setScheme</a></p></li></ul><p>open()<span class="detailHeaderTag" >方法</span></p><table class="summaryTable" width="1903" ><tbody ><tr class="firstRow"><td colspan="3" ><p>public void<strong >open</strong>(string $conn)</p></td></tr><tr ><td class="paramNameCol" >$conn</td><td class="paramTypeCol" >string</td><td class="paramDescCol" ><br/></td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L55" >sdk/php/lib/XSSearch.class.php#L55</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >连接搜索服务端并初始化 每次重新连接后所有的搜索语句相关设置均被还原</p><h4 >参见</h4><ul class=" list-paddingleft-2"><li><p><a href="http://www.xunsearch.com/doc/php/api/XSServer#open" >XSServer::open</a></p></li></ul><p>search()<span class="detailHeaderTag" >方法</span></p><table class="summaryTable" width="1903" ><tbody ><tr class="firstRow"><td colspan="3" ><p>public XSDocument[]<strong >search</strong>(string $query=NULL, boolean $saveHighlight=true)</p></td></tr><tr ><td class="paramNameCol" >$query</td><td class="paramTypeCol" >string</td><td class="paramDescCol" >搜索语句, 若传入 null 使用默认语句, 最大长度为 80 字节</td></tr><tr ><td class="paramNameCol" >$saveHighlight</td><td class="paramTypeCol" >boolean</td><td class="paramDescCol" >是否存储查询词用于高亮处理, 默认为 true</td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >XSDocument[]</td><td class="paramDescCol" >匹配的搜索结果文档列表</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L635" >sdk/php/lib/XSSearch.class.php#L635</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >获取匹配的搜索结果文档 默认提取最匹配的前 self::PAGE_SIZE 个结果 如需分页请参见<a href="http://www.xunsearch.com/doc/php/api/XSSearch#setLimit" >setLimit</a>设置, 每次调用本函数后都会还原 setLimit 的设置</p><p>setAutoSynonyms()<span class="detailHeaderTag" >方法 (自版本 v1.3.0 起可用)</span></p><table class="summaryTable" width="1903" ><tbody ><tr class="firstRow"><td colspan="3" ><p>public XSSearch<strong >setAutoSynonyms</strong>(bool $value=true)</p></td></tr><tr ><td class="paramNameCol" >$value</td><td class="paramTypeCol" >bool</td><td class="paramDescCol" >设为 true 表示开启同义词功能, 设为 false 关闭同义词功能</td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >XSSearch</td><td class="paramDescCol" >返回对象本身以支持串接操作</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L144" >sdk/php/lib/XSSearch.class.php#L144</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >开启自动同义词搜索功能</p><p>setCharset()<span class="detailHeaderTag" >方法</span></p><table class="summaryTable" width="1903" ><tbody ><tr class="firstRow"><td colspan="3" ><p>public XSSearch<strong >setCharset</strong>(string $charset)</p></td></tr><tr ><td class="paramNameCol" >$charset</td><td class="paramTypeCol" >string</td><td class="paramDescCol" ><br/></td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >XSSearch</td><td class="paramDescCol" >返回对象本身以支持串接操作</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L69" >sdk/php/lib/XSSearch.class.php#L69</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >设置字符集 默认字符集是 UTF-8, 如果您提交的搜索语句和预期得到的搜索结果为其它字符集, 请先设置</p><p>setCollapse()<span class="detailHeaderTag" >方法</span></p><table class="summaryTable" width="1903" ><tbody ><tr class="firstRow"><td colspan="3" ><p>public XSSearch<strong >setCollapse</strong>(string $field, int $num=1)</p></td></tr><tr ><td class="paramNameCol" >$field</td><td class="paramTypeCol" >string</td><td class="paramDescCol" >依据该字段的值折叠搜索结果, 设为 null 则取消折叠</td></tr><tr ><td class="paramNameCol" >$num</td><td class="paramTypeCol" >int</td><td class="paramDescCol" >折叠后只是返最匹配的数据数量, 默认为 1, 最大值 255</td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >XSSearch</td><td class="paramDescCol" >返回对象本身以支持串接操作</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L393" >sdk/php/lib/XSSearch.class.php#L393</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >设置折叠搜索结果 注意, 每当调用<a href="http://www.xunsearch.com/doc/php/api/XSSearch#setDb" >setDb</a>或<a href="http://www.xunsearch.com/doc/php/api/XSSearch#addDb" >addDb</a>修改当前数据库时会重置此项设置</p><p>setCutOff()<span class="detailHeaderTag" >方法</span></p><table class="summaryTable" width="1903" ><tbody ><tr class="firstRow"><td colspan="3" ><p>public XSSearch<strong >setCutOff</strong>(int $percent, float $weight=0)</p></td></tr><tr ><td class="paramNameCol" >$percent</td><td class="paramTypeCol" >int</td><td class="paramDescCol" >剔除匹配百分比低于此值的文档, 值范围 0-100</td></tr><tr ><td class="paramNameCol" >$weight</td><td class="paramTypeCol" >float</td><td class="paramDescCol" >剔除权重低于此值的文档, 值范围 0.1-25.5, 0 表示不剔除</td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >XSSearch</td><td class="paramDescCol" >返回对象本身以支持串接操作</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L98" >sdk/php/lib/XSSearch.class.php#L98</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >设置百分比/权重剔除参数 通常是在开启<a href="http://www.xunsearch.com/doc/php/api/XSSearch#setFuzzy" >setFuzzy</a>或使用 OR 连接搜索语句时才需要设置此项</p><h4 >参见</h4><ul class=" list-paddingleft-2"><li><p><a href="http://www.xunsearch.com/doc/php/api/XSSearch#setFuzzy" >setFuzzy</a></p></li></ul><p>setDb()<span class="detailHeaderTag" >方法</span></p><table class="summaryTable" width="1903" ><tbody ><tr class="firstRow"><td colspan="3" ><p>public XSSearch<strong >setDb</strong>(string $name)</p></td></tr><tr ><td class="paramNameCol" >$name</td><td class="paramTypeCol" >string</td><td class="paramDescCol" ><br/></td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >XSSearch</td><td class="paramDescCol" >返回对象本身以支持串接操作</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L538" >sdk/php/lib/XSSearch.class.php#L538</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >设置要搜索的数据库名 若未设置, 使用默认数据库, 数据库必须位于服务端用户目录下 对于远程数据库, 请使用 stub 文件来支持</p><p>setDocOrder()<span class="detailHeaderTag" >方法</span></p><table class="summaryTable" width="1903" ><tbody ><tr class="firstRow"><td colspan="3" ><p>public XSSearch<strong >setDocOrder</strong>(bool $asc=false)</p></td></tr><tr ><td class="paramNameCol" >$asc</td><td class="paramTypeCol" >bool</td><td class="paramDescCol" >是否为正序排列, 即从先到后, 默认为反序</td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >XSSearch</td><td class="paramDescCol" >返回对象本身以支持串接操作</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L378" >sdk/php/lib/XSSearch.class.php#L378</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >设置结果按索引入库先后排序 注意, 此项排序不影响相关排序, 权重高的仍会在前面, 主要适合用于布尔检索</p><p>setFacets()<span class="detailHeaderTag" >方法 (自版本 v1.1.0 起可用)</span></p><table class="summaryTable" width="1903" ><tbody ><tr class="firstRow"><td colspan="3" ><p>public XSSearch<strong >setFacets</strong>(mixed $field, bool $exact=false)</p></td></tr><tr ><td class="paramNameCol" >$field</td><td class="paramTypeCol" >mixed</td><td class="paramDescCol" >要进行分组统计的字段或字段组成的数组, 最多同时支持 8 个</td></tr><tr ><td class="paramNameCol" >$exact</td><td class="paramTypeCol" >bool</td><td class="paramDescCol" >是否要求绝对精确搜索, 这会造成较大的系统开销</td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >XSSearch</td><td class="paramDescCol" >返回对象本身以支持串接操作</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L464" >sdk/php/lib/XSSearch.class.php#L464</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >设置分面搜索记数 用于记录匹配搜索结果中按字段值分组的数量统计, 每次调用<a href="http://www.xunsearch.com/doc/php/api/XSSearch#search" >search</a>后会还原设置 对于多次调用 $exact 参数以最后一次为准, 只支持字段值不超过 255 字节的情况<br/><br/>自 v1.4.10 起自动对空值的字段按 term 分面统计（相当于多值）</p><p>setFuzzy()<span class="detailHeaderTag" >方法</span></p><table class="summaryTable" width="1903" ><tbody ><tr class="firstRow"><td colspan="3" ><p>public XSSearch<strong >setFuzzy</strong>(bool $value=true)</p></td></tr><tr ><td class="paramNameCol" >$value</td><td class="paramTypeCol" >bool</td><td class="paramDescCol" >设为 true 表示开启模糊搜索, 设为 false 关闭模糊搜索</td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >XSSearch</td><td class="paramDescCol" >返回对象本身以支持串接操作</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L84" >sdk/php/lib/XSSearch.class.php#L84</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >开启模糊搜索 默认情况只返回包含所有搜索词的记录, 通过本方法可以获得更多搜索结果</p><p>setGeodistSort()<span class="detailHeaderTag" >方法 (自版本 v1.4.10 起可用)</span></p><table class="summaryTable" width="1903" ><tbody ><tr class="firstRow"><td colspan="3" ><p>public XSSearch<strong >setGeodistSort</strong>(array $fields, bool $reverse=false, bool $relevance_first=false)</p></td></tr><tr ><td class="paramNameCol" >$fields</td><td class="paramTypeCol" >array</td><td class="paramDescCol" >在此定义地理位置信息原点坐标信息，数组至少必须包含2个值</td></tr><tr ><td class="paramNameCol" >$reverse</td><td class="paramTypeCol" >bool</td><td class="paramDescCol" >是否由远及近排序, 默认为由近及远</td></tr><tr ><td class="paramNameCol" >$relevance_first</td><td class="paramTypeCol" >bool</td><td class="paramDescCol" >是否优先相关性排序, 默认为否</td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >XSSearch</td><td class="paramDescCol" >返回对象本身以支持串接操作</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L266" >sdk/php/lib/XSSearch.class.php#L266</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >设置地理位置距离排序方式<br/><br/>请务必先以 numeric 类型字段定义经纬度坐标字段，例如用 lon 代表经度、lat 代表纬度， 那么设置排序代码如下，必须将经度定义在前纬度在后：</p><pre >$search->setGeodistSort(array('lon'=>39.18,'lat'=>120.51));</pre><p ><br/></p><p>setLimit()<span class="detailHeaderTag" >方法</span></p><table class="summaryTable" width="1903" ><tbody ><tr class="firstRow"><td colspan="3" ><p>public XSSearch<strong >setLimit</strong>(int $limit, int $offset=0)</p></td></tr><tr ><td class="paramNameCol" >$limit</td><td class="paramTypeCol" >int</td><td class="paramDescCol" >数量上限, 若设为 0 则启用默认值 self::PAGE_SIZE</td></tr><tr ><td class="paramNameCol" >$offset</td><td class="paramTypeCol" >int</td><td class="paramDescCol" >偏移量, 即跳过的结果数量, 默认为 0</td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >XSSearch</td><td class="paramDescCol" >返回对象本身以支持串接操作</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L524" >sdk/php/lib/XSSearch.class.php#L524</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >设置搜索结果的数量和偏移 用于搜索结果分页, 每次调用<a href="http://www.xunsearch.com/doc/php/api/XSSearch#search" >search</a>后会还原这2个变量到初始值</p><p>setMultiSort()<span class="detailHeaderTag" >方法 (自版本 v1.1.0 起可用)</span></p><table class="summaryTable" width="1903" ><tbody ><tr class="firstRow"><td colspan="3" ><p>public XSSearch<strong >setMultiSort</strong>(array $fields, bool $reverse=false, bool $relevance_first=false)</p></td></tr><tr ><td class="paramNameCol" >$fields</td><td class="paramTypeCol" >array</td><td class="paramDescCol" >排序依据的字段数组, 以字段名称为键, true/false 为值表示正序或逆序</td></tr><tr ><td class="paramNameCol" >$reverse</td><td class="paramTypeCol" >bool</td><td class="paramDescCol" >是否为倒序显示, 默认为正向, 此处和<a href="http://www.xunsearch.com/doc/php/api/XSSearch#setSort" >setSort</a>略有不同</td></tr><tr ><td class="paramNameCol" >$relevance_first</td><td class="paramTypeCol" >bool</td><td class="paramDescCol" >是否优先相关性排序, 默认为否</td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >XSSearch</td><td class="paramDescCol" >返回对象本身以支持串接操作</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L307" >sdk/php/lib/XSSearch.class.php#L307</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >设置多字段组合排序方式 当您需要根据多个字段的值按不同的方式综合排序时, 请使用这项</p><p>setQuery()<span class="detailHeaderTag" >方法</span></p><table class="summaryTable" width="1903" ><tbody ><tr class="firstRow"><td colspan="3" ><p>public XSSearch<strong >setQuery</strong>(string $query)</p></td></tr><tr ><td class="paramNameCol" >$query</td><td class="paramTypeCol" >string</td><td class="paramDescCol" >搜索语句, 设为 null 则清空搜索语句, 最大长度为 80 字节</td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >XSSearch</td><td class="paramDescCol" >返回对象本身以支持串接操作</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L242" >sdk/php/lib/XSSearch.class.php#L242</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >设置默认搜索语句 用于不带参数的<a href="http://www.xunsearch.com/doc/php/api/XSSearch#count" >count</a>或<a href="http://www.xunsearch.com/doc/php/api/XSSearch#search" >search</a>以及<a href="http://www.xunsearch.com/doc/php/api/XSSearch#terms" >terms</a>调用 可与<a href="http://www.xunsearch.com/doc/php/api/XSSearch#addWeight" >addWeight</a>组合运用</p><p>setRequireMatchedTerm()<span class="detailHeaderTag" >方法 (自版本 v1.4.8 起可用)</span></p><table class="summaryTable" width="1903" ><tbody ><tr class="firstRow"><td colspan="3" ><p>public XSSearch<strong >setRequireMatchedTerm</strong>(bool $value=true)</p></td></tr><tr ><td class="paramNameCol" >$value</td><td class="paramTypeCol" >bool</td><td class="paramDescCol" >设为 true 表示开启返回, 设为 false 关闭该功能, 默认是不开启</td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >XSSearch</td><td class="paramDescCol" >返回对象本身以支持串接操作</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L114" >sdk/php/lib/XSSearch.class.php#L114</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >设置在搜索结果文档中返回匹配词表 请在<a href="http://www.xunsearch.com/doc/php/api/XSSearch#search" >search</a>前调用本方法, 然后使用 XSDocument::matched 获取</p><p>setScwsMulti()<span class="detailHeaderTag" >方法 (自版本 v1.4.7 起可用)</span></p><table class="summaryTable" width="1903" ><tbody ><tr class="firstRow"><td colspan="3" ><p>public XSSearch<strong >setScwsMulti</strong>(int $level)</p></td></tr><tr ><td class="paramNameCol" >$level</td><td class="paramTypeCol" >int</td><td class="paramDescCol" >要设置的分词复合等级</td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >XSSearch</td><td class="paramDescCol" >返回自身对象以支持串接操作</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L507" >sdk/php/lib/XSSearch.class.php#L507</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >设置当前搜索语句的分词复合等级 复合等级是 scws 分词粒度控制的一个重要参数, 是长词细分处理依据, 默认为 3, 值范围 0~15 注意: 这个设置仅直对本次搜索有效, 仅对设置之后的<a href="http://www.xunsearch.com/doc/php/api/XSSearch#setQuery" >setQuery</a>起作用, 由于 query 设计的方式问题, 目前无法支持搜索语句单字切分, 但您可以在模糊检索时设为 0 来关闭复合分词</p><p>setSort()<span class="detailHeaderTag" >方法</span></p><table class="summaryTable" width="1903" ><tbody ><tr class="firstRow"><td colspan="3" ><p>public XSSearch<strong >setSort</strong>(string $field, bool $asc=false, bool $relevance_first=false)</p></td></tr><tr ><td class="paramNameCol" >$field</td><td class="paramTypeCol" >string</td><td class="paramDescCol" >依据指定字段的值排序, 设为 null 则用默认顺序</td></tr><tr ><td class="paramNameCol" >$asc</td><td class="paramTypeCol" >bool</td><td class="paramDescCol" >是否为正序排列, 即从小到大, 从少到多, 默认为反序</td></tr><tr ><td class="paramNameCol" >$relevance_first</td><td class="paramTypeCol" >bool</td><td class="paramDescCol" >是否优先相关性排序, 默认为否</td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >XSSearch</td><td class="paramDescCol" >返回对象本身以支持串接操作</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L350" >sdk/php/lib/XSSearch.class.php#L350</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >设置搜索结果的排序方式 注意, 每当调用<a href="http://www.xunsearch.com/doc/php/api/XSSearch#setDb" >setDb</a>或<a href="http://www.xunsearch.com/doc/php/api/XSSearch#addDb" >addDb</a>修改当前数据库时会重置排序设定 此函数第一参数的用法与<a href="http://www.xunsearch.com/doc/php/api/XSSearch#setMultiSort" >setMultiSort</a>兼容, 即也可以用该方法实现多字段排序</p><p>setSynonymScale()<span class="detailHeaderTag" >方法 (自版本 v1.4.7 起可用)</span></p><table class="summaryTable" width="1903" ><tbody ><tr class="firstRow"><td colspan="3" ><p>public XSSearch<strong >setSynonymScale</strong>(float $value)</p></td></tr><tr ><td class="paramNameCol" >$value</td><td class="paramTypeCol" >float</td><td class="paramDescCol" >取值范围 0.01-2.55, 1 表示不调整</td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >XSSearch</td><td class="paramDescCol" >返回对象本身以支持串接操作</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L162" >sdk/php/lib/XSSearch.class.php#L162</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >设置同义词搜索的权重比例</p><p>setWeightingScheme()<span class="detailHeaderTag" >方法 (自版本 v1.4.11 起可用)</span></p><table class="summaryTable" width="1903" ><tbody ><tr class="firstRow"><td colspan="3" ><p>public XSSearch<strong >setWeightingScheme</strong>(int $scheme)</p></td></tr><tr ><td class="paramNameCol" >$scheme</td><td class="paramTypeCol" >int</td><td class="paramDescCol" >匹配权重方案</td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >XSSearch</td><td class="paramDescCol" >返回对象本身以支持串接操作</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L130" >sdk/php/lib/XSSearch.class.php#L130</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >设置检索匹配的权重方案 目前支持三种权重方案: 0=BM25/1=Bool/2=Trad</p><p>terms()<span class="detailHeaderTag" >方法</span></p><table class="summaryTable" width="1903" ><tbody ><tr class="firstRow"><td colspan="3" ><p>public array<strong >terms</strong>(string $query=NULL, bool $convert=true)</p></td></tr><tr ><td class="paramNameCol" >$query</td><td class="paramTypeCol" >string</td><td class="paramDescCol" >搜索语句, 若传入 null 使用默认语句, 最大长度为 80 字节</td></tr><tr ><td class="paramNameCol" >$convert</td><td class="paramTypeCol" >bool</td><td class="paramDescCol" >是否进行编码转换, 默认为 true</td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >array</td><td class="paramDescCol" >可用于高亮显示的词条列表</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L578" >sdk/php/lib/XSSearch.class.php#L578</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >获取搜索语句中的高亮词条列表</p><p><a href="http://www.xunsearch.com/" ><img src="http://www.xunsearch.com/img/logo.jpg"/></a></p><p></p><p><nav><ul class="right list-paddingleft-2" ><li><p><a href="http://www.xunsearch.com/" >首页</a></p></li><li><p><a href="http://www.xunsearch.com/site/about" >关于Xunsearch▼</a></p></li><li><p><a href="http://www.xunsearch.com/site/demo" >演示</a></p></li><li><p><a href="http://www.xunsearch.com/site/download" >⇓ 下载</a></p></li><li><p><a href="http://www.xunsearch.com/doc/php" >文档▼</a></p></li><li><p><a href="http://www.xunsearch.com/site/support" >商业服务</a></p></li><li><p><a href="http://www.xunsearch.com/site/usercase" >客户案例</a></p></li><li><p><a href="http://www.xunsearch.com/site/donate" >捐赠</a></p></li><li><p><a target="_blank" href="http://bbs.xunsearch.com/" >论坛</a></p></li></ul></nav><header><h1 >文档说明</h1></header><section><p></p><ul class="side-nav list-paddingleft-2" ><li><p><a class="parentMenu" ><img src="http://www.xunsearch.com/img/minus.gif"/><span class="folder" >XS</span></a></p></li><ul class=" list-paddingleft-2"><li><p><span >▪ </span><a title="XS" href="http://www.xunsearch.com/doc/php/api/XS" >XS</a></p></li><li><p><span >▪ </span><a title="XSCommand" href="http://www.xunsearch.com/doc/php/api/XSCommand" >XSCommand</a></p></li><li><p><span >▪ </span><a title="XSComponent" href="http://www.xunsearch.com/doc/php/api/XSComponent" >XSComponent</a></p></li><li><p><span >▪ </span><a title="XSDocument" href="http://www.xunsearch.com/doc/php/api/XSDocument" >XSDocument</a></p></li><li><p><span >▪ </span><a title="XSErrorException" href="http://www.xunsearch.com/doc/php/api/XSErrorException" >XSErrorException</a></p></li><li><p><span >▪ </span><a title="XSException" href="http://www.xunsearch.com/doc/php/api/XSException" >XSException</a></p></li><li><p><span >▪ </span><a title="XSFieldMeta" href="http://www.xunsearch.com/doc/php/api/XSFieldMeta" >XSFieldMeta</a></p></li><li><p><span >▪ </span><a title="XSFieldScheme" href="http://www.xunsearch.com/doc/php/api/XSFieldScheme" >XSFieldScheme</a></p></li><li><p><span >▪ </span><a title="XSIndex" href="http://www.xunsearch.com/doc/php/api/XSIndex" >XSIndex</a></p></li><li><p><span >▪ </span><a title="XSSearch" href="http://www.xunsearch.com/doc/php/api/XSSearch" >XSSearch</a></p></li><li><p><span >▪ </span><a title="XSServer" href="http://www.xunsearch.com/doc/php/api/XSServer" >XSServer</a></p></li></ul><li><p><a class="parentMenu" ><img src="http://www.xunsearch.com/img/plus.gif"/><span class="folder" >XS.tokenizer</span></a></p></li><li><p><a class="parentMenu" ><img src="http://www.xunsearch.com/img/plus.gif"/><span class="folder" >XS.util</span></a></p></li><li><p><a class="parentMenu" ><img src="http://www.xunsearch.com/img/plus.gif"/><span class="folder" >XS.util.db</span></a></p></li><li><p><a class="parentMenu" ><img src="http://www.xunsearch.com/img/plus.gif"/><span class="folder" >XS.utilf</span></a></p></li></ul><p></p><h1 >XSSearch</h1><p><a href="http://www.xunsearch.com/doc/php/api/" >All Packages</a>|<a href="http://www.xunsearch.com/doc/php/api/XSSearch#properties" >属性</a>|<a href="http://www.xunsearch.com/doc/php/api/XSSearch#methods" >方法(函数)</a></p><table class="summaryTable docClass" width="652"><colgroup ><col class="col-name" /><col class="col-value" /></colgroup><tbody ><tr class="firstRow"><th >包</th><td ><a href="http://www.xunsearch.com/doc/php/api/#XS" >XS</a></td></tr><tr ><th >继承关系</th><td >class XSSearch »<a href="http://www.xunsearch.com/doc/php/api/XSServer" >XSServer</a>»<a href="http://www.xunsearch.com/doc/php/api/XSComponent" >XSComponent</a></td></tr><tr ><th >版本</th><td >1.0.0</td></tr><tr ><th >源代码</th><td ><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php" >sdk/php/lib/XSSearch.class.php</a></td></tr></tbody></table><p>XS 搜索类, 执行搜索功能 有部分方法支持串接操作</p><pre >$xs->search->setQuery($str)->setLimit(10,10)->search();
$xs->close();</pre><p><a ></a></p><h2 >Public 属性</h2><p ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="toggle" >隐去继承来的属性</a></p><table class="summaryTable" width="652"><colgroup ><col class="col-property" /><col class="col-type" /><col class="col-description" /><col class="col-defined" /></colgroup><tbody ><tr class="firstRow"><th >名称</th><th >类型</th><th >描述</th><th >定义于</th></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#allSynonyms-detail" >allSynonyms</a></td><td >array</td><td >获取当前库内的全部同义词列表</td><td >XSSearch</td></tr><tr class="inherited" ><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer#connString-detail" >connString</a></td><td >string</td><td >连接字符串</td><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer" >XSServer</a></td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#correctedQuery-detail" >correctedQuery</a></td><td >array</td><td >获取修正后的搜索词列表</td><td >XSSearch</td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#dbTotal-detail" >dbTotal</a></td><td >int</td><td >获取搜索数据库内的数据总量</td><td >XSSearch</td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#facets-detail" >facets</a></td><td >array</td><td >读取最近一次分面搜索记数</td><td >XSSearch</td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#hotQuery-detail" >hotQuery</a></td><td >array</td><td >获取热门搜索词列表</td><td >XSSearch</td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#lastCount-detail" >lastCount</a></td><td >int</td><td >获取最近那次搜索的匹配总数估值</td><td >XSSearch</td></tr><tr class="inherited" ><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer#project-detail" >project</a></td><td >string</td><td >获取当前项目名称</td><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer" >XSServer</a></td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#query-detail" >query</a></td><td >string</td><td >获取解析后的搜索语句</td><td >XSSearch</td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#relatedQuery-detail" >relatedQuery</a></td><td >array</td><td >获取相关搜索词列表</td><td >XSSearch</td></tr><tr class="inherited" ><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer#respond-detail" >respond</a></td><td ><a href="http://www.xunsearch.com/doc/php/api/XSCommand" >XSCommand</a></td><td >从服务器读取响应指令</td><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer" >XSServer</a></td></tr><tr class="inherited" ><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer#socket-detail" >socket</a></td><td >mixed</td><td >获取连接资源描述符</td><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer" >XSServer</a></td></tr><tr class="inherited" ><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer#xs-detail" >xs</a></td><td ><a href="http://www.xunsearch.com/doc/php/api/XS" >XS</a></td><td >服务端关联的 XS 对象</td><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer" >XSServer</a></td></tr></tbody></table><h2 >Protected 属性</h2><p ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="toggle" >隐去继承来的属性</a></p><table class="summaryTable" width="652"><colgroup ><col class="col-property" /><col class="col-type" /><col class="col-description" /><col class="col-defined" /></colgroup><tbody ><tr class="firstRow"><th >名称</th><th >类型</th><th >描述</th><th >定义于</th></tr><tr class="inherited" ><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer#_conn-detail" >_conn</a></td><td ><br/></td><td ><br/></td><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer" >XSServer</a></td></tr><tr class="inherited" ><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer#_flag-detail" >_flag</a></td><td ><br/></td><td ><br/></td><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer" >XSServer</a></td></tr><tr class="inherited" ><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer#_project-detail" >_project</a></td><td ><br/></td><td ><br/></td><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer" >XSServer</a></td></tr><tr class="inherited" ><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer#_sendBuffer-detail" >_sendBuffer</a></td><td ><br/></td><td ><br/></td><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer" >XSServer</a></td></tr><tr class="inherited" ><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer#_sock-detail" >_sock</a></td><td ><br/></td><td ><br/></td><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer" >XSServer</a></td></tr></tbody></table><p><a ></a></p><h2 >Public 方法</h2><p ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="toggle" >隐去继承来的方法</a></p><table class="summaryTable" width="652"><colgroup ><col class="col-method" /><col class="col-description" /><col class="col-defined" /></colgroup><tbody ><tr class="firstRow"><th >名称</th><th >描述</th><th >定义于</th></tr><tr class="inherited" ><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer#__construct-detail" >__construct()</a></td><td >构造函数, 打开连接</td><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer" >XSServer</a></td></tr><tr class="inherited" ><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer#__destruct-detail" >__destruct()</a></td><td >析构函数, 关闭连接</td><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer" >XSServer</a></td></tr><tr class="inherited" ><td ><a href="http://www.xunsearch.com/doc/php/api/XSComponent#__get-detail" >__get()</a></td><td >魔术方法 __get</td><td ><a href="http://www.xunsearch.com/doc/php/api/XSComponent" >XSComponent</a></td></tr><tr class="inherited" ><td ><a href="http://www.xunsearch.com/doc/php/api/XSComponent#__isset-detail" >__isset()</a></td><td >魔术方法 __isset</td><td ><a href="http://www.xunsearch.com/doc/php/api/XSComponent" >XSComponent</a></td></tr><tr class="inherited" ><td ><a href="http://www.xunsearch.com/doc/php/api/XSComponent#__set-detail" >__set()</a></td><td >魔术方法 __set</td><td ><a href="http://www.xunsearch.com/doc/php/api/XSComponent" >XSComponent</a></td></tr><tr class="inherited" ><td ><a href="http://www.xunsearch.com/doc/php/api/XSComponent#__unset-detail" >__unset()</a></td><td >魔术方法 __unset</td><td ><a href="http://www.xunsearch.com/doc/php/api/XSComponent" >XSComponent</a></td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#addDb-detail" >addDb()</a></td><td >添加搜索的数据库名, 支持多库同时搜索</td><td >XSSearch</td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#addQueryString-detail" >addQueryString()</a></td><td >增加默认搜索语句</td><td >XSSearch</td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#addQueryTerm-detail" >addQueryTerm()</a></td><td >增加默认搜索词汇</td><td >XSSearch</td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#addRange-detail" >addRange()</a></td><td >添加搜索过滤区间或范围</td><td >XSSearch</td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#addSearchLog-detail" >addSearchLog()</a></td><td >添加搜索日志关键词到缓冲区里</td><td >XSSearch</td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#addWeight-detail" >addWeight()</a></td><td >添加权重索引词</td><td >XSSearch</td></tr><tr class="inherited" ><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer#close-detail" >close()</a></td><td >关闭连接</td><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer" >XSServer</a></td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#count-detail" >count()</a></td><td >估算搜索语句的匹配数据量</td><td >XSSearch</td></tr><tr class="inherited" ><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer#execCommand-detail" >execCommand()</a></td><td >执行服务端指令并获取返回值</td><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer" >XSServer</a></td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#getAllSynonyms-detail" >getAllSynonyms()</a></td><td >获取当前库内的全部同义词列表</td><td >XSSearch</td></tr><tr class="inherited" ><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer#getConnString-detail" >getConnString()</a></td><td >Returns 连接字符串</td><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer" >XSServer</a></td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#getCorrectedQuery-detail" >getCorrectedQuery()</a></td><td >获取修正后的搜索词列表</td><td >XSSearch</td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#getDbTotal-detail" >getDbTotal()</a></td><td >获取搜索数据库内的数据总量</td><td >XSSearch</td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#getExpandedQuery-detail" >getExpandedQuery()</a></td><td >获取展开的搜索词列表</td><td >XSSearch</td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#getFacets-detail" >getFacets()</a></td><td >读取最近一次分面搜索记数</td><td >XSSearch</td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#getHotQuery-detail" >getHotQuery()</a></td><td >获取热门搜索词列表</td><td >XSSearch</td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#getLastCount-detail" >getLastCount()</a></td><td >获取最近那次搜索的匹配总数估值</td><td >XSSearch</td></tr><tr class="inherited" ><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer#getProject-detail" >getProject()</a></td><td >获取当前项目名称</td><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer" >XSServer</a></td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#getQuery-detail" >getQuery()</a></td><td >获取解析后的搜索语句</td><td >XSSearch</td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#getRelatedQuery-detail" >getRelatedQuery()</a></td><td >获取相关搜索词列表</td><td >XSSearch</td></tr><tr class="inherited" ><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer#getRespond-detail" >getRespond()</a></td><td >从服务器读取响应指令</td><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer" >XSServer</a></td></tr><tr class="inherited" ><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer#getSocket-detail" >getSocket()</a></td><td >获取连接资源描述符</td><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer" >XSServer</a></td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#getSynonyms-detail" >getSynonyms()</a></td><td >获取指定词汇的同义词列表</td><td >XSSearch</td></tr><tr class="inherited" ><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer#hasRespond-detail" >hasRespond()</a></td><td >判断服务端是否有可读数据</td><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer" >XSServer</a></td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#highlight-detail" >highlight()</a></td><td >搜索结果字符串高亮处理</td><td >XSSearch</td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#markResetScheme-detail" >markResetScheme()</a></td><td >标记字段方案重置</td><td >XSSearch</td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#open-detail" >open()</a></td><td >连接搜索服务端并初始化</td><td >XSSearch</td></tr><tr class="inherited" ><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer#reopen-detail" >reopen()</a></td><td >重新打开连接</td><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer" >XSServer</a></td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#search-detail" >search()</a></td><td >获取匹配的搜索结果文档</td><td >XSSearch</td></tr><tr class="inherited" ><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer#sendCommand-detail" >sendCommand()</a></td><td >往服务器直接发送指令 (无缓存)</td><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer" >XSServer</a></td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#setAutoSynonyms-detail" >setAutoSynonyms()</a></td><td >开启自动同义词搜索功能</td><td >XSSearch</td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#setCharset-detail" >setCharset()</a></td><td >设置字符集</td><td >XSSearch</td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#setCollapse-detail" >setCollapse()</a></td><td >设置折叠搜索结果</td><td >XSSearch</td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#setCutOff-detail" >setCutOff()</a></td><td >设置百分比/权重剔除参数</td><td >XSSearch</td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#setDb-detail" >setDb()</a></td><td >设置要搜索的数据库名</td><td >XSSearch</td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#setDocOrder-detail" >setDocOrder()</a></td><td >设置结果按索引入库先后排序</td><td >XSSearch</td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#setFacets-detail" >setFacets()</a></td><td >设置分面搜索记数</td><td >XSSearch</td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#setFuzzy-detail" >setFuzzy()</a></td><td >开启模糊搜索</td><td >XSSearch</td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#setGeodistSort-detail" >setGeodistSort()</a></td><td >设置地理位置距离排序方式</td><td >XSSearch</td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#setLimit-detail" >setLimit()</a></td><td >设置搜索结果的数量和偏移</td><td >XSSearch</td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#setMultiSort-detail" >setMultiSort()</a></td><td >设置多字段组合排序方式</td><td >XSSearch</td></tr><tr class="inherited" ><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer#setProject-detail" >setProject()</a></td><td >设置当前项目</td><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer" >XSServer</a></td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#setQuery-detail" >setQuery()</a></td><td >设置默认搜索语句</td><td >XSSearch</td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#setRequireMatchedTerm-detail" >setRequireMatchedTerm()</a></td><td >设置在搜索结果文档中返回匹配词表</td><td >XSSearch</td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#setScwsMulti-detail" >setScwsMulti()</a></td><td >设置当前搜索语句的分词复合等级</td><td >XSSearch</td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#setSort-detail" >setSort()</a></td><td >设置搜索结果的排序方式</td><td >XSSearch</td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#setSynonymScale-detail" >setSynonymScale()</a></td><td >设置同义词搜索的权重比例</td><td >XSSearch</td></tr><tr class="inherited" ><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer#setTimeout-detail" >setTimeout()</a></td><td >设置服务端超时秒数</td><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer" >XSServer</a></td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#setWeightingScheme-detail" >setWeightingScheme()</a></td><td >设置检索匹配的权重方案</td><td >XSSearch</td></tr><tr ><td ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#terms-detail" >terms()</a></td><td >获取搜索语句中的高亮词条列表</td><td >XSSearch</td></tr></tbody></table><h2 >Protected 方法</h2><p ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="toggle" >隐去继承来的方法</a></p><table class="summaryTable" width="652"><colgroup ><col class="col-method" /><col class="col-description" /><col class="col-defined" /></colgroup><tbody ><tr class="firstRow"><th >名称</th><th >描述</th><th >定义于</th></tr><tr class="inherited" ><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer#check-detail" >check()</a></td><td >检测服务端的连接情况</td><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer" >XSServer</a></td></tr><tr class="inherited" ><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer#connect-detail" >connect()</a></td><td >连接服务端</td><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer" >XSServer</a></td></tr><tr class="inherited" ><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer#read-detail" >read()</a></td><td >读取数据</td><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer" >XSServer</a></td></tr><tr class="inherited" ><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer#write-detail" >write()</a></td><td >写入数据</td><td ><a href="http://www.xunsearch.com/doc/php/api/XSServer" >XSServer</a></td></tr></tbody></table><p><a ></a></p><h2 >属性明细</h2><p>allSynonyms<span class="detailHeaderTag" >属性<em >只读</em>(自版本 v1.3.0 起可用)</span></p><p>public array<a href="http://www.xunsearch.com/doc/php/api/XSSearch#getAllSynonyms" ><strong >getAllSynonyms</strong></a>(int $limit=0, int $offset=0, bool $stemmed=false)</p><p >获取当前库内的全部同义词列表</p><p>correctedQuery<span class="detailHeaderTag" >属性<em >只读</em></span></p><p>public array<a href="http://www.xunsearch.com/doc/php/api/XSSearch#getCorrectedQuery" ><strong >getCorrectedQuery</strong></a>(string $query=NULL)</p><p >获取修正后的搜索词列表 通常当某次检索结果数量偏少时, 可以用该函数设计 "你是不是要找: ..." 功能</p><p>dbTotal<span class="detailHeaderTag" >属性<em >只读</em></span></p><p>public int<a href="http://www.xunsearch.com/doc/php/api/XSSearch#getDbTotal" ><strong >getDbTotal</strong></a>()</p><p >获取搜索数据库内的数据总量</p><p>facets<span class="detailHeaderTag" >属性 (自版本 v1.1.0 起可用)</span></p><p>public array<a href="http://www.xunsearch.com/doc/php/api/XSSearch#getFacets" ><strong >getFacets</strong></a>(string $field=NULL)<br/>public XSSearch<a href="http://www.xunsearch.com/doc/php/api/XSSearch#setFacets" ><strong >setFacets</strong></a>(mixed $field, bool $exact=false)</p><p >读取最近一次分面搜索记数 必须在某一次<a href="http://www.xunsearch.com/doc/php/api/XSSearch#search" >search</a>之后调用本函数才有意义</p><p>hotQuery<span class="detailHeaderTag" >属性<em >只读</em></span></p><p>public array<a href="http://www.xunsearch.com/doc/php/api/XSSearch#getHotQuery" ><strong >getHotQuery</strong></a>(int $limit=6, string $type='total')</p><p >获取热门搜索词列表</p><p>lastCount<span class="detailHeaderTag" >属性<em >只读</em></span></p><p>public int<a href="http://www.xunsearch.com/doc/php/api/XSSearch#getLastCount" ><strong >getLastCount</strong></a>()</p><p >获取最近那次搜索的匹配总数估值</p><h4 >参见</h4><ul class=" list-paddingleft-2"><li><p><a href="http://www.xunsearch.com/doc/php/api/XSSearch#search" >search</a></p></li></ul><p>query<span class="detailHeaderTag" >属性</span></p><p>public string<a href="http://www.xunsearch.com/doc/php/api/XSSearch#getQuery" ><strong >getQuery</strong></a>(string $query=NULL)<br/>public XSSearch<a href="http://www.xunsearch.com/doc/php/api/XSSearch#setQuery" ><strong >setQuery</strong></a>(string $query)</p><p >获取解析后的搜索语句</p><p>relatedQuery<span class="detailHeaderTag" >属性<em >只读</em></span></p><p>public array<a href="http://www.xunsearch.com/doc/php/api/XSSearch#getRelatedQuery" ><strong >getRelatedQuery</strong></a>(string $query=NULL, int $limit=6)</p><p >获取相关搜索词列表</p><h2 >方法明细</h2><p>addDb()<span class="detailHeaderTag" >方法</span></p><table class="summaryTable" width="652"><tbody ><tr class="firstRow"><td colspan="3" ><p>public XSSearch<strong >addDb</strong>(string $name)</p></td></tr><tr ><td class="paramNameCol" >$name</td><td class="paramTypeCol" >string</td><td class="paramDescCol" ><br/></td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >XSSearch</td><td class="paramDescCol" >返回对象本身以支持串接操作</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L555" >sdk/php/lib/XSSearch.class.php#L555</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >添加搜索的数据库名, 支持多库同时搜索</p><h4 >参见</h4><ul class=" list-paddingleft-2"><li><p><a href="http://www.xunsearch.com/doc/php/api/XSSearch#setDb" >setDb</a></p></li></ul><p>addQueryString()<span class="detailHeaderTag" >方法</span></p><table class="summaryTable" width="652"><tbody ><tr class="firstRow"><td colspan="3" ><p>public string<strong >addQueryString</strong>(string $query, int $addOp=0, float $scale=1)</p></td></tr><tr ><td class="paramNameCol" >$query</td><td class="paramTypeCol" >string</td><td class="paramDescCol" >搜索语句</td></tr><tr ><td class="paramNameCol" >$addOp</td><td class="paramTypeCol" >int</td><td class="paramDescCol" >与旧语句的结合操作符, 如果无旧语句或为空则这此无意义, 支持的操作符有: XS_CMD_QUERY_OP_AND XS_CMD_QUERY_OP_OR XS_CMD_QUERY_OP_AND_NOT XS_CMD_QUERY_OP_XOR XS_CMD_QUERY_OP_AND_MAYBE XS_CMD_QUERY_OP_FILTER</td></tr><tr ><td class="paramNameCol" >$scale</td><td class="paramTypeCol" >float</td><td class="paramDescCol" >权重计算缩放比例, 默认为 1表示不缩放, 其它值范围 0.xx ~ 655.35</td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >string</td><td class="paramDescCol" >修正后的搜索语句</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L1012" >sdk/php/lib/XSSearch.class.php#L1012</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >增加默认搜索语句</p><p>addQueryTerm()<span class="detailHeaderTag" >方法</span></p><table class="summaryTable" width="652"><tbody ><tr class="firstRow"><td colspan="3" ><p>public XSSearch<strong >addQueryTerm</strong>(string $field, string|array $term, int $addOp=0, float $scale=1)</p></td></tr><tr ><td class="paramNameCol" >$field</td><td class="paramTypeCol" >string</td><td class="paramDescCol" >索引词所属的字段, 若为混合区词汇可设为 null 或 body 型的字段名</td></tr><tr ><td class="paramNameCol" >$term</td><td class="paramTypeCol" >string|array</td><td class="paramDescCol" >索引词或列表</td></tr><tr ><td class="paramNameCol" >$addOp</td><td class="paramTypeCol" >int</td><td class="paramDescCol" >与旧语句的结合操作符, 如果无旧语句或为空则这此无意义, 支持的操作符有:</td></tr><tr ><td class="paramNameCol" >$scale</td><td class="paramTypeCol" >float</td><td class="paramDescCol" >权重计算缩放比例, 默认为 1表示不缩放, 其它值范围 0.xx ~ 655.35</td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >XSSearch</td><td class="paramDescCol" >返回对象本身以支持串接操作</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L1033" >sdk/php/lib/XSSearch.class.php#L1033</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >增加默认搜索词汇</p><h4 >参见</h4><ul class=" list-paddingleft-2"><li><p><a href="http://www.xunsearch.com/doc/php/api/XSSearch#addQueryString" >注：自 v1.4.10 起，允许传入数组，多词之间通过 defaultOp 连接，并且这些词不会再被分词。</a></p></li></ul><p>addRange()<span class="detailHeaderTag" >方法</span></p><table class="summaryTable" width="652"><tbody ><tr class="firstRow"><td colspan="3" ><p>public XSSearch<strong >addRange</strong>(string $field, mixed $from, mixed $to)</p></td></tr><tr ><td class="paramNameCol" >$field</td><td class="paramTypeCol" >string</td><td class="paramDescCol" ><br/></td></tr><tr ><td class="paramNameCol" >$from</td><td class="paramTypeCol" >mixed</td><td class="paramDescCol" >起始值(不包含), 若设为 null 则相当于匹配 <= to (字典顺序)</td></tr><tr ><td class="paramNameCol" >$to</td><td class="paramTypeCol" >mixed</td><td class="paramDescCol" >结束值(包含), 若设为 null 则相当于匹配 >= from (字典顺序)</td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >XSSearch</td><td class="paramDescCol" >返回对象本身以支持串接操作</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L410" >sdk/php/lib/XSSearch.class.php#L410</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >添加搜索过滤区间或范围</p><p>addSearchLog()<span class="detailHeaderTag" >方法 (自版本 v1.1.1 起可用)</span></p><table class="summaryTable" width="652"><tbody ><tr class="firstRow"><td colspan="3" ><p>public void<strong >addSearchLog</strong>(string $query, int $wdf=1)</p></td></tr><tr ><td class="paramNameCol" >$query</td><td class="paramTypeCol" >string</td><td class="paramDescCol" >需要记录的数据</td></tr><tr ><td class="paramNameCol" >$wdf</td><td class="paramTypeCol" >int</td><td class="paramDescCol" >需要记录的次数, 默认为 1</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L894" >sdk/php/lib/XSSearch.class.php#L894</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >添加搜索日志关键词到缓冲区里 需要调用<a href="http://www.xunsearch.com/doc/php/api/XSIndex#flushLogging" >XSIndex::flushLogging</a>才能确保立即刷新, 否则要隔一段时间</p><p>addWeight()<span class="detailHeaderTag" >方法</span></p><table class="summaryTable" width="652"><tbody ><tr class="firstRow"><td colspan="3" ><p>public XSSearch<strong >addWeight</strong>(string $field, string $term, float $weight=1)</p></td></tr><tr ><td class="paramNameCol" >$field</td><td class="paramTypeCol" >string</td><td class="paramDescCol" >索引词所属的字段</td></tr><tr ><td class="paramNameCol" >$term</td><td class="paramTypeCol" >string</td><td class="paramDescCol" >索引词</td></tr><tr ><td class="paramNameCol" >$weight</td><td class="paramTypeCol" >float</td><td class="paramDescCol" >权重计算缩放比例</td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >XSSearch</td><td class="paramDescCol" >返回对象本身以支持串接操作</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L447" >sdk/php/lib/XSSearch.class.php#L447</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >添加权重索引词 无论是否包含这种词都不影响搜索匹配, 但会参与计算结果权重, 使结果的相关度更高</p><h4 >参见</h4><ul class=" list-paddingleft-2"><li><p><a href="http://www.xunsearch.com/doc/php/api/XSSearch#addQueryTerm" >addQueryTerm</a></p></li></ul><p>count()<span class="detailHeaderTag" >方法</span></p><table class="summaryTable" width="652"><tbody ><tr class="firstRow"><td colspan="3" ><p>public int<strong >count</strong>(string $query=NULL)</p></td></tr><tr ><td class="paramNameCol" >$query</td><td class="paramTypeCol" >string</td><td class="paramDescCol" >搜索语句, 若传入 null 使用默认语句, 调用后会还原默认排序方式 如果搜索语句和最近一次<a href="http://www.xunsearch.com/doc/php/api/XSSearch#search" >search</a>的语句一样, 请改用<a href="http://www.xunsearch.com/doc/php/api/XSSearch#getLastCount" >getLastCount</a>以提升效率 最大长度为 80 字节</td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >int</td><td class="paramDescCol" >匹配的搜索结果数量, 估算数值</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L610" >sdk/php/lib/XSSearch.class.php#L610</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >估算搜索语句的匹配数据量</p><p>getAllSynonyms()<span class="detailHeaderTag" >方法 (自版本 v1.3.0 起可用)</span></p><table class="summaryTable" width="652"><tbody ><tr class="firstRow"><td colspan="3" ><p>public array<strong >getAllSynonyms</strong>(int $limit=0, int $offset=0, bool $stemmed=false)</p></td></tr><tr ><td class="paramNameCol" >$limit</td><td class="paramTypeCol" >int</td><td class="paramDescCol" >数量上限, 若设为 0 则启用默认值 100 个</td></tr><tr ><td class="paramNameCol" >$offset</td><td class="paramTypeCol" >int</td><td class="paramDescCol" >偏移量, 即跳过的结果数量, 默认为 0</td></tr><tr ><td class="paramNameCol" >$stemmed</td><td class="paramTypeCol" >bool</td><td class="paramDescCol" >是否包含处理过的词根同义词, 默认为 false 表示否</td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >array</td><td class="paramDescCol" >同义词记录数组, 每个词条为键, 同义词条组成的数组为值</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L179" >sdk/php/lib/XSSearch.class.php#L179</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >获取当前库内的全部同义词列表</p><p>getCorrectedQuery()<span class="detailHeaderTag" >方法</span></p><table class="summaryTable" width="652"><tbody ><tr class="firstRow"><td colspan="3" ><p>public array<strong >getCorrectedQuery</strong>(string $query=NULL)</p></td></tr><tr ><td class="paramNameCol" >$query</td><td class="paramTypeCol" >string</td><td class="paramDescCol" >需要展开的前缀, 可为拼音、英文、中文</td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >array</td><td class="paramDescCol" >返回搜索词组成的数组</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L858" >sdk/php/lib/XSSearch.class.php#L858</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >获取修正后的搜索词列表 通常当某次检索结果数量偏少时, 可以用该函数设计 "你是不是要找: ..." 功能</p><p>getDbTotal()<span class="detailHeaderTag" >方法</span></p><table class="summaryTable" width="652"><tbody ><tr class="firstRow"><td colspan="3" ><p>public int<strong >getDbTotal</strong>()</p></td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >int</td><td class="paramDescCol" >数据总量</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L722" >sdk/php/lib/XSSearch.class.php#L722</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >获取搜索数据库内的数据总量</p><p>getExpandedQuery()<span class="detailHeaderTag" >方法</span></p><table class="summaryTable" width="652"><tbody ><tr class="firstRow"><td colspan="3" ><p>public array<strong >getExpandedQuery</strong>(string $query, int $limit=10)</p></td></tr><tr ><td class="paramNameCol" >$query</td><td class="paramTypeCol" >string</td><td class="paramDescCol" >需要展开的前缀, 可为拼音、英文、中文</td></tr><tr ><td class="paramNameCol" >$limit</td><td class="paramTypeCol" >int</td><td class="paramDescCol" >需要返回的搜索词数量上限, 默认为 10, 最大值为 20</td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >array</td><td class="paramDescCol" >返回搜索词组成的数组</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L818" >sdk/php/lib/XSSearch.class.php#L818</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >获取展开的搜索词列表</p><p>getFacets()<span class="detailHeaderTag" >方法 (自版本 v1.1.0 起可用)</span></p><table class="summaryTable" width="652"><tbody ><tr class="firstRow"><td colspan="3" ><p>public array<strong >getFacets</strong>(string $field=NULL)</p></td></tr><tr ><td class="paramNameCol" >$field</td><td class="paramTypeCol" >string</td><td class="paramDescCol" >读取分面记数的字段, 若为 null 则返回全部分面搜索记录</td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >array</td><td class="paramDescCol" >返回由值和计数组成的关联数组, 若不存在或未曾登记过则返回空数组</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L490" >sdk/php/lib/XSSearch.class.php#L490</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >读取最近一次分面搜索记数 必须在某一次<a href="http://www.xunsearch.com/doc/php/api/XSSearch#search" >search</a>之后调用本函数才有意义</p><p>getHotQuery()<span class="detailHeaderTag" >方法</span></p><table class="summaryTable" width="652"><tbody ><tr class="firstRow"><td colspan="3" ><p>public array<strong >getHotQuery</strong>(int $limit=6, string $type='total')</p></td></tr><tr ><td class="paramNameCol" >$limit</td><td class="paramTypeCol" >int</td><td class="paramDescCol" >需要返回的热门搜索数量上限, 默认为 6, 最大值为 50</td></tr><tr ><td class="paramNameCol" >$type</td><td class="paramTypeCol" >string</td><td class="paramDescCol" >排序类型, 默认为 total(搜索总量), 可选值还有 lastnum(上周), currnum(本周)</td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >array</td><td class="paramDescCol" >返回以搜索词为键, 搜索指数为值的关联数组</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L736" >sdk/php/lib/XSSearch.class.php#L736</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >获取热门搜索词列表</p><p>getLastCount()<span class="detailHeaderTag" >方法</span></p><table class="summaryTable" width="652"><tbody ><tr class="firstRow"><td colspan="3" ><p>public int<strong >getLastCount</strong>()</p></td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >int</td><td class="paramDescCol" >匹配数据量, 如从未搜索则返回 false</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L713" >sdk/php/lib/XSSearch.class.php#L713</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >获取最近那次搜索的匹配总数估值</p><h4 >参见</h4><ul class=" list-paddingleft-2"><li><p><a href="http://www.xunsearch.com/doc/php/api/XSSearch#search" >search</a></p></li></ul><p>getQuery()<span class="detailHeaderTag" >方法</span></p><table class="summaryTable" width="652"><tbody ><tr class="firstRow"><td colspan="3" ><p>public string<strong >getQuery</strong>(string $query=NULL)</p></td></tr><tr ><td class="paramNameCol" >$query</td><td class="paramTypeCol" >string</td><td class="paramDescCol" >搜索语句, 若传入 null 使用默认语句</td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >string</td><td class="paramDescCol" >返回解析后的搜索语句</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L219" >sdk/php/lib/XSSearch.class.php#L219</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >获取解析后的搜索语句</p><p>getRelatedQuery()<span class="detailHeaderTag" >方法</span></p><table class="summaryTable" width="652"><tbody ><tr class="firstRow"><td colspan="3" ><p>public array<strong >getRelatedQuery</strong>(string $query=NULL, int $limit=6)</p></td></tr><tr ><td class="paramNameCol" >$query</td><td class="paramTypeCol" >string</td><td class="paramDescCol" >搜索语句, 若传入 null 使用默认语句</td></tr><tr ><td class="paramNameCol" >$limit</td><td class="paramTypeCol" >int</td><td class="paramDescCol" >需要返回的相关搜索数量上限, 默认为 6, 最大值为 20</td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >array</td><td class="paramDescCol" >返回搜索词组成的数组</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L770" >sdk/php/lib/XSSearch.class.php#L770</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >获取相关搜索词列表</p><p>getSynonyms()<span class="detailHeaderTag" >方法 (自版本 v1.4.9 起可用)</span></p><table class="summaryTable" width="652"><tbody ><tr class="firstRow"><td colspan="3" ><p>public array<strong >getSynonyms</strong>(string $term)</p></td></tr><tr ><td class="paramNameCol" >$term</td><td class="paramTypeCol" >string</td><td class="paramDescCol" >要查询同义词的原词</td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >array</td><td class="paramDescCol" >同义词记录数组, 不存在同义词则返回空数组</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L202" >sdk/php/lib/XSSearch.class.php#L202</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >获取指定词汇的同义词列表</p><p>highlight()<span class="detailHeaderTag" >方法</span></p><table class="summaryTable" width="652"><tbody ><tr class="firstRow"><td colspan="3" ><p>public string<strong >highlight</strong>(string $value, $strtr=false)</p></td></tr><tr ><td class="paramNameCol" >$value</td><td class="paramTypeCol" >string</td><td class="paramDescCol" >需要处理的数据</td></tr><tr ><td class="paramNameCol" >$strtr</td><td class="paramTypeCol" ><br/></td><td class="paramDescCol" ><br/></td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >string</td><td class="paramDescCol" >高亮后的数据</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L909" >sdk/php/lib/XSSearch.class.php#L909</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >搜索结果字符串高亮处理 对搜索结果文档的字段进行高亮、飘红处理, 高亮部分加上 em 标记</p><p>markResetScheme()<span class="detailHeaderTag" >方法</span></p><table class="summaryTable" width="652"><tbody ><tr class="firstRow"><td colspan="3" ><p>public void<strong >markResetScheme</strong>()</p></td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L567" >sdk/php/lib/XSSearch.class.php#L567</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >标记字段方案重置</p><h4 >参见</h4><ul class=" list-paddingleft-2"><li><p><a href="http://www.xunsearch.com/doc/php/api/XS#setScheme" >XS::setScheme</a></p></li></ul><p>open()<span class="detailHeaderTag" >方法</span></p><table class="summaryTable" width="652"><tbody ><tr class="firstRow"><td colspan="3" ><p>public void<strong >open</strong>(string $conn)</p></td></tr><tr ><td class="paramNameCol" >$conn</td><td class="paramTypeCol" >string</td><td class="paramDescCol" ><br/></td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L55" >sdk/php/lib/XSSearch.class.php#L55</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >连接搜索服务端并初始化 每次重新连接后所有的搜索语句相关设置均被还原</p><h4 >参见</h4><ul class=" list-paddingleft-2"><li><p><a href="http://www.xunsearch.com/doc/php/api/XSServer#open" >XSServer::open</a></p></li></ul><p>search()<span class="detailHeaderTag" >方法</span></p><table class="summaryTable" width="652"><tbody ><tr class="firstRow"><td colspan="3" ><p>public XSDocument[]<strong >search</strong>(string $query=NULL, boolean $saveHighlight=true)</p></td></tr><tr ><td class="paramNameCol" >$query</td><td class="paramTypeCol" >string</td><td class="paramDescCol" >搜索语句, 若传入 null 使用默认语句, 最大长度为 80 字节</td></tr><tr ><td class="paramNameCol" >$saveHighlight</td><td class="paramTypeCol" >boolean</td><td class="paramDescCol" >是否存储查询词用于高亮处理, 默认为 true</td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >XSDocument[]</td><td class="paramDescCol" >匹配的搜索结果文档列表</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L635" >sdk/php/lib/XSSearch.class.php#L635</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >获取匹配的搜索结果文档 默认提取最匹配的前 self::PAGE_SIZE 个结果 如需分页请参见<a href="http://www.xunsearch.com/doc/php/api/XSSearch#setLimit" >setLimit</a>设置, 每次调用本函数后都会还原 setLimit 的设置</p><p>setAutoSynonyms()<span class="detailHeaderTag" >方法 (自版本 v1.3.0 起可用)</span></p><table class="summaryTable" width="652"><tbody ><tr class="firstRow"><td colspan="3" ><p>public XSSearch<strong >setAutoSynonyms</strong>(bool $value=true)</p></td></tr><tr ><td class="paramNameCol" >$value</td><td class="paramTypeCol" >bool</td><td class="paramDescCol" >设为 true 表示开启同义词功能, 设为 false 关闭同义词功能</td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >XSSearch</td><td class="paramDescCol" >返回对象本身以支持串接操作</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L144" >sdk/php/lib/XSSearch.class.php#L144</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >开启自动同义词搜索功能</p><p>setCharset()<span class="detailHeaderTag" >方法</span></p><table class="summaryTable" width="652"><tbody ><tr class="firstRow"><td colspan="3" ><p>public XSSearch<strong >setCharset</strong>(string $charset)</p></td></tr><tr ><td class="paramNameCol" >$charset</td><td class="paramTypeCol" >string</td><td class="paramDescCol" ><br/></td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >XSSearch</td><td class="paramDescCol" >返回对象本身以支持串接操作</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L69" >sdk/php/lib/XSSearch.class.php#L69</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >设置字符集 默认字符集是 UTF-8, 如果您提交的搜索语句和预期得到的搜索结果为其它字符集, 请先设置</p><p>setCollapse()<span class="detailHeaderTag" >方法</span></p><table class="summaryTable" width="652"><tbody ><tr class="firstRow"><td colspan="3" ><p>public XSSearch<strong >setCollapse</strong>(string $field, int $num=1)</p></td></tr><tr ><td class="paramNameCol" >$field</td><td class="paramTypeCol" >string</td><td class="paramDescCol" >依据该字段的值折叠搜索结果, 设为 null 则取消折叠</td></tr><tr ><td class="paramNameCol" >$num</td><td class="paramTypeCol" >int</td><td class="paramDescCol" >折叠后只是返最匹配的数据数量, 默认为 1, 最大值 255</td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >XSSearch</td><td class="paramDescCol" >返回对象本身以支持串接操作</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L393" >sdk/php/lib/XSSearch.class.php#L393</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >设置折叠搜索结果 注意, 每当调用<a href="http://www.xunsearch.com/doc/php/api/XSSearch#setDb" >setDb</a>或<a href="http://www.xunsearch.com/doc/php/api/XSSearch#addDb" >addDb</a>修改当前数据库时会重置此项设置</p><p>setCutOff()<span class="detailHeaderTag" >方法</span></p><table class="summaryTable" width="652"><tbody ><tr class="firstRow"><td colspan="3" ><p>public XSSearch<strong >setCutOff</strong>(int $percent, float $weight=0)</p></td></tr><tr ><td class="paramNameCol" >$percent</td><td class="paramTypeCol" >int</td><td class="paramDescCol" >剔除匹配百分比低于此值的文档, 值范围 0-100</td></tr><tr ><td class="paramNameCol" >$weight</td><td class="paramTypeCol" >float</td><td class="paramDescCol" >剔除权重低于此值的文档, 值范围 0.1-25.5, 0 表示不剔除</td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >XSSearch</td><td class="paramDescCol" >返回对象本身以支持串接操作</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L98" >sdk/php/lib/XSSearch.class.php#L98</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >设置百分比/权重剔除参数 通常是在开启<a href="http://www.xunsearch.com/doc/php/api/XSSearch#setFuzzy" >setFuzzy</a>或使用 OR 连接搜索语句时才需要设置此项</p><h4 >参见</h4><ul class=" list-paddingleft-2"><li><p><a href="http://www.xunsearch.com/doc/php/api/XSSearch#setFuzzy" >setFuzzy</a></p></li></ul><p>setDb()<span class="detailHeaderTag" >方法</span></p><table class="summaryTable" width="652"><tbody ><tr class="firstRow"><td colspan="3" ><p>public XSSearch<strong >setDb</strong>(string $name)</p></td></tr><tr ><td class="paramNameCol" >$name</td><td class="paramTypeCol" >string</td><td class="paramDescCol" ><br/></td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >XSSearch</td><td class="paramDescCol" >返回对象本身以支持串接操作</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L538" >sdk/php/lib/XSSearch.class.php#L538</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >设置要搜索的数据库名 若未设置, 使用默认数据库, 数据库必须位于服务端用户目录下 对于远程数据库, 请使用 stub 文件来支持</p><p>setDocOrder()<span class="detailHeaderTag" >方法</span></p><table class="summaryTable" width="652"><tbody ><tr class="firstRow"><td colspan="3" ><p>public XSSearch<strong >setDocOrder</strong>(bool $asc=false)</p></td></tr><tr ><td class="paramNameCol" >$asc</td><td class="paramTypeCol" >bool</td><td class="paramDescCol" >是否为正序排列, 即从先到后, 默认为反序</td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >XSSearch</td><td class="paramDescCol" >返回对象本身以支持串接操作</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L378" >sdk/php/lib/XSSearch.class.php#L378</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >设置结果按索引入库先后排序 注意, 此项排序不影响相关排序, 权重高的仍会在前面, 主要适合用于布尔检索</p><p>setFacets()<span class="detailHeaderTag" >方法 (自版本 v1.1.0 起可用)</span></p><table class="summaryTable" width="652"><tbody ><tr class="firstRow"><td colspan="3" ><p>public XSSearch<strong >setFacets</strong>(mixed $field, bool $exact=false)</p></td></tr><tr ><td class="paramNameCol" >$field</td><td class="paramTypeCol" >mixed</td><td class="paramDescCol" >要进行分组统计的字段或字段组成的数组, 最多同时支持 8 个</td></tr><tr ><td class="paramNameCol" >$exact</td><td class="paramTypeCol" >bool</td><td class="paramDescCol" >是否要求绝对精确搜索, 这会造成较大的系统开销</td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >XSSearch</td><td class="paramDescCol" >返回对象本身以支持串接操作</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L464" >sdk/php/lib/XSSearch.class.php#L464</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >设置分面搜索记数 用于记录匹配搜索结果中按字段值分组的数量统计, 每次调用<a href="http://www.xunsearch.com/doc/php/api/XSSearch#search" >search</a>后会还原设置 对于多次调用 $exact 参数以最后一次为准, 只支持字段值不超过 255 字节的情况<br/><br/>自 v1.4.10 起自动对空值的字段按 term 分面统计（相当于多值）</p><p>setFuzzy()<span class="detailHeaderTag" >方法</span></p><table class="summaryTable" width="652"><tbody ><tr class="firstRow"><td colspan="3" ><p>public XSSearch<strong >setFuzzy</strong>(bool $value=true)</p></td></tr><tr ><td class="paramNameCol" >$value</td><td class="paramTypeCol" >bool</td><td class="paramDescCol" >设为 true 表示开启模糊搜索, 设为 false 关闭模糊搜索</td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >XSSearch</td><td class="paramDescCol" >返回对象本身以支持串接操作</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L84" >sdk/php/lib/XSSearch.class.php#L84</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >开启模糊搜索 默认情况只返回包含所有搜索词的记录, 通过本方法可以获得更多搜索结果</p><p>setGeodistSort()<span class="detailHeaderTag" >方法 (自版本 v1.4.10 起可用)</span></p><table class="summaryTable" width="652"><tbody ><tr class="firstRow"><td colspan="3" ><p>public XSSearch<strong >setGeodistSort</strong>(array $fields, bool $reverse=false, bool $relevance_first=false)</p></td></tr><tr ><td class="paramNameCol" >$fields</td><td class="paramTypeCol" >array</td><td class="paramDescCol" >在此定义地理位置信息原点坐标信息，数组至少必须包含2个值</td></tr><tr ><td class="paramNameCol" >$reverse</td><td class="paramTypeCol" >bool</td><td class="paramDescCol" >是否由远及近排序, 默认为由近及远</td></tr><tr ><td class="paramNameCol" >$relevance_first</td><td class="paramTypeCol" >bool</td><td class="paramDescCol" >是否优先相关性排序, 默认为否</td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >XSSearch</td><td class="paramDescCol" >返回对象本身以支持串接操作</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L266" >sdk/php/lib/XSSearch.class.php#L266</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >设置地理位置距离排序方式<br/><br/>请务必先以 numeric 类型字段定义经纬度坐标字段，例如用 lon 代表经度、lat 代表纬度， 那么设置排序代码如下，必须将经度定义在前纬度在后：</p><pre >$search->setGeodistSort(array('lon'=>39.18,'lat'=>120.51));</pre><p ><br/></p><p>setLimit()<span class="detailHeaderTag" >方法</span></p><table class="summaryTable" width="652"><tbody ><tr class="firstRow"><td colspan="3" ><p>public XSSearch<strong >setLimit</strong>(int $limit, int $offset=0)</p></td></tr><tr ><td class="paramNameCol" >$limit</td><td class="paramTypeCol" >int</td><td class="paramDescCol" >数量上限, 若设为 0 则启用默认值 self::PAGE_SIZE</td></tr><tr ><td class="paramNameCol" >$offset</td><td class="paramTypeCol" >int</td><td class="paramDescCol" >偏移量, 即跳过的结果数量, 默认为 0</td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >XSSearch</td><td class="paramDescCol" >返回对象本身以支持串接操作</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L524" >sdk/php/lib/XSSearch.class.php#L524</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >设置搜索结果的数量和偏移 用于搜索结果分页, 每次调用<a href="http://www.xunsearch.com/doc/php/api/XSSearch#search" >search</a>后会还原这2个变量到初始值</p><p>setMultiSort()<span class="detailHeaderTag" >方法 (自版本 v1.1.0 起可用)</span></p><table class="summaryTable" width="652"><tbody ><tr class="firstRow"><td colspan="3" ><p>public XSSearch<strong >setMultiSort</strong>(array $fields, bool $reverse=false, bool $relevance_first=false)</p></td></tr><tr ><td class="paramNameCol" >$fields</td><td class="paramTypeCol" >array</td><td class="paramDescCol" >排序依据的字段数组, 以字段名称为键, true/false 为值表示正序或逆序</td></tr><tr ><td class="paramNameCol" >$reverse</td><td class="paramTypeCol" >bool</td><td class="paramDescCol" >是否为倒序显示, 默认为正向, 此处和<a href="http://www.xunsearch.com/doc/php/api/XSSearch#setSort" >setSort</a>略有不同</td></tr><tr ><td class="paramNameCol" >$relevance_first</td><td class="paramTypeCol" >bool</td><td class="paramDescCol" >是否优先相关性排序, 默认为否</td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >XSSearch</td><td class="paramDescCol" >返回对象本身以支持串接操作</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L307" >sdk/php/lib/XSSearch.class.php#L307</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >设置多字段组合排序方式 当您需要根据多个字段的值按不同的方式综合排序时, 请使用这项</p><p>setQuery()<span class="detailHeaderTag" >方法</span></p><table class="summaryTable" width="652"><tbody ><tr class="firstRow"><td colspan="3" ><p>public XSSearch<strong >setQuery</strong>(string $query)</p></td></tr><tr ><td class="paramNameCol" >$query</td><td class="paramTypeCol" >string</td><td class="paramDescCol" >搜索语句, 设为 null 则清空搜索语句, 最大长度为 80 字节</td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >XSSearch</td><td class="paramDescCol" >返回对象本身以支持串接操作</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L242" >sdk/php/lib/XSSearch.class.php#L242</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >设置默认搜索语句 用于不带参数的<a href="http://www.xunsearch.com/doc/php/api/XSSearch#count" >count</a>或<a href="http://www.xunsearch.com/doc/php/api/XSSearch#search" >search</a>以及<a href="http://www.xunsearch.com/doc/php/api/XSSearch#terms" >terms</a>调用 可与<a href="http://www.xunsearch.com/doc/php/api/XSSearch#addWeight" >addWeight</a>组合运用</p><p>setRequireMatchedTerm()<span class="detailHeaderTag" >方法 (自版本 v1.4.8 起可用)</span></p><table class="summaryTable" width="652"><tbody ><tr class="firstRow"><td colspan="3" ><p>public XSSearch<strong >setRequireMatchedTerm</strong>(bool $value=true)</p></td></tr><tr ><td class="paramNameCol" >$value</td><td class="paramTypeCol" >bool</td><td class="paramDescCol" >设为 true 表示开启返回, 设为 false 关闭该功能, 默认是不开启</td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >XSSearch</td><td class="paramDescCol" >返回对象本身以支持串接操作</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L114" >sdk/php/lib/XSSearch.class.php#L114</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >设置在搜索结果文档中返回匹配词表 请在<a href="http://www.xunsearch.com/doc/php/api/XSSearch#search" >search</a>前调用本方法, 然后使用 XSDocument::matched 获取</p><p>setScwsMulti()<span class="detailHeaderTag" >方法 (自版本 v1.4.7 起可用)</span></p><table class="summaryTable" width="652"><tbody ><tr class="firstRow"><td colspan="3" ><p>public XSSearch<strong >setScwsMulti</strong>(int $level)</p></td></tr><tr ><td class="paramNameCol" >$level</td><td class="paramTypeCol" >int</td><td class="paramDescCol" >要设置的分词复合等级</td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >XSSearch</td><td class="paramDescCol" >返回自身对象以支持串接操作</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L507" >sdk/php/lib/XSSearch.class.php#L507</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >设置当前搜索语句的分词复合等级 复合等级是 scws 分词粒度控制的一个重要参数, 是长词细分处理依据, 默认为 3, 值范围 0~15 注意: 这个设置仅直对本次搜索有效, 仅对设置之后的<a href="http://www.xunsearch.com/doc/php/api/XSSearch#setQuery" >setQuery</a>起作用, 由于 query 设计的方式问题, 目前无法支持搜索语句单字切分, 但您可以在模糊检索时设为 0 来关闭复合分词</p><p>setSort()<span class="detailHeaderTag" >方法</span></p><table class="summaryTable" width="652"><tbody ><tr class="firstRow"><td colspan="3" ><p>public XSSearch<strong >setSort</strong>(string $field, bool $asc=false, bool $relevance_first=false)</p></td></tr><tr ><td class="paramNameCol" >$field</td><td class="paramTypeCol" >string</td><td class="paramDescCol" >依据指定字段的值排序, 设为 null 则用默认顺序</td></tr><tr ><td class="paramNameCol" >$asc</td><td class="paramTypeCol" >bool</td><td class="paramDescCol" >是否为正序排列, 即从小到大, 从少到多, 默认为反序</td></tr><tr ><td class="paramNameCol" >$relevance_first</td><td class="paramTypeCol" >bool</td><td class="paramDescCol" >是否优先相关性排序, 默认为否</td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >XSSearch</td><td class="paramDescCol" >返回对象本身以支持串接操作</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L350" >sdk/php/lib/XSSearch.class.php#L350</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >设置搜索结果的排序方式 注意, 每当调用<a href="http://www.xunsearch.com/doc/php/api/XSSearch#setDb" >setDb</a>或<a href="http://www.xunsearch.com/doc/php/api/XSSearch#addDb" >addDb</a>修改当前数据库时会重置排序设定 此函数第一参数的用法与<a href="http://www.xunsearch.com/doc/php/api/XSSearch#setMultiSort" >setMultiSort</a>兼容, 即也可以用该方法实现多字段排序</p><p>setSynonymScale()<span class="detailHeaderTag" >方法 (自版本 v1.4.7 起可用)</span></p><table class="summaryTable" width="652"><tbody ><tr class="firstRow"><td colspan="3" ><p>public XSSearch<strong >setSynonymScale</strong>(float $value)</p></td></tr><tr ><td class="paramNameCol" >$value</td><td class="paramTypeCol" >float</td><td class="paramDescCol" >取值范围 0.01-2.55, 1 表示不调整</td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >XSSearch</td><td class="paramDescCol" >返回对象本身以支持串接操作</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L162" >sdk/php/lib/XSSearch.class.php#L162</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >设置同义词搜索的权重比例</p><p>setWeightingScheme()<span class="detailHeaderTag" >方法 (自版本 v1.4.11 起可用)</span></p><table class="summaryTable" width="652"><tbody ><tr class="firstRow"><td colspan="3" ><p>public XSSearch<strong >setWeightingScheme</strong>(int $scheme)</p></td></tr><tr ><td class="paramNameCol" >$scheme</td><td class="paramTypeCol" >int</td><td class="paramDescCol" >匹配权重方案</td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >XSSearch</td><td class="paramDescCol" >返回对象本身以支持串接操作</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L130" >sdk/php/lib/XSSearch.class.php#L130</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >设置检索匹配的权重方案 目前支持三种权重方案: 0=BM25/1=Bool/2=Trad</p><p>terms()<span class="detailHeaderTag" >方法</span></p><table class="summaryTable" width="652"><tbody ><tr class="firstRow"><td colspan="3" ><p>public array<strong >terms</strong>(string $query=NULL, bool $convert=true)</p></td></tr><tr ><td class="paramNameCol" >$query</td><td class="paramTypeCol" >string</td><td class="paramDescCol" >搜索语句, 若传入 null 使用默认语句, 最大长度为 80 字节</td></tr><tr ><td class="paramNameCol" >$convert</td><td class="paramTypeCol" >bool</td><td class="paramDescCol" >是否进行编码转换, 默认为 true</td></tr><tr ><td class="paramNameCol" >{return}</td><td class="paramTypeCol" >array</td><td class="paramDescCol" >可用于高亮显示的词条列表</td></tr></tbody></table><p><strong >源码:</strong><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSSearch.class.php#L578" >sdk/php/lib/XSSearch.class.php#L578</a>(<strong ><a href="http://www.xunsearch.com/doc/php/api/XSSearch#" class="show" >显示</a></strong>)</p><p >获取搜索语句中的高亮词条列表</p></section></p>