PHPackages                             vfou/php-search - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Search & Filtering](/categories/search)
4. /
5. vfou/php-search

ActiveLibrary[Search & Filtering](/categories/search)

vfou/php-search
===============

A Lucene-inspired PHP Search engine library

1.1.2(6y ago)311.2k7[2 issues](https://github.com/VincentFoulon80/php-search/issues)MITPHPPHP ^7.0

Since Jun 29Pushed 5y ago4 watchersCompare

[ Source](https://github.com/VincentFoulon80/php-search)[ Packagist](https://packagist.org/packages/vfou/php-search)[ RSS](/packages/vfou-php-search/feed)WikiDiscussions master Synced 3d ago

READMEChangelog (10)Dependencies (1)Versions (49)Used By (0)

Demo
====

[](#demo)

A small demo of this search engine is available [here](https://midnight-cms.com/search.php). This demo is made with a dataset of 1000 movies from 2006 and 2016. The results are provided as you type.

Installation
============

[](#installation)

install this library via Composer :

```
composer require vfou/php-search 1.1

```

What can it do ?
================

[](#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](https://github.com/VincentFoulon80/php-search/wiki/Features) for a more complete listing

Quick start
===========

[](#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.

```
use VFou\Search\Engine;

$engine = new Engine();
```

You can give an array in parameter of the class constructor, see [the wiki's configuration page](https://github.com/VincentFoulon80/php-search/wiki/Configuration) 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.

```
$doc = [
    "id" => 1,
    "type" => "example-post",
    "title" => "this is my first blog post !",
    "content" => "I am very happy to post this first post in my blog !",
    "categories" => [
        "party",
        "misc."
    ],
    "date" => "2018/01/01",
    "comments" => [
        [
            "author" => "vincent",
            "date" => "2018/01/01",
            "message" => "Hello world!"
        ],
        [
            "author" => "someone",
            "date" => "2018/01/02",
            "message" => "Welcome !"
        ]
    ]
];
$engine->update($doc);
$doc = [
    "id" => 2,
    "type" => "example-post",
    "title" => "This is the second blog post",
    "content" => "a second one for fun",
    "date" => "2018/01/05",
    "categories" => [
        "misc."
    ],
    "comments" => [
        [
            "author" => "someone",
            "date" => "2018/01/05",
            "message" => "Another one ?!"
        ]
    ]
];
$engine->update($doc);
```

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 :

```
$response = $engine->search('second post');
var_dump($response);

$response = $engine->search('post');
var_dump($response);
```

For more informations about this library, like using more advanced features, go to [the wiki page of this repository](https://github.com/VincentFoulon80/php-search/wiki)

Admin Panel
===========

[](#admin-panel)

⚠️ **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 :

```