laravel-scout-tntsearch-driver 正在参加 2021 年度 OSC 中国开源项目评选,请投票支持!
laravel-scout-tntsearch-driver 在 2021 年度 OSC 中国开源项目评选 中已获得 {{ projectVoteCount }} 票,请投票支持!
2021 年度 OSC 中国开源项目评选 正在火热进行中,快来投票支持你喜欢的开源项目!
2021 年度 OSC 中国开源项目评选 >>> 中场回顾
laravel-scout-tntsearch-driver 获得 2021 年度 OSC 中国开源项目评选「最佳人气项目」 !

软件简介

TNTSearch Driver for Laravel Scout - Laravel 5.3 - 8.0

Backers on Open Collective Sponsors on Open Collective Latest Version on Packagist Software License Build Status Quality Score Total Downloads

This package makes it easy to add full text search support to your models with Laravel 5.3 to 8.0.

Premium products

If you find TNT Search to be one of your valuable assets, take a look at one of our premium products

Support us on Open Collective

Contents

Installation

You can install the package via composer:

composer require teamtnt/laravel-scout-tntsearch-driver

Add the service provider:

// config/app.php
'providers' => [
    // ...
    TeamTNT\Scout\TNTSearchScoutServiceProvider::class,
],

Ensure you have Laravel Scout as a provider too otherwise you will get an "unresolvable dependency" error

// config/app.php
'providers' => [
    // ...
    Laravel\Scout\ScoutServiceProvider::class,
],

Add SCOUT_DRIVER=tntsearch to your .env file

Then you should publish scout.php configuration file to your config directory

php artisan vendor:publish --provider="Laravel\Scout\ScoutServiceProvider"

In your config/scout.php add:

'tntsearch' => [
    'storage'  => storage_path(), //place where the index files will be stored
    'fuzziness' => env('TNTSEARCH_FUZZINESS', false),
    'fuzzy' => [
        'prefix_length' => 2,
        'max_expansions' => 50,
        'distance' => 2
    ],
    'asYouType' => false,
    'searchBoolean' => env('TNTSEARCH_BOOLEAN', false),
    'maxDocs' => env('TNTSEARCH_MAX_DOCS', 500),
],

To prevent your search indexes being commited to your project repository, add the following line to your .gitignore file.

/storage/*.index

The asYouType option can be set per model basis, see the example below.

Usage

After you have installed scout and the TNTSearch driver, you need to add the Searchable trait to your models that you want to make searchable. Additionaly, define the fields you want to make searchable by defining the toSearchableArray method on the model:

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;
use Laravel\Scout\Searchable;

class Post extends Model
{
    use Searchable;

    public $asYouType = true;

    /**
     * Get the indexable data array for the model.
     *
     * @return array
     */
    public function toSearchableArray()
    {
        $array = $this->toArray();

        // Customize array...

        return $array;
    }
}

Then, sync the data with the search service like:

php artisan scout:import App\\Post

If you have a lot of records and want to speed it up you can run (note that with this you can no longer use model-relations in your toSearchableArray()):

php artisan tntsearch:import App\\Post

After that you can search your models with:

Post::search('Bugs Bunny')->get();

Scout status

php artisan scout:status

With this simple command you'll get a quick overview of your search indices.

Image of Scout Status Command

Or you can pass a searchable model argument:

php artisan scout:status "App\Models\Post"

Image of Scout Status Command

Constraints

Additionally to where() statements as conditions, you're able to use Eloquent queries to constrain your search. This allows you to take relationships into account.

If you make use of this, the search command has to be called after all queries have been defined in your controller.

The where() statements you already know can be applied everywhere.

namespace App\Http\Controllers;

use App\Post;

class PostController extends Controller
{
    /**
     * Display a listing of the resource.
     *
     * @return \Illuminate\Http\Response
     */
    public function index(Request $request)
    {
        $post = new Post;

        // filter out posts to which the given topic is assigned
        if($request->topic) {
            $post = $post->whereNotIn('id', function($query){
                $query->select('assigned_to')->from('comments')->where('topic','=', request()->input('topic'));
            });
        }

        // only posts from people that are no moderators
        $post = $post->byRole('moderator','!=');

        // when user is not admin filter out internal posts
        if(!auth()->user()->hasRole('admin'))
        {
            $post= $post->where('internal_post', false);
        }

        if ($request->searchTerm) {
            $constraints = $post; // not necessary but for better readability
            $post = Post::search($request->searchTerm)->constrain($constraints);
        }

        $post->where('deleted', false);

        $post->orderBy('updated_at', 'asc');

        $paginator = $post->paginate(10);
        $posts = $paginator->getCollection();

        // return posts
    }
}

