bentools/meilisearch-filters

Expression builder for Meilisearch filters.

dev-main 2024-01-09 20:48 UTC

Requires

• php: >= 8.2

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.40
• pestphp/pest: ^2.27
• phpstan/phpstan: ^1.10
• symfony/var-dumper: *

MIT

README

MeiliSearch Filter Builder

This library allows you to build Meilisearch filters using PHP.

This is a port of the JS library.

Examples:

Comparison Filters

use function Bentools\MeilisearchFilters\field;

echo field('cat')->equals("Berlioz"); // cat = 'Berlioz'
echo field('cat')->notEquals("O'Malley"); // cat != 'O\\'Malley'
echo field('age')->isGreaterThan(5); // age > '5'
echo field('age')->isGreaterThan(5, true); // age >= '5'
echo field('age')->isNotGreaterThan(5); // age <= '5'
echo field('age')->isNotGreaterThan(5, true); // age < '5'
echo field('age')->isLowerThan(10); // age < '10'
echo field('age')->isLowerThan(10, true); // age <= '10'
echo field('age')->isNotLowerThan(10); // age >= '10'
echo field('age')->isNotLowerThan(10, true); // age > '10'

Between Filter

use function Bentools\MeilisearchFilters\field;

echo field('age')->isBetween(5, 10); // age '5' TO '10'
echo field('age')->isNotBetween(5, 10); // NOT age '5' TO '10'
echo field('age')->isBetween(5, 10, false); // age > '5' AND age < '10'
echo field('age')->isNotBetween(5, 10, false); // NOT (age > '5' AND age < '10')

Exists Filter

use function Bentools\MeilisearchFilters\field;

echo field('god')->exists(); // god EXISTS
echo field('god')->doesNotExist(); // god NOT EXISTS

Empty Filter

use function Bentools\MeilisearchFilters\field;

echo field('glass')->isEmpty(); // glass IS EMPTY
echo field('glass')->isNotEmpty(); // glass IS NOT EMPTY

Null Filter

use function Bentools\MeilisearchFilters\field;

echo field('nullish')->isNull(); // nullish IS NULL
echo field('nullish')->isNotNull(); // nullish IS NOT NULL

IN Filter

use function Bentools\MeilisearchFilters\field;

$cat = field('cat')
echo $cat->isIn(['Berlioz', "O'Malley"]); // cat IN ['Berlioz', 'O\\'Malley']
echo $cat->isNotIn(['Berlioz', "O'Malley"]); // cat NOT IN ['Berlioz', 'O\\'Malley']

Geographic filters

use function Bentools\MeilisearchFilters\{withinGeoRadius, notWithinGeoRadius};

echo withinGeoRadius(50.35, 3.51, 3000); // _geoRadius(50.35, 3.51, 3000)
echo notWithinGeoRadius(50.35, 3.51, 3000); // NOT _geoRadius(50.35, 3.51, 3000)

use function Bentools\MeilisearchFilters\{withinGeoBoundingBox, notWithinGeoBoundingBox};

echo withinGeoBoundingBox([50.55, 3], [50.52, 3.08]); // _geoBoundingBox([50.55, 3], [50.52, 3.08])
echo notWithinGeoBoundingBox([50.55, 3], [50.52, 3.08]); // NOT _geoBoundingBox([50.55, 3], [50.52, 3.08])

Composite filters

use function Bentools\MeilisearchFilters\field;

$cat = field('cat')
$color = field('color')
$age = field('age')
echo $cat->equals("Berlioz")->and($age->between(5, 10)); // cat = 'Berlioz' AND age '5' TO '10'
echo $cat->equals("Berlioz")->or($age->between(5, 10)); // cat = 'Berlioz' OR age '5' TO '10'

// Automatic grouping
echo $color->equals('ginger')->or($cat->equals("Berlioz")->and($age->between(5, 10))); // color = 'ginger' OR (cat = 'Berlioz' AND age '5' TO '10')

NOT filter

use function Bentools\MeilisearchFilters\{field, not};

$color = field('ginger')
echo not($color->equals('ginger')); // NOT color = 'ginger' 

Adding parentheses

use function Bentools\MeilisearchFilters\{field, group};

$color = field('ginger')
echo group($color->equals('ginger')); // (color = 'ginger') 

Installation

composer req bentools/meilisearch-filters

Tests

composer ci:check

License

MIT.