Skip to content

All topics  /  Laravel

How to Add Full Text Search Using Scout in Laravel 10?

Laravel ·

Teams applying “How to Add Full Text Search Using Scout in Laravel 10?” in a production project can use this reference page to record implementation, review and debugging time, then compare that effort with tests and shipped functionality instead of treating activity as performance by itself.

Before copying the example into a live application, confirm version-specific behaviour with the official Laravel website and test it against the project’s actual database and runtime.

How to Add Full Text Search Using Scout in Laravel 10?

Hi dev,

I'll show you an example of a full-text search with Laravel 10 today. Laravel 10 Scout Search Example is what you will learn. You'll discover a Laravel 10 Scout Example. You've come to the right place if you're looking for a demonstration of how to integrate full text search to Laravel 10 Scout.

Laravel 10 provides Scout Package for full text search from your project. If you require to add full text search function in your laravel 10 application then you have to choose the scout package to do.

Using the database driver for full text search, we will install the scout composer package in this example. A name, email, and id column will then be added to Scout's User model for full-text search. Let's look at the steps below to construct a full-text search feature.

Step 1: Install Laravel 10


This is optional; however, if you have not created the laravel app, then you may go ahead and execute the below command:

composer create-project laravel/laravel example-app

Step 2: Install Scout

In this step we have to install scout package and we will publish them:

composer require laravel/scout

Next, we have to publish our configuration file. so you need to run bellow command:

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

Now we need to set configuration database as driver in your env file:

.env 

SCOUT_DRIVER=database

Step 3: Update User Model

Here, we already have users table created, so we need use "Searchable" and create toSearchableArray() method. so let's update following code:

app/Models/User.php 

<?php

  
namespace App\Models;

    
use Illuminate\Contracts\Auth\MustVerifyEmail;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Foundation\Auth\User as Authenticatable;
use Illuminate\Notifications\Notifiable;
use Laravel\Sanctum\HasApiTokens;
use Laravel\Scout\Searchable;

   
class User extends Authenticatable
{
    use HasApiTokens, HasFactory, Notifiable, Searchable;

  
    /**
     * The attributes that are mass assignable.
     *
     * @var array
     */
    protected $fillable = [
        'name',
        'email',
        'password'
    ];

  
    /**
     * The attributes that should be hidden for serialization.
     *
     * @var array
     */
    protected $hidden = [
        'password',
        'remember_token',
    ];

  
    /**
     * The attributes that should be cast.
     *
     * @var array
     */
    protected $casts = [
        'email_verified_at' => 'datetime',
    ];

  
    /**
     * Get the indexable data array for the model.
     *
     * @return array
     */
    public function toSearchableArray()
    {
        return [
            'name' => $this->name,
            'email' => $this->email
        ];
    }
}

Next, we will create some dummy records on users table and import it.

so let's run following commands:

Create Dummy Records: 

php artisan tinker

  
User::factory()->count(20)->create()

Import Records: 

php artisan scout:import "App\Models\User"

Step 4: Create UserController Controller

In this point, now we should create a new controller as UserController. In this controller, we will add index method, that will return users with filter.

Let's update following code to your controller file:

app/Http/Controllers/UserController.php 

<?php

  
namespace App\Http\Controllers;

  
use Illuminate\Http\Request;
use App\Models\User;
use Illuminate\View\View;

  
class UserController extends Controller
{
    /**
     * Display a listing of the resource.
     *
     * @return \Illuminate\Http\Response
     */
    public function index(Request $request): View
    {
        if($request->filled('search')){
            $users = User::search($request->search)->get();
        }else{
            $users = User::get();
        }

          
        return view('users', compact('users'));
    }
}

Step 5: Add Route

In this is step we need to create route for listing users. so open your "routes/web.php" file and add following route.

routes/web.php 

<?php

  
use Illuminate\Support\Facades\Route;

  
use App\Http\Controllers\UserController;

  
/*
|--------------------------------------------------------------------------
| Web Routes
|--------------------------------------------------------------------------
|
| Here is where you can register web routes for your application. These
| routes are loaded by the RouteServiceProvider within a group which
| contains the "web" middleware group. Now create something great!
|
*/

  
Route::get('users', [UserController::class, 'index']);

Step 6: Create View

In Last step, let's create users.blade.php(resources/views/users.blade.php) for layout and we will write design code here and put following code:

resources/views/users.blade.php 

<!DOCTYPE html>
<html>
<head>
    <title>Laravel 10 Scout Full Text Search Tutorial</title>
    <link href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/5.0.1/css/bootstrap.min.css" rel="stylesheet">
</head>
<body>

      
<div class="container">
    <h1>Laravel 10 Scout Full Text Search Tutorial</h1>

  
    <form method="GET">
        <div class="input-group mb-3">
          <input 
            type="text" 
            name="search" 
            value="{{ request()->get('search') }}" 
            class="form-control" 
            placeholder="Search..." 
            aria-label="Search" 
            aria-describedby="button-addon2">
          <button class="btn btn-success" type="submit" id="button-addon2">Search</button>
        </div>
    </form>

  
    <table class="table table-bordered data-table">
        <thead>
            <tr>
                <th>ID</th>
                <th>Name</th>
                <th>Email</th>
            </tr>
        </thead>
        <tbody>
            @foreach($users as $user)
            <tr>
                <td>{{ $user->id }}</td>
                <td>{{ $user->name }}</td>
                <td>{{ $user->email }}</td>
            </tr>
            @endforeach
        </tbody>
    </table>
</div>

    
</body>

    
</html>

Run Laravel App:

All the required steps have been done, now you have to type the given below command and hit enter to run the Laravel app:

php artisan serve

Now, Go to your web browser, type the given URL and view the app output:

http://localhost:8000/users

More on this topic