Fuzzy search for PHP based on Bitap algorithm
This package is auto-updated.
Last update: 2022-12-06 07:57:56 UTC
A fuzzy search library for PHP
This is a PHP port of the awesome Fuse.js project and aims to provide full API compatibility wherever possible.
Latest compatible Fuse.js version: 6.6.2
Table of Contents:
This package is available via Composer. To add it to your project, just run:
composer require loilo/fuse
Note that at least PHP 7.4 is needed to use Fuse.
Here's a simple usage example:
<?php require_once 'vendor/autoload.php'; $list = [ [ 'title' => "Old Man's War", 'author' => 'John Scalzi', ], [ 'title' => 'The Lock Artist', 'author' => 'Steve Hamilton', ], [ 'title' => 'HTML5', 'author' => 'Remy Sharp', ], [ 'title' => 'Right Ho Jeeves', 'author' => 'P.D Woodhouse', ], ]; $options = [ 'keys' => ['title', 'author'], ]; $fuse = new \Fuse\Fuse($list, $options); $fuse->search('hamil');
This leads to the following results (where each result's
item refers to the matched entry itself and
refIndex provides the item's position in the original
[ [ 'item' => [ 'title' => 'The Lock Artist', 'author' => 'Steve Hamilton', ], 'refIndex' => 1, ], [ 'item' => [ 'title' => 'HTML5', 'author' => 'Remy Sharp', ], 'refIndex' => 2, ], ];
Fuse has a lot of options to refine your search:
Indicates whether comparisons should be case sensitive.
Whether the score should be included in the result set. A score of
0 indicates a perfect match, while a score of
1 indicates a complete mismatch.
Whether the matches should be included in the result set. When
true, each record in the result set will include the indices of the matched characters. These can consequently be used for highlighting purposes.
Only the matches whose length exceeds this value will be returned. (For instance, if you want to ignore single character matches in the result, set it to
Whether to sort the result list, by score.
When true, the matching function will continue to the end of a search pattern even if a perfect match has already been located in the string.
Determines approximately where in the text is the pattern expected to be found.
At what point does the match algorithm give up. A threshold of
0.0 requires a perfect match (of both letters and location), a threshold of
1.0 would match anything.
Determines how close the match must be to the fuzzy location (specified by
location). An exact letter match which is
distance characters away from the fuzzy location would score as a complete mismatch. A
0 requires the match be at the exact
location specified. A distance of
1000 would require a perfect match to be within
800 characters of the
location to be found using a
true, search will ignore
distance, so it won't matter where in the string the pattern appears.
Tip: The default options only search the first 60 characters. This should suffice if it is reasonably expected that the match is within this range. To modify this behavior, set the appropriate combination of
To better understand how these options work together, read about Fuse.js' Scoring Theory.
true, it enables the use of unix-like search commands. See example.
- Default: source
The function to use to retrieve an object's value at the provided path. The default will also search nested paths.
- Default: source
The function to use to sort all the results. The default will sort by ascending relevance score, ascending index.
true, the calculation for the relevance score (used for sorting) will ignore the field-length norm.
Tip: The only time it makes sense to set
trueis when it does not matter how many terms there are, but only that the query term exists.
Determines how much the field-length norm affects scoring. A value of
0 is equivalent to ignoring the field-length norm. A value of
0.5 will greatly reduce the effect of field-length norm, while a value of
2.0 will greatly increase it.
You can access and manipulate default values of all options above via the
// Get an associative array of all options listed above Fuse::config(); // Merge associative array of options into default config Fuse::config(['shouldSort' => false]); // Get single default option Fuse::config('shouldSort'); // Set single default option Fuse::config('shouldSort', false);
The following methods are available on each
Searches the entire collection of documents, and returns a list of search results.
public function search(mixed $pattern, ?array $options): array
$pattern can be one of:
int): Denotes the max number of returned search results.
Set/replace the entire collection of documents. If no index is provided, one will be generated.
public function setCollection(array $docs, ?\Fuse\Core\FuseIndex $index): void
$fruits = ['apple', 'orange']; $fuse = new Fuse($fruits); $fuse->setCollection(['banana', 'pear']);
Adds a doc to the collection and update the index accordingly.
public function add(mixed $doc): void
$fruits = ['apple', 'orange']; $fuse = new Fuse($fruits); $fuse->add('banana'); sizeof($fruits); // => 3
Removes all documents from the list which the predicate returns truthy for, and returns an array of the removed docs. The predicate is invoked with two arguments:
public function remove(?callable $predicate): array
$fruits = ['apple', 'orange', 'banana', 'pear']; $fuse = new Fuse($fruits); $results = $fuse->remove(fn($doc) => $doc === 'banana' || $doc === 'pear'); sizeof($fuse->getCollection()); // => 2 $results; // => ['banana', 'pear']
Removes the doc at the specified index.
public function removeAt(int $index): void
$fruits = ['apple', 'orange', 'banana', 'pear']; $fuse = new Fuse($fruits); $fuse->removeAt(1); $fuse->getCollection(); // => ['apple', 'banana', 'pear']
Returns the generated Fuse index.
public function getIndex(): \Fuse\Core\FuseIndex
$fruits = ['apple', 'orange', 'banana', 'pear']; $fuse = new Fuse($fruits); $fuse->getIndex()->size(); // => 4
The following methods are available on each
Pre-generate the index from the list, and pass it directly into the Fuse instance. If the list is (considerably) large, it speeds up instantiation.
public static function createIndex(array $keys, array $docs, array $options = ): \Fuse\Core\FuseIndex
$list = [ ... ]; // See the example from the 'Usage' section $options = [ 'keys' => [ 'title', 'author.firstName' ] ]; // Create the Fuse index $myIndex = Fuse::createIndex($options['keys'], $list); // Initialize Fuse with the index $fuse = new Fuse($list, $options, $myIndex);
Parses a JSON-serialized Fuse index.
public static function parseIndex(array $data, array $options = ): \Fuse\Core\FuseIndex
// (1) When the data is collected $list = [ ... ]; // See the example from the 'Usage' section $options = [ 'keys' => [ 'title', 'author.firstName' ] ]; // Create the Fuse index $myIndex = Fuse::createIndex($options['keys'], $list); // Serialize and save it file_put_contents('fuse-index.json', json_encode($myIndex)); // (2) When the search is needed // Load and deserialize index to an array $fuseIndex = json_decode(file_get_contents('fuse-index.json'), true); $myIndex = Fuse::parseIndex($fuseIndex); // Initialize Fuse with the index $fuse = new Fuse($list, $options, $myIndex);
|Get Fuse Version||
|Access global configuration||
||In PHP, arrays are a primitive data type, which means that your original list is never modified by Fuse. To receive the current list after adding/removing items, the
Please note that I'm striving for feature parity with Fuse.js and therefore will add neither features nor fixes to the search logic that are not reflected in Fuse.js itself.
To start development on Fuse, you need git, PHP (≥ 7.4) and Composer.
Clone the repository and
cd into it:
git clone https://github.com/loilo/fuse.git cd fuse
Install Composer dependencies:
Install npm dependencies (optional but recommended). This is only needed for code formatting as npm dependencies include Prettier plugins used by this project.
There are different kinds of code checks in place for this project. All of these are run when a pull request is submitted but can also be run locally:
||check code style||Run PHP_CodeSniffer to verify that the Fuse source code abides by the PSR-12 coding style.|
||static analysis||Run Psalm against the codebase to avoid type-related errors and unsafe coding patterns.|
||check program logic||Run all PHPUnit tests from the
Before submitting a pull request, please add relevant tests to the