How to install laravel search package with Composer?

Add 'mmanos/laravel-search': 'dev-master' to your composer.json require object, run composer install, then register the service provider and facade in app/config/app.php, as detailed in the Installation section. This sets up the package for Laravel 5.

Laravel search vs Scout: which is better?

Laravel Search offers a unified API for multiple drivers (Elasticsearch, Algolia, ZendSearch) with fine-grained control, while Laravel Scout is more integrated but primarily focuses on Algolia and Elasticsearch with simpler setup. Choose Laravel Search for flexibility across engines; Scout for tighter Laravel ecosystem integration.

Can I use geo-search with Elasticsearch in laravel search?

No, geo-search is currently only supported by the Algolia driver, as stated in the README under Geo-Search note. You must use Algolia and include _geoloc data in indexed records for location-aware queries.

How to paginate search results in laravel search?

Use the paginate() method on a query, like Search::search('content', 'fox')->paginate(15), which returns a Laravel paginator instance. This integrates seamlessly with Laravel's pagination features for easy result display.

Is laravel search compatible with Laravel 8?

The README only mentions Laravel 5 support, with Laravel 4 on a separate branch, so compatibility with Laravel 8 is not guaranteed. You may need to check for community updates or forks, as the package might require modifications for newer Laravel versions.

How to switch search drivers in laravel search?

Change the driver in the published config file after running php artisan vendor:publish. The package abstracts the API, so your code remains the same, but you must install the corresponding driver dependencies (e.g., Algolia client) for the new backend.

Laravel Search — Unified Full-Text Search Package

What is Laravel Search?

Laravel Search is a PHP package for Laravel 5 that provides a unified API to interact with multiple full-text search services. It abstracts differences between Elasticsearch, Algolia, and ZendSearch, allowing developers to index, search, and filter data using a consistent, fluent syntax. This solves the problem of vendor lock-in and simplifies switching between search backends.

Target Audience

Laravel developers building applications that require full-text search capabilities, especially those who need flexibility to use different search engines (cloud-based like Algolia or self-hosted like Elasticsearch) without rewriting search logic.

Value Proposition

Developers choose Laravel Search because it offers a single, elegant API for multiple search drivers, reducing boilerplate code and making search implementations more maintainable. Its Laravel-native syntax and features like pagination, geo-search, and query callbacks integrate seamlessly into existing workflows.

A search package for Laravel 5.

Use Cases

Best For

Adding search functionality to Laravel applications without committing to a single search provider
Switching between Elasticsearch and Algolia in a Laravel project with minimal code changes
Implementing local search during development using ZendSearch
Building location-aware search features with geo-queries
Creating complex search interfaces with filters, pagination, and field selection
Abstracting search engine differences in multi-tenant or multi-service architectures

Not Ideal For

Projects solely using MySQL or PostgreSQL full-text search without needing external engines
Teams heavily reliant on one search engine's proprietary features (e.g., Algolia's InstantSearch UI)
Applications requiring real-time data sync or complex analytics best handled by native Elasticsearch APIs
Laravel 6+ projects seeking out-of-the-box compatibility, as support focuses on Laravel 5

Pros & Cons

Pros

Unified Search API

Offers a consistent, Laravel-style syntax for indexing, searching, and filtering across Elasticsearch, Algolia, and ZendSearch, as shown in the README with methods like Search::insert() and Search::search().

Fluent Query Builder

Enables chainable methods for building complex searches with filters, limits, and pagination, similar to Laravel's Eloquent, as demonstrated in examples like Search::search('content', 'fox')->where('status', 'published')->get().

Geo-Search Support

Provides location-aware searching via methods like whereLocation(), though limited to the Algolia driver, allowing geo-queries with latitude, longitude, and distance parameters.

Flexible Index Management

Supports multiple indices and automatic index creation, as shown in the 'Working With Multiple Indicies' section, where you can use Search::index('posts') to manage separate data types.

Cons

Driver-Specific Limitations

Key features like geo-search only work with Algolia, and advanced customization via callbacks requires handling native driver objects, reducing the abstraction's consistency and portability.

Dependency Complexity

Requires installing separate PHP packages for each driver (e.g., elasticsearch/elasticsearch for Elasticsearch), adding setup overhead and potential version conflicts, as noted in the 'Dependencies' section.

Outdated Laravel Support

Primarily targets Laravel 5, with Laravel 4 on a legacy branch, and lacks explicit support for newer Laravel versions, which could lead to compatibility issues in modern applications.

What is Laravel Search?

Target Audience

Value Proposition

Use Cases

Best For

Adding search functionality to Laravel applications without committing to a single search provider
Switching between Elasticsearch and Algolia in a Laravel project with minimal code changes
Implementing local search during development using ZendSearch
Building location-aware search features with geo-queries
Creating complex search interfaces with filters, pagination, and field selection
Abstracting search engine differences in multi-tenant or multi-service architectures

Not Ideal For

Projects solely using MySQL or PostgreSQL full-text search without needing external engines
Teams heavily reliant on one search engine's proprietary features (e.g., Algolia's InstantSearch UI)
Applications requiring real-time data sync or complex analytics best handled by native Elasticsearch APIs
Laravel 6+ projects seeking out-of-the-box compatibility, as support focuses on Laravel 5

Pros & Cons

Pros

Unified Search API

Fluent Query Builder

Geo-Search Support

Provides location-aware searching via methods like whereLocation(), though limited to the Algolia driver, allowing geo-queries with latitude, longitude, and distance parameters.

Flexible Index Management

Supports multiple indices and automatic index creation, as shown in the 'Working With Multiple Indicies' section, where you can use Search::index('posts') to manage separate data types.

Cons

Driver-Specific Limitations

Key features like geo-search only work with Algolia, and advanced customization via callbacks requires handling native driver objects, reducing the abstraction's consistency and portability.

Dependency Complexity

Outdated Laravel Support

Primarily targets Laravel 5, with Laravel 4 on a legacy branch, and lacks explicit support for newer Laravel versions, which could lead to compatibility issues in modern applications.

Laravel Search

What is Laravel Search?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?

Laravel Search

What is Laravel Search?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?