xunsearch

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

★ 8 Open GitHub ↗

xunsearch【讯搜全文索引】composer package

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Xunsearch for PHP

---
[![](https://travis-ci.org/ShaoZeMing/xunsearch.svg?branch=master)](https://travis-ci.org/ShaoZeMing/xunsearch) 
[![](https://img.shields.io/packagist/v/ShaoZeMing/xunsearch.svg)](https://packagist.org/packages/shaozeming/xunsearch) 
[![](https://img.shields.io/packagist/dt/ShaoZeMing/xunsearch.svg)](https://packagist.org/packages/stichoza/shaozeming/xunsearch)

## 前置说明：

### 请先安装xunsearch 服务端：

- 普通编译安装(推荐)

```

wget http://www.xunsearch.com/download/xunsearch-full-latest.tar.bz2
tar -xjf xunsearch-full-latest.tar.bz2

cd xunsearch-full-1.4.10/
sh setup.sh  
//第一次安装的话，过程可能会稍显漫长，请不必着急，您大可泡杯茶一边喝一边等待即可。
               
cd $prefix ; bin/xs-ctl.sh restart

更多详情请移步：http://www.xunsearch.com/doc/php/guide/start.installation
```

- docker 安装
```$xslt
Docker 方式安装服务端
---------------------

//下载映像：

docker pull hightman/xunsearch

//启动映像：

docker run --name xunsearch -d \
-p 8383:8383 -p 8384:8384 \
-v /var/xunsearch/data:/usr/local/xunsearch/data \
hightman/xunsearch:latest

//以上启动参数可自行修改，该方式仅运行服务端

```

## Installing

```shell
$ composer require shaozeming/xunsearch -v
```

### configuration

-  老师搜索库配置 配置结构和官方ini文件类似，只不过替换为了php 数组形式方式展示，请照着官方文档和本配置文件对比，葫芦画瓢：http://www.xunsearch.com/doc/php/guide/ini.guide

```php
// config/xunsearch.php

'default' => 'teacher',   //默认搜索库

'databases' => [

//        老师搜索库配置 配置结构和官方ini文件类似，只不过替换为了php 数组形式方式展示，请照着官方文档和本配置文件对比，葫芦画瓢：http://www.xunsearch.com/doc/php/guide/ini.guide
        'teacher' => [
            'project.name' => 'teacher',
            'project.default_charset' => 'utf-8',
            'server.index' => '127.0.0.1:8383',
            'server.search' => '127.0.0.1:8384',
            'id' => [
                'type' => 'id',
            ],
            'email' => [
                'index' => 'mixed',
            ],
            'name' => [
                'index' => 'mixed',
            ],
            'desc' => [
                'index' => 'mixed',
            ],

//学生搜索库
        'student' => [
            'project.name' => 'student',
            'project.default_charset' => 'utf-8',
            'server.index' => '127.0.0.1:8383',
            'server.search' => '127.0.0.1:8384',
            'id' => [
                'type' => 'id',
            ],
            'email' => [
                'index' => 'mixed',
            ],
            'name' => [
                'index' => 'mixed',
            ],
            'desc' => [
                'index' => 'mixed',
            ],

//        ...
    ],

```

Example:

```php

define('XS_APP_ROOT', 'your/config_file_path/dir/');  //可以定义配置文件目录
        $xs = new XunsearchService();

$data =[
            ['id' => 1, 'email' => '928240096@qq.com', 'name' => 'Shao ZeMing 邵泽明 邵澤明', 'lesson' => '朗诵主持,Reciting Hosting,朗誦主持，','desc'=>'我是谁，我在哪儿，我要做什么，我不告诉你'],
            ['id' => 2, 'email' => '12315@qq.com', 'name' => 'Chris Dong 董胜君  董勝君', 'lesson' => '朗诵主持,Reciting Hosting,朗誦主持，演講辯論，speech debate，演讲辩论','desc'=>'如果有一天，我走了，你应该知道我去了哪儿'],
            ['id' => 3, 'email' => 'shao-ze-ming@outlook.com', 'name' => '二傻子 Two fools', 'lesson' => '朗诵主持,Reciting Hosting,朗誦主持，','desc'=>'最近头发掉的厉害，我该怎么办好呀'],
            ['id' => 4, 'email' => 'szm19920426@qq.com', 'name' => '君莫笑 jun mo xiao 君莫笑', 'lesson' => '写作批改,writing correction,寫作批改,国学经典,National Classics,國學經典','desc'=>'哎呀，脑壳疼，脑壳疼，脑壳疼'],
            ['id' => 5, 'email' => '1270912585@qq.com', 'name' => '李四，li si 李四', 'lesson' => '朗诵主持,Reciting Hosting,朗誦主持，演講辯論，speech debate，演讲辩论，国学经典,National Classics,國學經典','desc'=>'你知道我对你不静静是喜欢'],
        ];
         
//        $result =  $xs->addIndex($data);  //添加索引
//        $result = $xs->search('泽明');   //搜索默认索引数据库
//        $result = $xs->setSort('id',true)->setLimit(15)->search('ming');  //搜索排序,或分页
//        $result = $xs->setDatabase('student')->search('shao');  //搜索自定义索引数据库
          $result = $xs->setDatabase('student')->search('shao');  //搜索自定义索引数据库

//$newData=[....]
        //$result =  $xs->updateIndex($newData);  //更新单挑或多条索引
        //$result =  $xs->delIndex('3');  //删除单挑或多条索引
        //$result =  $xs->cleanIndex();   //清空索引

print_r($result);
          * @return array  返回数组结构
                    return [
                              'doc'           => Object,      //搜索数据结果文档
                              'hot'           => array,       //热门词汇
                              'count'         => int,         //搜索结果统计
                              'total'         => int,         //数据库总数据
                              'corrected'     => array,       //搜索提示
                              'related'       => array,       //相关搜索
                              'search_cost'   => int,         //搜索所用时间
                              'total_cost'    => int,         //页面所用时间
                          ];
                  */
         
        
         
         /*
 示例结果：
Array
(
    [doc] => Array
        (
            [0] => XSDocument Object
                (
                    [_data:XSDocument:private] => Array
                        (
                            [id] => 1
                            [email] => 928240096@qq.com
                            [name] => Shao ZeMing 邵泽明 邵澤明
                            [lesson] => 朗诵主持,Reciting Hosting,朗誦主持，
                            [desc] => 我是谁，我在哪儿，我要做什么，我不告诉你
                            [255] => 
                        )

[_terms:XSDocument:private] => 
                    [_texts:XSDocument:private] => 
                    [_charset:XSDocument:private] => UTF-8
                    [_meta:XSDocument:private] => Array
                        (
                            [docid] => 1
                            [rank] => 1
                            [ccount] => 0
                            [percent] => 100
                            [weight] => 1.1440536975861
                        )

)

[hot] => Array
        (
        )

[count] => 1
    [total] => 5
    [corrected] => Array
        (
        )

[related] => Array
        (
        )

[search_cost] => 0.00080204010009766
    [total_cost] => 0.004767894744873
)
 */

```

## License

MIT

xunsearch

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README