Скачать laravel lucene search - laravel lucene search скачать исходный код

Laravel 5.5 Поиск в Lucene

Пакет Laravel 5.5 для полнотекстового поиска по моделям Eloquent на основе ZendSearch Lucene.

Установка

Требуйте этот пакет в вашем композиторе.json и запустите обновление композитора:

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

После обновления композитора добавьте ServiceProvider в массив поставщиков в config/app.php

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

Если вы хотите использовать фасад для поиска, добавьте это в свои фасады в config/app.php :

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

Конфигурация

Опубликуйте файл конфигурации в свой проект, выполнив:

php artisan vendor:publish --provider= " NqxcodeLuceneSearchServiceProvider "

Базовый

В опубликованный файл конфигурации добавьте описания моделей, которые необходимо проиндексировать, например:

 ' index ' => [

	// ...

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

	namespace  SecondModel ::class => [
		' fields ' => [
			' name ' , ' short_description ' , // fields for indexing
		]
	],

	namespace  ModelWithCustomPrimaryKey ::class => [
		// You can also define your primary key (if you use something else than "id")
		' primary_key ' => ' my_custom_field_name ' ,
		' fields ' => [
			' username ' , ' short_description ' , // fields for indexing
		]
	],

	// ...

],

Индексирование динамических полей

Вы также можете индексировать значения необязательных полей (динамических полей). Чтобы включить индексацию необязательных полей:

В конфиге для каждой необходимой модели добавьте следующую опцию:

        ' optional_attributes ' => true

        // or

        ' optional_attributes ' => [
                ' accessor ' => ' custom_name ' // with specifying of accessor name
        ]

В модель добавьте специальный аксессор , который возвращает список field-name => field-value . По умолчанию будет использоваться метод доступа getOptionalAttributesAttribute . В случае, если имя средства доступа, указанное в конфигурации, будет использоваться метод доступа getCustomNameAttribute .

Пример:

В файле конфигурации:

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

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

В модель добавьте следующий аксессор:

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

Повышение очков

См. подробную информацию об Apache Lucene — оценка.

Повышение уровня модели

Это повышение уровня документа в терминологии Apache Lucene. По умолчанию все модели имеют значение повышения, равное 1 . Для изменения этого поведения настройте boost для необходимых моделей, как показано в следующих примерах.

В конфиге для каждой необходимой модели добавьте следующую опцию:

        ' boost ' => true

        // or

        ' boost ' => [
                ' accessor ' => ' custom_name ' // with specifying of accessor name
        ]

В модель добавьте следующий аксессор:

        public function getBoostAttribute ()
        {
                return 0.5 ; // customize boost value for model
        }

В модель добавьте специальный аксессор , который возвращает значение повышения. По умолчанию будет использоваться метод доступа getBoostAttribute . В случае, если имя средства доступа, указанное в конфигурации, будет использоваться метод доступа getCustomNameAttribute .

Пример:

В файле конфигурации:

        namespace  FirstModel ::class => [
                ' fields ' => [
                    ' name ' , ' full_description ' ,
                ],

                ' boost ' => true // enable boosting for model
        ],

В модель добавьте следующий аксессор:

        public function getBoostAttribute ()
        {
                return 0.5 ; // customize boost value for model
        }

Повышение уровня поля модели

Это повышение уровня поля документа в терминологии Apache Lucene. По умолчанию для каждого поля установлено значение 1 . Для изменения этого поведения установите повышение для необходимых полей, как в следующих примерах.

В файле конфигурации:

        namespace  FirstModel ::class => [
                ' fields ' => [
                    ' name ' , // field with default boost
                    ' full_description ' => [ ' boost ' => 0.2 ], // customize boost value
                ],
        ],

Или/и в методе доступа к модели:

        public function getOptionalAttributesAttribute ()
        {
                return [
                        ' optional_attribute1 ' => ' value1 ' , // field with default boost
                        ' optional_attribute2 ' => [ ' boost ' => 0.5 , ' value ' => ' value2 ' ], // customize boost value
                ];
        }

