Skip to content

Laravel 4.2, 5.0, 5.1 package for full-text search over Eloquent models based on ZF2 Lucene.

Notifications You must be signed in to change notification settings

eldair/laravel-lucene-search

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Laravel 5.1 Lucene search

Latest Stable Version Latest Unstable Version License Build Status Coverage Status

Laravel 5.1 package for full-text search over Eloquent models based on ZendSearch Lucene.

Installation

Require this package in your composer.json and run composer update:

{
	"require": {
        "nqxcode/laravel-lucene-search": "2.1.*"
	}
}

After updating composer, add the ServiceProvider to the providers array in app/config/app.php

'providers' => [
	Nqxcode\LuceneSearch\ServiceProvider::class,
],

If you want to use the facade to search, add this to your facades in app/config/app.php:

'aliases' => [
	'Search' => Nqxcode\LuceneSearch\Facade::class,
],

Configuration

Publish the config file into your project by running:

php artisan vendor:publish --provider="Nqxcode\LuceneSearch\ServiceProvider"

In published config file add descriptions for models which need to be indexed, for example:

'index' => [
	
	// ...

	namespace\FirstModel::class => [
		'fields' => [
			'name', 'full_description', // Fields for indexing.
		]
	],
	
	namespace\SecondModel::class => [
		'fields' => [
			'name', 'short_description', // Fields for indexing.
		]
	],
	
	// ...
	
],

You can also index values of optional fields (dynamic fields). For enable indexing for optional fields:

  • In config for each necessary model add following option:
        'optional_attributes' => true
        
        // or
        
        'optional_attributes' => [
                'field' => 'custom_name' // with specifying of accessor name
        ]
  • In model add special accessor, that returns list of field-name => field-value. By default getOptionalAttributesAttribute accessor will be used. In case accessor name specified in config getCustomNameAttribute accessor will be used.

Example:

In config file:

        namespace\FirstModel::class => [
                'fields' => [
                    'name', 'full_description', // Fixed fields for indexing.
                ],

                'optional_attributes' => true //  Enable indexing for dynamic fields
        ],

In model add following accessor:

        public function getOptionalAttributesAttribute()
        {
                return [
                        'optional_attribute1' => "value1",
                        'optional_attribute2' => "value2",
                ];
        }

By default the following filters are used by search:

  • Stemming filter for english/russian words,
  • Stopword filters for english/russian words.

This filters can be deleted or replaced with others.

'analyzer' => [
    'filters' => [
    	// Default stemming filter.
    	Nqxcode\Stemming\TokenFilterEnRu::class,
    ],
        
    // List of paths to files with stopwords. 
    'stopwords' => Nqxcode\LuceneSearch\Analyzer\Stopwords\Files::get(),
],
    

Usage

Artisan commands

Build/Rebuild search index

For building of search index run:

php artisan search:rebuild

Clear search index

For clearing of search index run:

php artisan search:clear

For filtering of models in search results each model's class can implements Searchable. For example:

use Illuminate\Database\Eloquent\Model;
use Nqxcode\LuceneSearch\Model\Searchable;

class Dummy extends Model implements Searchable
{
        // ...

        /**
         * Is the model available for searching?
         */
        public function isSearchable()
        {
            return $this->publish;
        }

        // ...
}

Partial updating of search index

For register of necessary events (save/update/delete) use Nqxcode\LuceneSearch\Model\SearchTrait in target model:

    use Illuminate\Database\Eloquent\Model;
    use Nqxcode\LuceneSearch\Model\Searchable;
    use Nqxcode\LuceneSearch\Model\SearchTrait;

    class Dummy extends Model implements Searchable
    {
        use SearchTrait;
    
        // ...
    }

Query building

Build query in several ways:

Using constructor:

By default, queries which will execute search in the phrase entirely are created.

Simple queries
$query = Search::query('clock'); // search by all fields.
// or 
$query = Search::where('name', 'clock'); // search by 'name' field.
// or
$query = Search::query('clock')              // search by all fields with
	->where('short_description', 'analog'); // filter by 'short_description' field. 
Advanced queries

For query and where methods it is possible to set the following options:

  • phrase - phrase match (boolean, true by default)
  • proximity - value of distance between words (unsigned integer)
  • fuzzy - value of fuzzy (float, 0 ... 1)
  • required - should match (boolean, true by default)
  • prohibited - should not match (boolean, false by default)
Examples:

Find all models in which any field contains phrase like 'composite one two phrase':

$query = Search::query('composite phrase', '*', ['proximity' => 2]); 

Search by each word in query:

$query = Search::query('composite phrase', '*', ['phrase' => false]); 

Using Lucene raw queries:

$query = Search::rawQuery('short_description:"analog"');
// or
$rawQuery = QueryParser::parse('short_description:"analog"');
$query = Search::rawQuery($rawQuery);

Getting of results

For built query are available following actions:

Get all found models

$models = $query->get();

Get count of results

$count = $query->count();

Get limit results with offset

$models = $query->limit(5, 10)->get(); // Limit = 5 and offset = 10

Paginate the found models

$paginator = $query->paginate(50);

Highlighting of matches

Highlighting of matches is available for any html fragment encoded in utf-8 and is executed only for the last executed request.

Search::find('nearly all words must be highlighted')->get();
$highlighted = Search::highlight('all words');

echo $highlighted;
 
// Echo: <span class="highlight">all</span> <span class="highlight">words</span>

License

Package licenced under the MIT license.

About

Laravel 4.2, 5.0, 5.1 package for full-text search over Eloquent models based on ZF2 Lucene.

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • PHP 100.0%