TNTSearch Driver for Laravel Scout - Laravel 5.3

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

Contents

• Installation
• Usage
• Contributing
• Credits
• License

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,
],

Add SCOUT_DRIVER=tntsearch to your .env file

In your config/scout.php add:

'tntsearch' => [
    'storage'  => storage_path(), //place where the index files will be stored
],

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 setting the searchable member variable.

<?php

namespace App;

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

class Post extends Model
{
    use Searchable;
    
    //fields you want to make searchable
    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

After that you can search your models with:

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

Contributing

Please see CONTRIBUTING for details.

Credits

• Nenad Ticaric
• Sasa Tokic
• All Contributors

License

The MIT License (MIT). Please see License File for more information.