cmsig/seal-algolia-adapter

An adapter to support algolia in cmsig/seal search abstraction.

0.5.0 2024-09-24 11:30 UTC

Requires

• php: ^8.1
• algolia/algoliasearch-client-php: ^4.4
• psr/container: ^1.0 || ^2.0
• schranz-search/seal: ^0.5

Requires (Dev)

• php-cs-fixer/shim: ^3.51
• phpstan/extension-installer: ^1.2
• phpstan/phpstan: ^1.10
• phpstan/phpstan-phpunit: ^1.3
• phpunit/phpunit: ^10.3
• rector/rector: ^1.0

MIT

• Alexander Schranz

• algolia
• schranz-search
• schranz-search-adapter
• seal-adapter
• search-client

README

Note: This is part of the cmsig/search project create issues in the main repository.

Logo created by Meine Wilma

SEAL
Algolia Adapter

The AlgoliaAdapter write the documents into the Algolia SaaS.

Note: This project is heavily under development and any feedback is greatly appreciated.

Installation

Use composer for install the package:

composer require cmsig/seal cmsig/seal-algolia-adapter

Usage

The following code shows how to create an Engine using this Adapter:

<?php

use Algolia\AlgoliaSearch\SearchClient;
use CmsIg\Seal\Adapter\Algolia\AlgoliaAdapter;
use CmsIg\Seal\Engine;

$client = Algolia\AlgoliaSearch\SearchClient::create(
    'YourApplicationID',
    'YourAdminAPIKey',
);

$engine = new Engine(
    new AlgoliaAdapter($client),
    $schema,
);

Via DSN for your favorite framework:

algolia://YourApplicationID:YourAdminAPIKey

Authors

• Alexander Schranz
• The Community Contributors