README

About

Fuzor is a dependency-free full-text search library for PHP. It tokenises your documents, stores an inverted index in a single SQLite file, and scores results with Okapi BM25 — no external services required.

• BM25 ranked search with fuzzy and boolean modes
• Search-as-you-type prefix matching
• Stopword filtering and Snowball stemming for 62 languages
• Snippet extraction and result highlighting
• One SQLite file per index — zero infrastructure

Installation

composer require onstage2426/fuzor

Requirements: PHP 8.5+, SQLite 3.37.0+

Usage

use Fuzor\Index;

// Create an index and add documents
$index = new Index('/path/to/articles.db', language: 'en');
$index->insertMany([
    ['id' => 1, 'title' => 'Fast sedan',     'body' => 'Comfortable city car with great fuel economy.'],
    ['id' => 2, 'title' => 'Off-road SUV',   'body' => 'Built for adventure. Handles any terrain.'],
    ['id' => 3, 'title' => 'Electric coupe', 'body' => 'Zero emissions, instant torque, sporty design.'],
]);

// Search
$results = $index->search('economi', fuzzy: true);
$results = $index->searchBoolean('sedan or coupe -electric');

Documentation

• Indexing — bulk loading, upsert, rebuild, snapshots
• Search — BM25 tuning, fuzzy, boolean, prefix
• Language — stopwords, stemming, CJK/Thai n-grams
• Configuration — all tuning parameters
• Snippeting and Highlighting

License

MIT — see LICENSE.