Adding via Query

The searchable() method will chunk the results of the query and add the records to your search index.

$post = Post::find(1);

// You may also add record via collection...
$post->searchable();

// OR

$posts = Post::where('year', '>', '2018')->get();

// You may also add records via collections...
$posts->searchable();

When using constraints apply it after the constraints are added to the query, as seen in the above example.

OrderBy

An orderBy() statement can now be applied to the search query similar to the where() statement.

When using constraints apply it after the constraints are added to the query, as seen in the above example.

Sponsors

Become a sponsor and get your logo on our README on Github with a link to your site. [Become a sponsor]

Credits

Contributors

This project exists thanks to all the people who contribute.

Backers

Thank you to all our backers! 🙏 [Become a backer]

展开阅读全文

代码

评论 (0)

加载中
更多评论
暂无内容
发表了博客
2018/11/12 16:49

Elasticsearchs的安装/laravel-scout和laravel-scout-elastic的安装

安装: https://github.com/medcl/elasticsearch-rtf 先下载包 下载解压后 cd elasticsearch-rtf-master ll bin/elasticsearch-plugin list 这里会显示所有的插件 过滤插件 bin/elasticsearch-plugin list > /tmp/plugin.log vim /tmp/plugin.log 在这里面把我们需要的analysis-ik这个插件去掉 cat /tmp/plugin.log|xargs -I {} bin/elasticsearch-plugin remove {} //删除 bin/elasticsearch-plugin list //查看 bin/elasticsea...

0
0
发表了博客
2018/05/13 00:16

laravel 的 scout elasticsearch ik laravel-scout-elastic 之间的关系与安装

一 简介 laravel 的组件化使 laravel 的使用更加得心应手。 Laravel Scout 为 Eloquent 模型 全文搜索提供了简单的,基于驱动的解决方案。通过使用模型观察者,Scout 会自动同步 Eloquent 记录的搜索索引。 简单的来说 Scout 是用来全文检索的一个组件(不具有搜索功能),它使用驱动来调用搜索引擎来进行搜索。这里讲解 laravel 使用 elasticsearch 搜索引擎。 在已有的项目中要想使用 elsaticsearch 搜索引擎,需要四个步骤: ...

0
0
2019/01/24 15:54

Amazon展开送货机器人Scout测试上路

Amazon最近宣布在华盛顿州的Snohomish County地区测试送货机器人Scout,目前在该地区部署了6台送货机器人,该送货机器人是全电动的送货系统,测试时间为周一到周五的白天时段,Amazon将送货机器人Scout设计为尺寸较小的送货设备,能够以步行的速度行驶在人行道上,用户按照平常购买的流程订购商品后,商品将会随机由送货人员或是送货机器人Scout,送至客户家中。送货机器人Scout是在西雅图的实验室研究和开发,目前送货机器人S...

0
0
发表了博客
2018/11/16 10:07

laravel中关联模型并使用scout导入数据 +视图合成器

首先在PostModel中引入 use Laravel\Scout\Searchable; 并在类中进行定义 class Post extends Model { use Searchable; /* * 定义索引里面的type */ public function searchableAs() { return 'post'; } /* * 定义有哪些字段需要搜索 */ public function toSearchableArray() { return [ 'title'=>$this->title, ...

0
0
2019/02/13 20:27

3、Laravel5 之搜索引擎elasticsearch扩展Scout

此篇文章来源于网络,和其他laravel使用es的教程一致,自己在某些地方做了备注而已。 一、安装Scout (1)首先,使用 composer 包管理器来安装 Scout,如果没有安装 composer 包管理器,要先安装;接着进入laravel项目的根目录使用composer 命令安装 composer require laravel/scout (2)接下来,你需要将 ScoutServiceProvider 添加到你的 config/app.php 配置文件的 providers 数组中: Laravel\Scout\ScoutServiceProvider...

0
0
没有更多内容
加载失败,请刷新页面
点击加载更多
加载中
下一页
暂无内容
0 评论
0 收藏
分享
OSCHINA
登录后可查看更多优质内容
返回顶部
顶部