laravel lucene search
1.0.0
Package Laravel 5.5 pour la recherche en texte intégral sur des modèles Eloquent basés sur ZendSearch Lucene.
Exigez ce package dans votre composer.json et exécutez composer update :
{
"require" : {
"nqxcode/laravel-lucene-search" : " 2.4.* "
}
} Après avoir mis à jour Composer, ajoutez le ServiceProvider au tableau des fournisseurs dans config/app.php
' providers ' => [
Nqxcode LuceneSearch ServiceProvider ::class,
], Si vous souhaitez utiliser la façade pour effectuer une recherche, ajoutez ceci à vos façades dans config/app.php :
' aliases ' => [
' Search ' => Nqxcode LuceneSearch Facade ::class,
],Publiez le fichier de configuration dans votre projet en exécutant :
php artisan vendor:publish --provider= " NqxcodeLuceneSearchServiceProvider "Dans le fichier de configuration publié, ajoutez des descriptions pour les modèles qui doivent être indexés, par exemple :
' 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
]
],
// ...
],Vous pouvez également indexer les valeurs des champs facultatifs (champs dynamiques). Pour activer l'indexation des champs facultatifs :
' optional_attributes ' => true
// or
' optional_attributes ' => [
' accessor ' => ' custom_name ' // with specifying of accessor name
]field-name => field-value . Par défaut, l'accesseur getOptionalAttributesAttribute sera utilisé. Dans le cas où le nom de l'accesseur spécifié dans la configuration, l'accesseur getCustomNameAttribute sera utilisé.Exemple:
Dans le fichier de configuration :
namespace FirstModel ::class => [
' fields ' => [
' name ' , ' full_description ' , // fixed fields for indexing
],
' optional_attributes ' => true // enable indexing for dynamic fields
],Dans le modèle, ajoutez l'accesseur suivant :
public function getOptionalAttributesAttribute ()
{
return [
' optional_attribute1 ' => ' value1 ' ,
' optional_attribute2 ' => ' value2 ' ,
];
}Voir les détails sur Apache Lucene - Scoring.
Il s'agit d' une amélioration du niveau du document dans la terminologie d'Apache Lucene. Par défaut, tous les modèles ont une valeur de boost égale à 1 . Pour modifier ce comportement, personnalisez Boost pour les modèles nécessaires, comme dans les exemples suivants.
' boost ' => true
// or
' boost ' => [
' accessor ' => ' custom_name ' // with specifying of accessor name
]Dans le modèle, ajoutez l'accesseur suivant :
public function getBoostAttribute ()
{
return 0.5 ; // customize boost value for model
}getBoostAttribute sera utilisé. Dans le cas où le nom de l'accesseur spécifié dans la configuration, l'accesseur getCustomNameAttribute sera utilisé.Exemple:
Dans le fichier de configuration :
namespace FirstModel ::class => [
' fields ' => [
' name ' , ' full_description ' ,
],
' boost ' => true // enable boosting for model
],Dans le modèle, ajoutez l'accesseur suivant :
public function getBoostAttribute ()
{
return 0.5 ; // customize boost value for model
}Il s'agit de l'amélioration du niveau de champ du document dans la terminologie d'Apache Lucene. Par défaut, le boost est réglé à 1 pour chaque champ. Pour modifier ce comportement, définissez Boost pour les champs nécessaires, comme dans les exemples suivants.
Dans le fichier de configuration :
namespace FirstModel ::class => [
' fields ' => [
' name ' , // field with default boost
' full_description ' => [ ' boost ' => 0.2 ], // customize boost value
],
],Ou/et en accesseur de modèle :
public function getOptionalAttributesAttribute ()
{
return [
' optional_attribute1 ' => ' value1 ' , // field with default boost
' optional_attribute2 ' => [ ' boost ' => 0.5 , ' value ' => ' value2 ' ], // customize boost value
];
}Par défaut, les filtres suivants sont utilisés dans la recherche :
Ces filtres peuvent être supprimés ou remplacés par d'autres.
' analyzer ' => [
' filters ' => [
// Default stemming filter.
Nqxcode Stemming TokenFilterEnRu ::class,
],
// List of paths to files with stopwords.
' stopwords ' => Nqxcode LuceneSearch Analyzer Stopwords Files :: get (),
],Pour la création de l'index de recherche :
php artisan search:rebuild --verbosePour effacer l'index de recherche :
php artisan search:clear Pour filtrer les modèles dans les résultats de recherche, la classe de chaque modèle peut implémenter SearchableInterface . Par exemple:
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 ' );
}
// ...
} Pour enregistrer les événements nécessaires (enregistrer/mettre à jour/supprimer), use NqxcodeLuceneSearchModelSearchTrait dans le modèle cible :
use Illuminate Database Eloquent Model ;
use Nqxcode LuceneSearch Model SearchableInterface ;
use Nqxcode LuceneSearch Model SearchTrait ;
class Dummy extends Model implements SearchableInterface
{
use SearchTrait ;
// ...
} Si vous souhaitez éviter de déclencher l'indexation, enveloppez les opérations nécessaires dans la méthode withoutSyncingToSearch() sur votre modèle :
Product :: withoutSyncingToSearch ( function () {
// mass update position for product, e.g.
foreach ( Product :: all () as $ i => $ product ) {
$ product -> update ([ ' position ' => $ i )]);
}
});Créez une requête de plusieurs manières :
Par défaut, des requêtes qui exécuteront la recherche dans l' intégralité de la phrase sont créées.
$ 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`. Pour les méthodes query et where il est possible de définir les options suivantes :
Recherchez tous les modèles dans lesquels un champ contient une expression telle que « composite une deux expression » :
$ query = Search :: query ( ' composite phrase ' , ' * ' , [ ' proximity ' => 2 ]);Recherche par chaque mot de la requête :
$ query = Search :: query ( ' composite phrase ' , ' * ' , [ ' phrase ' => false ]); $ query = Search :: rawQuery ( ' short_description:"analog" ' );
// or
$ rawQuery = QueryParser :: parse ( ' short_description:"analog" ' );
$ query = Search :: rawQuery ( $ rawQuery );Pour les requêtes construites, les actions suivantes sont disponibles :
$ models = $ query -> get (); $ count = $ query -> count (); $ models = $ query -> limit ( 5 , 10 )-> get (); // Limit = 5 and offset = 10 $ paginator = $ query -> paginate ( 50 );La mise en évidence des correspondances est disponible pour tout fragment HTML codé en utf-8 et n'est exécutée que pour la dernière requête exécutée.
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>' Package sous licence MIT.
