Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/spatie/laravel-searchable

Pragmatically search through models and other sources
https://github.com/spatie/laravel-searchable

laravel php search

Last synced: about 2 months ago
JSON representation

Pragmatically search through models and other sources

Host: GitHub
URL: https://github.com/spatie/laravel-searchable
Owner: spatie
License: mit
Created: 2018-12-06T10:55:46.000Z (almost 6 years ago)
Default Branch: main
Last Pushed: 2024-03-13T23:23:45.000Z (6 months ago)
Last Synced: 2024-06-18T10:56:57.221Z (3 months ago)
Topics: laravel, php, search
Language: PHP
Homepage: https://spatie.be/open-source
Size: 145 KB
Stars: 1,310
Watchers: 22
Forks: 113
Open Issues: 1
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md

Awesome Lists containing this project

favorite-link - 务实地搜索模型和其他来源。

README

        # Laravel Searchable

[![Latest Version on Packagist](https://img.shields.io/packagist/v/spatie/laravel-searchable.svg?style=flat-square)](https://packagist.org/packages/spatie/laravel-searchable)

[![run-tests](https://github.com/spatie/laravel-searchable/actions/workflows/run-tests.yml/badge.svg)](https://github.com/spatie/laravel-searchable/actions/workflows/run-tests.yml)

[![Total Downloads](https://img.shields.io/packagist/dt/spatie/laravel-searchable.svg?style=flat-square)](https://packagist.org/packages/spatie/laravel-searchable)

This package makes it easy to get structured search from a variety of sources. Here's an example where we search through some models. We already did some small preparation on the models themselves.

```php

$searchResults = (new Search())

   ->registerModel(User::class, 'name')

   ->registerModel(BlogPost::class, 'title')

   ->search('john');

```

The search will be performed case insensitive. `$searchResults` now contains all `User` models that contain `john` in the `name` attribute and `BlogPost`s that contain 'john' in the `title` attribute.

In your view you can now loop over the search results:

```blade

Search


There are {{ $searchResults->count() }} results.

@foreach($searchResults->groupByType() as $type => $modelSearchResults)

   
{{ $type }}

   

   @foreach($modelSearchResults as $searchResult)

       

            {{ $searchResult->title }}

       

   @endforeach

@endforeach

```

In this example we used models, but you can easily add a search aspect for an external API, list of files or an array of values.

## Support us

[](https://spatie.be/github-ad-click/laravel-searchable)

We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).

We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on [our contact page](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).

## Installation

You can install the package via composer:

```bash

composer require spatie/laravel-searchable

```

## Usage

### Preparing your models

In order to search through models you'll have to let them implement the `Searchable` interface.

```php

namespace Spatie\Searchable;

interface Searchable

{

    public function getSearchResult(): SearchResult;

}

```

You'll only need to add a `getSearchResult` method to each searchable model that must return an instance of `SearchResult`. Here's how it could look like for a blog post model.

```php

use Spatie\Searchable\Searchable;

use Spatie\Searchable\SearchResult;

class BlogPost extends Model implements Searchable

{

     public function getSearchResult(): SearchResult

     {

        $url = route('blogPost.show', $this->slug);

     

         return new \Spatie\Searchable\SearchResult(

            $this,

            $this->title,

            $url

         );

     }

}

```

### Searching models

With the models prepared you can search them like this:

```php

$searchResults = (new Search())

   ->registerModel(User::class, 'name')

   ->search('john');

```

The search will be performed case insensitive. `$searchResults` now contains all `User` models that contain `john` in the `name` attribute.

You can also pass multiple attributes to search through:

```php

// use multiple model attributes

$searchResults = (new Search())

   ->registerModel(User::class, 'first_name', 'last_name')

   ->search('john');

   

// or use an array of model attributes

$searchResults = (new Search())

   ->registerModel(User::class, ['first_name', 'last_name'])

   ->search('john');

```

To get fine grained control you can also use a callable. This way you can also search for exact matches, apply scopes, eager load relationships, or even filter your query like you would using the query builder.

```php

$search = (new Search())

   ->registerModel(User::class, function(ModelSearchAspect $modelSearchAspect) {

       $modelSearchAspect

          ->addSearchableAttribute('name') // return results for partial matches on usernames

          ->addExactSearchableAttribute('email') // only return results that exactly match the e-mail address

          ->active()

          ->has('posts')

          ->with('roles');

});

```

### Creating custom search aspects

You are not limited to only registering basic models as search aspects. You can easily create your own, custom search aspects by extending the `SearchAspect` class.

Consider the following custom search aspect to search an external API:

```php

class OrderSearchAspect extends SearchAspect

{

    public function getResults(string $term): Collection

    {

        return OrderApi::searchOrders($term);

    }

}

```

This is how you can use it:

```php

$searchResults = (new Search())

   ->registerAspect(OrderSearchAspect::class)

   ->search('john');

```

### Limiting aspect results

It is possible to limit the amount of results returned by each aspect by calling `limitAspectResults` prior to performing the search.

```php

$searchResults = (new Search())

    ->registerAspect(BlogPostAspect::class)

    ->limitAspectResults(50)

    ->search('How To');

```

### Rendering search results

Here's an example on rendering search results:

```blade

Search


There are {{ $searchResults->count() }} results.

@foreach($searchResults->groupByType() as $type => $modelSearchResults)

   
{{ $type }}

   

   @foreach($modelSearchResults as $searchResult)

       

            {{ $searchResult->title }}

       

   @endforeach

@endforeach

```

You can customize the `$type` by adding a public property `$searchableType` on your model or custom search aspect

```php

class BlogPost extends Model implements Searchable

{

    public $searchableType = 'custom named aspect';

}

```

### Testing

```bash

composer test

```

### Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

## Contributing

Please see [CONTRIBUTING](https://github.com/spatie/.github/blob/main/CONTRIBUTING.md) for details.

### Security

If you've found a bug regarding security please mail [[email protected]](mailto:[email protected]) instead of using the issue tracker.

## Credits

- [Alex Vanderbist](https://github.com/AlexVanderbist)

- [Freek Van der Herten](https://github.com/freekmurze)

- [All Contributors](../../contributors)

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.