Laravel Scout

1composer require laravel/scout

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

 1<?php
 2 
 3namespace App\Models;
 4 
 5use Illuminate\Database\Eloquent\Model;
 6use Laravel\Scout\Searchable;
 7 
 8class Post extends Model
 9{
10    use Searchable;
11}

1'queue' => true,

1'queue' => [
2    'connection' => 'redis',
3    'queue' => 'scout'
4],

1php artisan queue:work redis --queue=scout

1composer require algolia/algoliasearch-client-php

1composer require meilisearch/meilisearch-php http-interop/http-factory-guzzle

1SCOUT_DRIVER=meilisearch
2MEILISEARCH_HOST=http://127.0.0.1:7700
3MEILISEARCH_KEY=masterKey

1composer require typesense/typesense-php

1SCOUT_DRIVER=typesense
2TYPESENSE_API_KEY=masterKey
3TYPESENSE_HOST=localhost

1TYPESENSE_PORT=8108
2TYPESENSE_PATH=
3TYPESENSE_PROTOCOL=http

 1/**
 2 * Get the indexable data array for the model.
 3 *
 4 * @return array<string, mixed>
 5 */
 6public function toSearchableArray()
 7{
 8    return array_merge($this->toArray(),[
 9        'id' => (string) $this->id,
10        'created_at' => $this->created_at->timestamp,
11    ]);
12}

 1User::class => [
 2    'collection-schema' => [
 3        'fields' => [
 4            // ...
 5            [
 6                'name' => '__soft_deleted',
 7                'type' => 'int32',
 8                'optional' => true,
 9            ],
10        ],
11    ],
12],

1use App\Models\Todo;
2 
3Todo::search('Groceries')->options([
4    'query_by' => 'title, description'
5])->get();

 1<?php
 2 
 3namespace App\Models;
 4 
 5use Illuminate\Database\Eloquent\Model;
 6use Laravel\Scout\Searchable;
 7 
 8class Post extends Model
 9{
10    use Searchable;
11 
12    /**
13     * Get the name of the index associated with the model.
14     */
15    public function searchableAs(): string
16    {
17        return 'posts_index';
18    }
19}

 1<?php
 2 
 3namespace App\Models;
 4 
 5use Illuminate\Database\Eloquent\Model;
 6use Laravel\Scout\Searchable;
 7 
 8class Post extends Model
 9{
10    use Searchable;
11 
12    /**
13     * Get the indexable data array for the model.
14     *
15     * @return array<string, mixed>
16     */
17    public function toSearchableArray(): array
18    {
19        $array = $this->toArray();
20 
21        // Customize the data array...
22 
23        return $array;
24    }
25}

1public function toSearchableArray()
2{
3    return [
4        'id' => (int) $this->id,
5        'name' => $this->name,
6        'price' => (float) $this->price,
7    ];
8}

 1use App\Models\User;
 2use App\Models\Flight;
 3 
 4'algolia' => [
 5    'id' => env('ALGOLIA_APP_ID', ''),
 6    'secret' => env('ALGOLIA_SECRET', ''),
 7    'index-settings' => [
 8        User::class => [
 9            'searchableAttributes' => ['id', 'name', 'email'],
10            'attributesForFaceting'=> ['filterOnly(email)'],
11            // Other settings fields...
12        ],
13        Flight::class => [
14            'searchableAttributes'=> ['id', 'destination'],
15        ],
16    ],
17],

1'index-settings' => [
2    Flight::class => []
3],

1php artisan scout:sync-index-settings

 1use App\Models\User;
 2use App\Models\Flight;
 3 
 4'meilisearch' => [
 5    'host' => env('MEILISEARCH_HOST', 'https://127.0.0.1:7700'),
 6    'key' => env('MEILISEARCH_KEY', null),
 7    'index-settings' => [
 8        User::class => [
 9            'filterableAttributes'=> ['id', 'name', 'email'],
10            'sortableAttributes' => ['created_at'],
11            // Other settings fields...
12        ],
13        Flight::class => [
14            'filterableAttributes'=> ['id', 'destination'],
15            'sortableAttributes' => ['updated_at'],
16        ],
17    ],
18],

1'index-settings' => [
2    Flight::class => []
3],

1php artisan scout:sync-index-settings

 1<?php
 2 
 3namespace App\Models;
 4 
 5use Illuminate\Database\Eloquent\Model;
 6use Laravel\Scout\Searchable;
 7 
 8class User extends Model
 9{
10    use Searchable;
11 
12    /**
13     * Get the value used to index the model.
14     */
15    public function getScoutKey(): mixed
16    {
17        return $this->email;
18    }
19 
20    /**
21     * Get the key name used to index the model.
22     */
23    public function getScoutKeyName(): mixed
24    {
25        return 'email';
26    }
27}

 1<?php
 2 
 3namespace App\Models;
 4 
 5use Illuminate\Database\Eloquent\Model;
 6use Laravel\Scout\Engines\Engine;
 7use Laravel\Scout\EngineManager;
 8use Laravel\Scout\Searchable;
 9 
10class User extends Model
11{
12    use Searchable;
13 
14    /**
15     * Get the engine used to index the model.
16     */
17    public function searchableUsing(): Engine
18    {
19        return app(EngineManager::class)->engine('meilisearch');
20    }
21}

