Repository files navigation

This package provides a unified API across a variety of different full text search services. It currently supports drivers forElasticsearch,Algolia, andZendSearch (good for local use).

Add this to you composer.json file, in the require object:

"mmanos/laravel-search":"dev-master"

After that, run composer install to install the package.

Add the service provider toapp/config/app.php, within theproviders array.

'providers' =>array(// ...'Mmanos\Search\SearchServiceProvider',)

Add a class alias toapp/config/app.php, within thealiases array.

'aliases' =>array(// ...'Search' =>'Mmanos\Search\Facade',)

Use the0.0 branch or thev0.* tags for Laravel 4 support.

Publish the default config file to your application so you can make modifications.

$php artisan vendor:publish

The following dependencies are needed for the listed search drivers:

• ZendSearch:zendframework/zendsearch
• Elasticsearch:elasticsearch/elasticsearch
• Algolia:algolia/algoliasearch-client-php

This package provides a convenient syntax for working with a "default" index. Edit thedefault_index field in the config file to change this value. If you need to work with more than one index, seeWorking With Multiple Indicies below.

Indexing is very easy with this package. Simply provide a unique identifier for the document and an associative array of fields to index.

The index will becreated automatically if it does not exist the first time you access it.

Add a document to the "default" index with anid of "1".

Search::insert(1,array('title' =>'My title','content' =>'The quick brown fox...','status' =>'published',));

Note:id may be a string or an integer. This id is used to delete records and is also returned in search results.

You may store extra parameters with a document so they can be retrieved at a later point from search results. This can be useful for referencing timestamps or other record identifiers.

Search::insert("post-1",array('title' =>'My title','content' =>'The quick brown fox...','status' =>'published',),array('created_at' =>time(),'creator_id' =>5,));

Note: Extra parameters are not indexed but are stored in the index for future retrieval.

Delete a document from the "default" index with anid of "1":

Search::delete(1);

Search::deleteIndex();

Search the "default" index for documents who'scontent field contains the word "fox":

$results = Search::search('content','fox')->get();

$results = Search::search(array('title','content'),'fox')->get();

$results = Search::search(null,'fox')->get();

Perform a fuzzy search to find results with similar, but not exact, spelling. For example, you want to return documents containing the word "updates" by searching for the word "update":

$results = Search::search('content','update',array('fuzzy'=>true))->get();

Note: You may also pass a numeric value between 0 and 1 for the fuzzy parameter, where a value closer to 1 requires a higher similarity. Defaults to 0.5.

You can apply filters to your search queries as well. Filters attempt to match the value you specify as an entire "phrase".

$results = Search::search('content','fox')->where('status','published')->get();

Note: Filters do not guarantee an exact match of the entire field value if the value contains multiple words.

Some drivers support location-aware searching:

$results = Search::search('content','fox')->whereLocation(36.16781, -96.023561,10000)->get();

Where the parameters arelatitude,longitude, anddistance (in meters).

Note: Currently, only thealgolia driver supports geo-searching. Ensure each indexed record contains the location information:_geoloc => ['lat' => 1.23, 'lng' => 1.23].

$results = Search::search('content','fox')->where('status','published')->limit(10)// Limit 10->get();$results = Search::search('content','fox')->where('status','published')->limit(10,30)// Limit 10, offset 30->get();

You can also paginate your result set using a Laravel paginator instance.

$paginator = Search::search('content','fox')->paginate(15);

$results = Search::select('id','created_at')->search('content','fox')->get();

$results = Search::select('id','created_at')->where('title','My title')->where('status','published')->search('content','fox')->search('content','quick')->limit(10)->get();

Note: Chained filters/searches are constructed as boolean queries where eachmust provide a match.

Search::search('content','fox')->delete();

If you need to work with more than one index, you may access all of the same methods mentioned above after you specify the index name.

Add a document to an index called "posts":

Search::index('posts')->insert(1,array('title' =>'My title','content' =>'The quick brown fox...','status' =>'published',));

Search the "posts" index for documents who'scontent field contains the word "fox" and who'sstatus is "published":

$results = Search::index('posts')->search('content','fox')->where('status','published')->get();

Delete a document from the "posts" index with anid of "1":

Search::index('posts')->delete(1);

Delete the entire "posts" index:

Search::index('posts')->deleteIndex();

If you need more control over a search query you may add a callback function which will be called after all conditions have been added to the query but before the query has been executed. You can then make changes to the native query instance and return it to be executed.

$results = Search::index('posts')->select('id','created_at')->search('content','fox')->addCallback(function ($query) {// Make changes to $query...return$query;})->get();

Since each driver has it's own native$query object/array, you may only want to execute your callback for one of the drivers:

$results = Search::index('posts')->select('id','created_at')->search('content','fox')->addCallback(function ($query) {// Adjust pagination for an elasticsearch query array.$query['from'] =0;$query['size'] =20;return$query;},'elasticsearch')->get();

Note: You may also pass an array of drivers as the second parameter.