schranz-search/laravel-package

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

0.5.0 2024-09-24 11:30 UTC

This package is auto-updated.

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


README

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

SEAL
Laravel Integration



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

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/laravel-package

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

// config/schranz_search.php

return [
    /*
    |--------------------------------------------------------------------------
    | Schema configs
    |--------------------------------------------------------------------------
    |
    | Define different directories for the schema loader.
    */

    'schemas' => [
        'app' => [
            'dir' => resource_path('schemas'),
        ],
    ],

    /*
    |--------------------------------------------------------------------------
    | engines
    |--------------------------------------------------------------------------
    |
    | Directory where the latte templates can be found.
    */

    'engines' => [
        'default' => [
            'adapter' => env(
                'ENGINE_URL',
                'meilisearch://127.0.0.1:7700',
            ),
        ],
    ],
];

A more complex configuration can be here found:

<?php

// config/schranz_search.php

return [
    /*
    |--------------------------------------------------------------------------
    | Schema configs
    |--------------------------------------------------------------------------
    |
    | Define different directories for the schema loader.
    */

    'schemas' => [
        'app' => [
            'dir' => resource_path('schemas') . '/app',
            'engine' => 'meilisearch',
        ],
        'other' => [
            'dir' => resource_path('schemas') . '/other',
            'engine' => 'algolia',
        ],
    ],

    /*
    |--------------------------------------------------------------------------
    | engines
    |--------------------------------------------------------------------------
    |
    | Directory where the latte templates can be found.
    */

    'engines' => [
        'algolia' => [
            'adapter' => 'algolia://' . env('ALGOLIA_APPLICATION_ID') . ':' . env('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',
        ],
    ],

    /*
    |--------------------------------------------------------------------------
    | Schema prefix
    |--------------------------------------------------------------------------
    |
    | Define the prefix used for the index names to avoid conflicts.
    */

    'index_name_prefix' => '',
];

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->get('algolia');
    }
}

Instead of constructor injection the Laravel integration provides also two Facades for the above services:

  • Schranz\Search\Integration\Laravel\Facade\Engine
  • Schranz\Search\Integration\Laravel\Facade\EngineRegistry

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

php artisan schranz:search:index-create --help

Drop configured indexes

php artisan schranz:search:index-drop --help

Authors