schranz-search/mezzio-module

An integration of schranz-search search abstraction into Mezzio Framework.

Maintainers

Details

github.com/schranz-search/mezzio-module

Source

Fund package maintenance!
alexander-schranz
paypal.me/L91

Installs: 3

Dependents: 0

Suggesters: 0

Security: 0

Stars: 1

Watchers: 3

Forks: 0

0.5.0 2024-09-24 11:30 UTC

Requires

Requires (Dev)

Conflicts

MIT 821aaf8f98f2921875897d9ff6f342bf06018a83

  • Alexander Schranz <alexander.woop@sulu.io>

packageabstractionsolrsearchmoduleelasticsearchBridgeintegrationopensearchalgoliaredisearchmezziomeilisearchtypesenseschranz-searchsearch-clientsearch-abstractionmezzio-moduleloupe

This package is auto-updated.

Last update: 2024-11-03 23:05:17 UTC

README

Schranz Search Logo with a Seal on it with a magnifying glass Logo created by Meine Wilma

SEAL
Mezzio Integration



Integration of the Schranz Search — Search Engine Abstraction Layer (SEAL) into Mezzio.

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

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

Installation

Use composer for install the package:

composer require schranz-search/mezzio-module

Also install one of the listed adapters.

List of adapters

The following adapters are available:

Additional Wrapper adapters:

Creating your own adapter? Add the seal-php-adapter Topic to your Github Repository.

Usage

The following code shows how to configure the package:

<?php

// src/App/src/ConfigProvider.php

class ConfigProvider
{
    public function __invoke(): array
    {
        return [
            // ...
            'schranz_search' => [
                'schemas' => [
                    'app' => [
                        'dir' => 'config/schemas',
                    ],
                ],
                'engines' => [
                    'default' => [
                        'adapter' => 'meilisearch://127.0.0.1:7700',
                    ],
                ],
            ],
        ];
    }
}

A more complex configuration can be here found:

<?php

// src/App/src/ConfigProvider.php

class ConfigProvider
{
    public function __invoke(): array
    {
        return [
            // ...
            'schranz_search' => [
                'schemas' => [
                    'app' => [
                        'dir' => 'config/schemas/app',
                        'engine' => 'meilisearch',
                    ],
                    'other' => [
                        'dir' => 'config/schemas/other',
                        'engine' => 'algolia',
                    ],
                ],
                'engines' => [
                    'algolia' => [
                        'adapter' => 'algolia://%ALGOLIA_APPLICATION_ID%%:%ALGOLIA_ADMIN_API_KEY%',
                    ],
                    'elasticsearch' => [
                        'adapter' => 'elasticsearch://127.0.0.1:9200',
                    ],
                    'meilisearch' => [
                        'adapter' => 'meilisearch://127.0.0.1:7700',
                    ],
                    'memory' => [
                        'adapter' => 'memory://',
                    ],
                    'opensearch' => [
                        'adapter' => 'opensearch://127.0.0.1:9200',
                    ],
                    'redisearch' => [
                        'adapter' => 'redis://supersecure@127.0.0.1:6379',
                    ],
                    'solr' => [
                        'adapter' => 'solr://127.0.0.1:8983',
                    ],
                    'typesense' => [
                        'adapter' => 'typesense://S3CR3T@127.0.0.1:8108',
                    ],
                    
                    // ...
                    'multi' => [
                        'adapter' => 'multi://elasticsearch?adapters[]=opensearch',
                    ],
                    'read-write' => [
                        'adapter' => 'read-write://elasticsearch?write=multi',
                    ],
                ],
                'index_name_prefix' => '',
                'reindex_providers' => [
                    \App\Search\BlogReindexProvider::class,
                ],
            ],
        ];
    }
}

The default engine is available as Engine:

class Some {
    public function __construct(
        private readonly \Schranz\Search\SEAL\EngineInterface $engine,
    ) {
    }
}

Multiple engines can be accessed via the EngineRegistry:

class Some {
    private Engine $engine;

    public function __construct(
        private readonly \Schranz\Search\SEAL\EngineRegistry $engineRegistry,
    ) {
        $this->engine = $this->engineRegistry->getEngine('algolia');
    }
}

How to create a Schema file and use your Engine can be found SEAL Documentation.

Commands

The package provides the following commands:

Create configured indexes

vendor/bin/laminas schranz:search:index-create --help

Drop configured indexes

vendor/bin/laminas schranz:search:index-drop --help

Authors