laravel lucene search
1.0.0
Laravel 5.5-Paket für die Volltextsuche über Eloquent-Modelle basierend auf ZendSearch Lucene.
Fordern Sie dieses Paket in Ihrer Composer.json an und führen Sie das Composer-Update aus:
{
"require" : {
"nqxcode/laravel-lucene-search" : " 2.4.* "
}
} Fügen Sie nach dem Aktualisieren von Composer den ServiceProvider zum Provider-Array in config/app.php hinzu
' providers ' => [
Nqxcode LuceneSearch ServiceProvider ::class,
], Wenn Sie die Fassade zum Suchen verwenden möchten, fügen Sie dies zu Ihren Fassaden in config/app.php hinzu:
' aliases ' => [
' Search ' => Nqxcode LuceneSearch Facade ::class,
],Veröffentlichen Sie die Konfigurationsdatei in Ihrem Projekt, indem Sie Folgendes ausführen:
php artisan vendor:publish --provider= " NqxcodeLuceneSearchServiceProvider "Fügen Sie in der veröffentlichten Konfigurationsdatei Beschreibungen für Modelle hinzu, die indiziert werden müssen, zum Beispiel:
' 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
]
],
// ...
],Sie können auch Werte optionaler Felder (dynamische Felder) indizieren. So aktivieren Sie die Indizierung für optionale Felder:
' optional_attributes ' => true
// or
' optional_attributes ' => [
' accessor ' => ' custom_name ' // with specifying of accessor name
]field-name => field-value zurückgibt. Standardmäßig wird der getOptionalAttributesAttribute -Accessor verwendet. Falls der in der Konfiguration angegebene Accessorname getCustomNameAttribute verwendet wird, wird der Accessor verwendet.Beispiel:
In der Konfigurationsdatei:
namespace FirstModel ::class => [
' fields ' => [
' name ' , ' full_description ' , // fixed fields for indexing
],
' optional_attributes ' => true // enable indexing for dynamic fields
],Fügen Sie im Modell den folgenden Accessor hinzu:
public function getOptionalAttributesAttribute ()
{
return [
' optional_attribute1 ' => ' value1 ' ,
' optional_attribute2 ' => ' value2 ' ,
];
}Weitere Informationen finden Sie unter Apache Lucene – Scoring.
Dies ist eine Erhöhung der Dokumentebene in der Terminologie von Apache Lucene. Standardmäßig haben alle Modelle einen Boost- Wert von 1 . Um dieses Verhalten zu ändern, passen Sie Boost für die erforderlichen Modelle an, wie in den folgenden Beispielen.
' boost ' => true
// or
' boost ' => [
' accessor ' => ' custom_name ' // with specifying of accessor name
]Fügen Sie im Modell den folgenden Accessor hinzu:
public function getBoostAttribute ()
{
return 0.5 ; // customize boost value for model
}getBoostAttribute Accessor verwendet. Falls der in der Konfiguration angegebene Accessorname verwendet wird, wird der getCustomNameAttribute -Accessor verwendet.Beispiel:
In der Konfigurationsdatei:
namespace FirstModel ::class => [
' fields ' => [
' name ' , ' full_description ' ,
],
' boost ' => true // enable boosting for model
],Fügen Sie im Modell den folgenden Accessor hinzu:
public function getBoostAttribute ()
{
return 0.5 ; // customize boost value for model
}Dies ist die Feldebenenverstärkung von Document in der Terminologie von Apache Lucene. Standardmäßig ist der Boost für jedes Feld auf 1 eingestellt. Um dieses Verhalten zu ändern, stellen Sie Boost für die erforderlichen Felder wie in den folgenden Beispielen ein.
In der Konfigurationsdatei:
namespace FirstModel ::class => [
' fields ' => [
' name ' , // field with default boost
' full_description ' => [ ' boost ' => 0.2 ], // customize boost value
],
],Oder/und im Modell-Accessor:
public function getOptionalAttributesAttribute ()
{
return [
' optional_attribute1 ' => ' value1 ' , // field with default boost
' optional_attribute2 ' => [ ' boost ' => 0.5 , ' value ' => ' value2 ' ], // customize boost value
];
}Standardmäßig werden bei der Suche die folgenden Filter verwendet:
Diese Filter können gelöscht oder durch andere ersetzt werden.
' analyzer ' => [
' filters ' => [
// Default stemming filter.
Nqxcode Stemming TokenFilterEnRu ::class,
],
// List of paths to files with stopwords.
' stopwords ' => Nqxcode LuceneSearch Analyzer Stopwords Files :: get (),
],Führen Sie zum Erstellen des Suchindex Folgendes aus:
php artisan search:rebuild --verboseZum Löschen des Suchindex führen Sie Folgendes aus:
php artisan search:clear Zum Filtern von Modellen in Suchergebnissen kann jede Modellklasse SearchableInterface implementieren. Zum Beispiel:
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 ' );
}
// ...
} Für die Registrierung notwendiger Ereignisse (Speichern/Aktualisieren/Löschen) use NqxcodeLuceneSearchModelSearchTrait im Zielmodell:
use Illuminate Database Eloquent Model ;
use Nqxcode LuceneSearch Model SearchableInterface ;
use Nqxcode LuceneSearch Model SearchTrait ;
class Dummy extends Model implements SearchableInterface
{
use SearchTrait ;
// ...
} Wenn Sie das Auslösen der Indizierung vermeiden möchten, schließen Sie die erforderlichen Vorgänge in die Methode withoutSyncingToSearch() Ihres Modells ein:
Product :: withoutSyncingToSearch ( function () {
// mass update position for product, e.g.
foreach ( Product :: all () as $ i => $ product ) {
$ product -> update ([ ' position ' => $ i )]);
}
});Erstellen Sie eine Abfrage auf verschiedene Arten:
Standardmäßig werden Abfragen erstellt, bei denen die Suche vollständig in der Phrase ausgeführt wird.
$ 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`. Für query und where -Methoden können die folgenden Optionen festgelegt werden:
Finden Sie alle Modelle, in denen ein beliebiges Feld eine Phrase wie „zusammengesetzt aus einer und zwei Phrasen“ enthält:
$ query = Search :: query ( ' composite phrase ' , ' * ' , [ ' proximity ' => 2 ]);Suchen Sie nach jedem gesuchten Wort:
$ query = Search :: query ( ' composite phrase ' , ' * ' , [ ' phrase ' => false ]); $ query = Search :: rawQuery ( ' short_description:"analog" ' );
// or
$ rawQuery = QueryParser :: parse ( ' short_description:"analog" ' );
$ query = Search :: rawQuery ( $ rawQuery );Für die erstellte Abfrage stehen folgende Aktionen zur Verfügung:
$ models = $ query -> get (); $ count = $ query -> count (); $ models = $ query -> limit ( 5 , 10 )-> get (); // Limit = 5 and offset = 10 $ paginator = $ query -> paginate ( 50 );Die Hervorhebung von Übereinstimmungen ist für jedes in utf-8 codierte HTML-Fragment verfügbar und wird nur für die zuletzt ausgeführte Anfrage ausgeführt.
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>' Paket lizenziert unter der MIT-Lizenz.
