API

在Xunsearch全文搜索插件的addons/xunsearch/library/目录下提供了Xunsearch.php用于在项目任何位置访问Xunsearch的相关信息。

实例化对象

调用相关的对象方法，我们需要先实例化对象，可以使用以下两种方法进行实例化

$search = new \addons\xunsearch/library/Xunsearch("项目名称");
$search = \addons\xunsearch/library/Xunsearch::instance("项目名称");

在实例化完成后即可通过$search->方法名称();的形式来调用相关的方法

对象方法

getXS

用于获取XS对象。

$xs = $search->getXS();

add

添加指定数据到Xunsearch索引库

$data = [
    'id'=>1,
    'title'=>'标题',
    'content'=>'主体内容'
];
$search->add($data);

update

更新Xunsearch索引库中指定数据

$data = [
    'id'=>1,
    'title'=>'标题1',
    'content'=>'主体内容1'
];
$search->update($data);

del

删除Xunsearch索引库中的指定数据

$search->del(1);

suggestion

获取指定搜索词的建议列表

$search->suggestion("关键词", 10);

related

获取指定搜索词的相关搜索列表

$search->related("关键词", 10);

search

获取指定搜索词的搜索结果

$search->search("搜索词");
$search->search("搜索词", 1);
$search->search("搜索词", 1, 20);

getScws

获取分词对象

$scws = $search->getScws();

静态方法

//获取单例对象
\addons\xunsearch/library/Xunsearch::instance();
//添加类映射
\addons\xunsearch/library/Xunsearch::addClassMap();
//获取项目的ini文件位置
\addons\xunsearch/library/Xunsearch::getProjectIniFile("项目名称");