1SCOUT_IDENTIFY=true

1SCOUT_DRIVER=database

 1use Laravel\Scout\Attributes\SearchUsingFullText;
 2use Laravel\Scout\Attributes\SearchUsingPrefix;
 3 
 4/**
 5 * Get the indexable data array for the model.
 6 *
 7 * @return array<string, mixed>
 8 */
 9#[SearchUsingPrefix(['id', 'email'])]
10#[SearchUsingFullText(['bio'])]
11public function toSearchableArray(): array
12{
13    return [
14        'id' => $this->id,
15        'name' => $this->name,
16        'email' => $this->email,
17        'bio' => $this->bio,
18    ];
19}

1SCOUT_DRIVER=collection

1php artisan scout:import "App\Models\Post"

1php artisan scout:flush "App\Models\Post"

1use Illuminate\Database\Eloquent\Builder;
2 
3/**
4 * Modify the query used to retrieve models when making all of the models searchable.
5 */
6protected function makeAllSearchableUsing(Builder $query): Builder
7{
8    return $query->with('author');
9}

1use App\Models\Order;
2 
3$order = new Order;
4 
5// ...
6 
7$order->save();

1use App\Models\Order;
2 
3Order::where('price', '>', 100)->searchable();

1$user->orders()->searchable();

1$orders->searchable();

1use App\Models\Order;
2 
3$order = Order::find(1);
4 
5// Update the order...
6 
7$order->save();

1Order::where('price', '>', 100)->searchable();

1$user->orders()->searchable();

1$orders->searchable();

1use Illuminate\Database\Eloquent\Collection;
2 
3/**
4 * Modify the collection of models being made searchable.
5 */
6public function makeSearchableUsing(Collection $models): Collection
7{
8    return $models->load('author');
9}

1use App\Models\Order;
2 
3$order = Order::find(1);
4 
5$order->delete();

1Order::where('price', '>', 100)->unsearchable();

1$user->orders()->unsearchable();

1$orders->unsearchable();

1Order::removeAllFromSearch();

1use App\Models\Order;
2 
3Order::withoutSyncingToSearch(function () {
4    // Perform model actions...
5});

1/**
2 * Determine if the model should be searchable.
3 */
4public function shouldBeSearchable(): bool
5{
6    return $this->isPublished();
7}

1use App\Models\Order;
2 
3$orders = Order::search('Star Trek')->get();

1use App\Models\Order;
2use Illuminate\Http\Request;
3 
4Route::get('/search', function (Request $request) {
5    return Order::search($request->search)->get();
6});

1$orders = Order::search('Star Trek')->raw();

1$orders = Order::search('Star Trek')
2    ->within('tv_shows_popularity_desc')
3    ->get();

1use App\Models\Order;
2 
3$orders = Order::search('Star Trek')->where('user_id', 1)->get();

1$orders = Order::search('Star Trek')->whereIn(
2    'status', ['open', 'paid']
3)->get();

1$orders = Order::search('Star Trek')->whereNotIn(
2    'status', ['closed']
3)->get();

1use App\Models\Order;
2 
3$orders = Order::search('Star Trek')->paginate();

1$orders = Order::search('Star Trek')->paginate(15);

1<div class="container">
2    @foreach ($orders as $order)
3        {{ $order->price }}
4    @endforeach
5</div>
6 
7{{ $orders->links() }}

1use App\Models\Order;
2use Illuminate\Http\Request;
3 
4Route::get('/orders', function (Request $request) {
5    return Order::search($request->input('query'))->paginate(15);
6});

1'soft_delete' => true,

1use App\Models\Order;
2 
3// Include trashed records when retrieving results...
4$orders = Order::search('Star Trek')->withTrashed()->get();
5 
6// Only include trashed records when retrieving results...
7$orders = Order::search('Star Trek')->onlyTrashed()->get();

 1use Algolia\AlgoliaSearch\SearchIndex;
 2use App\Models\Order;
 3 
 4Order::search(
 5    'Star Trek',
 6    function (SearchIndex $algolia, string $query, array $options) {
 7        $options['body']['query']['bool']['filter']['geo_distance'] = [
 8            'distance' => '1000km',
 9            'location' => ['lat' => 36, 'lon' => 111],
10        ];
11 
12        return $algolia->search($query, $options);
13    }
14)->get();

1use App\Models\Order;
2use Illuminate\Database\Eloquent\Builder;
3 
4$orders = Order::search('Star Trek')
5    ->query(fn (Builder $query) => $query->with('invoices'))
6    ->get();

 1use Laravel\Scout\Builder;
 2 
 3abstract public function update($models);
 4abstract public function delete($models);
 5abstract public function search(Builder $builder);
 6abstract public function paginate(Builder $builder, $perPage, $page);
 7abstract public function mapIds($results);
 8abstract public function map(Builder $builder, $results, $model);
 9abstract public function getTotalCount($results);
10abstract public function flush($model);

 1use App\ScoutExtensions\MySqlSearchEngine;
 2use Laravel\Scout\EngineManager;
 3 
 4/**
 5 * Bootstrap any application services.
 6 */
 7public function boot(): void
 8{
 9    resolve(EngineManager::class)->extend('mysql', function () {
10        return new MySqlSearchEngine;
11    });
12}

1'driver' => 'mysql',