gbprod/algolia-specification

This package is abandoned and no longer maintained. No replacement package was suggested.

This library allows you to create Algolia queries using the Specification pattern

v2.1.0 2018-02-26 09:35 UTC

Requires

• php: ^7.0
• algolia/algoliasearch-client-php: ^1.10
• gbprod/specification: ^2.0

Requires (Dev)

• phpunit/phpunit: ^6.0|^7.0

WTFPL

• GBProd

README

This library allows you to create Algolia queries using the specification pattern.

Usage

You can write specifications using gbprod/specification library.

Creates a algolia specification filter

@see Algolia documentation

namespace GBProd\Acme\Algolia\SpecificationFactory;

use GBProd\AlgoliaSpecification\QueryFactory\Factory;
use GBProd\Specification\Specification;

class IsAvailableFactory implements Factory
{
    public function create(Specification $spec)
    {
        return 'available=1';
    }
}

Configure

$registry = new GBProd\AlgoliaSpecification\Registry();

$handler = new GBProd\AlgoliaSpecification\Handler($registry);
$handler->registerFactory(IsAvailable::class, new IsAvailableFactory());
$handler->registerFactory(StockGreaterThan::class, new StockGreaterThanFactory());

Use it

$available = new IsAvailable();
$hightStock = new StockGreaterThan(4);

$availableWithLowStock = $available
    ->andX(
        $hightStock->not()
    )
;
$client = new \AlgoliaSearch\Client('YourApplicationID', 'YourAPIKey');
$index = $client->initIndex('index_name');

$query = $handler->handle($availableWithLowStock)

$results = $type->search(['filters' => $query]);

Requirements

• PHP >= 7.0

Installation

Using composer

composer require gbprod/algolia-specification