Стемминг и стоп-слова

По умолчанию при поиске используются следующие фильтры:

Стемминг-фильтр для английских/русских слов (для приведения слов к их корневой форме),
Фильтры стоп-слов для английских/русских слов (для исключения некоторых слов из индекса поиска).

Эти фильтры можно удалить или заменить другими.

 ' analyzer ' => [
    ' filters ' => [
    	// Default stemming filter.
    	Nqxcode  Stemming  TokenFilterEnRu ::class,
    ],

    // List of paths to files with stopwords.
    ' stopwords ' => Nqxcode  LuceneSearch  Analyzer  Stopwords  Files :: get (),
],

Использование

Мастерские команды

Инициализировать или перестроить индекс поиска

Для построения поискового индекса выполните:

php artisan search:rebuild --verbose

Очистить индекс поиска

Для очистки индекса поиска выполните:

php artisan search:clear

Фильтрация моделей в результатах поиска

Для фильтрации моделей в результатах поиска класс каждой модели может реализовать SearchableInterface . Например:

 use Illuminate  Database  Eloquent  Model ;
use Nqxcode  LuceneSearch  Model  SearchableInterface ;

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

        /**
         * Get id list for all searchable models.
         */
        public static function searchableIds ()
        {
            return self :: wherePublish ( true )-> pluck ( ' id ' );
        }

        // ...
}

Частичное обновление поискового индекса

Для регистрации необходимых событий (сохранение/обновление/удаление) use NqxcodeLuceneSearchModelSearchTrait в целевой модели:

    use Illuminate  Database  Eloquent  Model ;
    use Nqxcode  LuceneSearch  Model  SearchableInterface ;
    use Nqxcode  LuceneSearch  Model  SearchTrait ;

    class Dummy extends Model implements SearchableInterface
    {
        use SearchTrait ;

        // ...
    }

Выполнять операции без индексации

Если вы хотите избежать запуска индексации, оберните необходимые операции в метод withoutSyncingToSearch() вашей модели:

 Product :: withoutSyncingToSearch ( function () {
    // mass update position for product, e.g.
    foreach ( Product :: all () as $ i => $ product ) {
        $ product -> update ([ ' position ' => $ i )]);
    }    
});

Построение запросов

Постройте запрос несколькими способами:

Использование конструктора:

По умолчанию создаются запросы, которые будут выполнять поиск по фразе целиком .

Простые запросы

 $ 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.
// or
$ query = Product :: search ( ' clock ' ); // search only in `Product` model by all fields in case when `Product` use `SearchableTrait`.

Расширенные запросы

Для query и where можно установить следующие параметры:

фраза — фразовое соответствие (логическое значение, по умолчанию true)
близость - значение расстояния между словами (целое без знака)
fuzzy - значение fuzzy (float, 0...1)
требуется - должно совпадать (логическое значение, по умолчанию true)
запрещено - не должно совпадать (логическое значение, по умолчанию false)

Примеры:

Найдите все модели, в которых любое поле содержит фразу типа «составная одна две фразы»:

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

Поиск по каждому слову в запросе:

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

Использование необработанных запросов Lucene:

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

Получение результатов

Для построенного запроса доступны следующие действия:

Получить все найденные модели

 $ models = $ query -> get ();

Получить подсчет результатов

 $ count = $ query -> count ();

Получить результаты по пределам со смещением

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

Разбивка по страницам найденных моделей

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

Подсветка матчей

Подсветка совпадений доступна для любого html-фрагмента в кодировке utf-8 и выполняется только для последнего выполненного запроса.

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

// highlighted html:
// '<span class="highlight">all</span> <span class="highlight">words</span>'

Лицензия

Пакет лицензируется по лицензии MIT.

Расширять