laravel lucene search

بحث لارافيل 5.5 لوسين

حزمة Laravel 5.5 للبحث عن النص الكامل عبر نماذج Eloquent المبنية على ZendSearch Lucene.

تثبيت

اطلب هذه الحزمة في ملف Composer.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 ' => 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 الطرق، من الممكن ضبط الخيارات التالية:

• عبارة - مطابقة العبارة (منطقية، صحيحة افتراضيًا)
• القرب - قيمة المسافة بين الكلمات (عدد صحيح غير موقّع)
• غامض - قيمة غامض (تعويم، 0 ... 1)
• مطلوب - يجب أن يتطابق (منطقي، صحيح افتراضيًا)
• محظور - يجب ألا يتطابق (منطقي، خطأ افتراضيًا)

أمثلة:

ابحث عن جميع النماذج التي يحتوي فيها أي حقل على عبارة مثل "عبارة مركبة مكونة من عبارة واحدة":

 $ 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.