Download the PHP package devloopsnet/laravel-typesense without Composer

⚠️ This project has moved to the official Typesense Github org: https://github.com/typesense/laravel-scout-typesense-driver. It was adopted as the official Typesense PHP client on Dec 2021 and ongoing development will take place there.

Please upgrade to the `typesense/laravel-scout-typesense-driver` composer package to receive new updates.

The rest of this Readme file is kept as is for posterity.

[](https://packagist.org/packages/devloopsnet/laravel-typesense)  [](https://app.codacy.com/gh/devloopsnet/laravel-scout-typesense-engine?utm_source=github.com&utm_medium=referral&utm_content=devloopsnet/laravel-scout-typesense-engine&utm_campaign=Badge_Grade_Settings) [](https://packagist.org/packages/devloopsnet/laravel-typesense) [](https://packagist.org/packages/devloopsnet/laravel-typesense) [](https://github.styleci.io/repos/253329257?branch=master)

Laravel Scout Typesense Engine

Typesense engine for laravel/scout https://github.com/typesense/typesense .

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

Contents

• Installation
• Usage
• Author
• License

Installation

You can install the package via composer:

Add the service provider:

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

Add SCOUT_DRIVER=typesense to your .env file

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

In your config/scout.php add:

Usage

After you have installed scout and the Typesense 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 and implement TypesenseSearch:

Then, sync the data with the search service like:

php artisan scout:import App\\Post

After that you can search your models with:

Or

Then you can apply your where(s) to the builder as follows :

*Note : For geolocation search, make sure to send an empty operator as follows

Extended/Added methods to Scout Builder

Check Typesense Search for reference.

• Group by

• Order

• Location Order

• Group by limit

• Highlight start tag

• Highlight end tag

• Hits limit

Adding via Query

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

You may also add record via collection...

---- OR

You may also add records via collections...

Author

• Abdullah Al-Faqeir
• Contributors

License

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