Download the PHP package mfonte/php82-search without Composer
On this page you can find all versions of the php package mfonte/php82-search. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download mfonte/php82-search
More information about mfonte/php82-search
Files in mfonte/php82-search
Package php82-search
Short Description A Lucene-inspired PHP Search engine library
License MIT
Informations about the package php82-search
Demo
A Lucene-inspired PHP Search engine library.
Original Package: https://github.com/VincentFoulon80/php-search.
Internally uses Wamania PHP Snowball Stemmer https://github.com/wamania/php-stemmer
This package was forked to allow PHP 8.2 compatibility.
Installation
install this library via Composer :
What can it do ?
in short :
- indexing and searching documents (with score, fuzzy search and tokenization)
- Stemming and stop-words of 12 supported languages
- Faceting
- Autocompletion
- Connex Search
Take a look at the Feature Page for a more complete listing
Quick start
The search engine is packaged with an example schema that allow you to take hand quickly on the library.
at first you need to load the search engine.
You can give an array in parameter of the class constructor, see the wiki's configuration page for more informations.
By constructing the engine, there'll be some directory that appeared next to your index file :
- var/engine/index
- var/engine/documents
- var/engine/cache
(All these directories can be changed with the configuration array)
At first, you have to give to the engine something to search for. We'll create some documents and ask the engine to index them.
Note : you can also put these two documents in one array and use the updateMultiple() function for indexing multiple documents at once.
Now that you documents are indexed, you can use the search function and fetch results :
For more informations about this library, like using more advanced features, go to the wiki page of this repository
Admin Panel
:warning: Warning : This panel does not handle any security by itself. If you use it, it's up to you to prevent the public from accessing it !
The Admin panel is a class that need to be instantiated and then run. It's not a callable file so you'll need to call it via a regular php file :
the AdminPanel's constructor accept as first parameter the same config array as you may use to instanciate the Engine, and you'll want to pass it if you have customized schemas. (or else the panel will not work properly)
More informations in the Admin Panel Manual
License
This library is under the MIT license. See the complete license