Search

<div align="center"> ^{<b>Your feedback is important 📘</b> <br /> <a href="https://github.com/PHP-CMSIG/search/discussions/416">Are you working with SEAL? Let us know!</a> | <a href="https://github.com/PHP-CMSIG/search/discussions/457">Which Search Engines do you use and why?</a>} </div> <br /> <br /> <br /> <br /> <div align="center"> <img alt="SEAL Logo with an abstract seal sitting on a telescope." src="https://avatars.githubusercontent.com/u/120221538?s=400&v=6" width="200" height="200"> </div> <div align="center">Logo created by <a href="https://cargocollective.com/meinewilma">Meine Wilma</a></div> <h1 align="center">SEAL</h1> <div align="center">

<strong>Monorepository</strong> for SEAL a Search Engine Abstraction Layer with support to different search engines<br/> <a href="https://php-cmsig.github.io/search/">Documentation</a> | Packages

Elasticsearch | Opensearch | Meilisearch | Algolia | Loupe | Solr | Redisearch | Typesense <br/> PHP | Symfony | Laravel | Spiral | Mezzio | Yii

</div> <br /> <br />

👋 Introduction

The SEAL project is a PHP library designed to simplify the process of interacting with different search engines. It provides a straightforward interface that enables users to communicate with various search engines, including:

• Elasticsearch
• Opensearch
• Meilisearch
• Algolia
• Loupe
• Solr
• RediSearch
• Typesense
• Memory
• ... missing something? Let us know!

It also provides integration packages for the

Symfony, Laravel, Spiral, Mezzio and Yii PHP frameworks.

It is worth noting that the project draws inspiration from the Doctrine and Flysystem projects. These two projects have been a great inspiration in the development of SEAL, as they provide excellent examples of how to create consistent and user-friendly APIs for complex systems.

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

🏗️ Structure

SEAL's provides a basic abstraction layer for add, remove and search and filters for documents. The main class and service handling this is called Engine, which is responsible for all this things. The Schema which is required defines the different Indexes and their Fields.

The project provides different Adapters which the Engine uses to communicate with the different Search Engine software and services. This way it is easy to switch between different search engine software and services.

Glossary

| Term | Definition | |-----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Engine | The main class and service responsible to provide the basic interface for add, remove and search and filters for documents. | | Schema | Defines the different Indexes and their Fields, for every field a specific type need to be defined and what you want todo with them via flags like searchable, filterable and sortable. | | Adapter | Provides the communication between the Engine and the Search Engine software and services. | | Documents | A structure of data that you want to index need to follow the structure of the fields of the index schema. | | Search Engine | Search Engine software or service where the data will actually be stored currently Meilisearch, Opensearch, Elasticsearch, Algolia, Redisearch, Solr and Typesense is supported. |

📖 Installation and Documentation

The documentation is available at https://php-cmsig.github.io/search/. It is the recommended and best way to start using the library, it will step-by-step guide you through all the features of the library.

• Introduction
• Getting Started
• Schema
• Index Operations
• Search & Filters
• Cookbooks
• Research

📦 Packages

Full list of packages provided by the SEAL project:

• cmsig/seal - The core package of the SEAL project.
• cmsig/seal-algolia-adapter - Adapter for the Algolia search engine.
• cmsig/seal-elasticsearch-adapter - Adapter for the Elasticsearch search engine.
• cmsig/seal-opensearch-adapter - Adapter for the Opensearch search engine.
• cmsig/seal-meilisearch-adapter - Adapter for the Meilisearch search engine.
• cmsig/seal-loupe-adapter - Adapter for the Loupe search engine.
• cmsig/seal-redisearch-adapter - Adapter for the Redisearch search engine.
• cmsig/seal-solr-adapter - Adapter for the Solr search engine.
• cmsig/seal-typesense-adapter - Adapter for the Typesense search engine.
• cmsig/seal-read-write-adapter - Adapter to split read and write operations.
• cmsig/seal-multi-adapter - Adapter to write into multiple search engines.
• cmsig/seal-laravel-package - Integrates SEAL into the Laravel framework.
• cmsig/seal-symfony-bundle - Integrates SEAL into the Symfony framework.
• cmsig/seal-spiral-bridge - Integrates SEAL into the Spiral framework.
• cmsig/seal-mezzio-module - Integrates SEAL into the Mezzio framework.
• cmsig/seal-yii-module - Integrates SEAL into the Yii framework.

Have also a look at the following tags:

• https://packagist.org/providers/cmsig/seal-adapter-implementation
• https://github.com/topics/seal-php-adapter

Usages

The following open source projects are using SEAL:

• Contao CMS
• Sulu CMS
• Typo3 Extension

You are using SEAL? Let us know.

🦑 Similar Projects

The following projects in the past target a similar problem:

• https://github.com/nresni/Ariadne (Solr, Elasticsearch, Zendsearch: outdated 12 years ago)
• https://github.com/massiveart/MassiveSearchBundle (ZendSearch, Elasticsearch: for Symfony only and Lucene query syntax)
• https://github.com/laravel/scout (Algolia, Meilisearch, Typesense: for Laravel only)
• https://github.com/Mezcalito/ux-search/ (Doctrine, Meilisearch, Algolia: Symfony UX focused)
• https://github.com/rollerworks/search (Doctrine DBAL, Doctrine ORM, ElasticSearch: focused on Query building)

📩 Authors

• Alexander Schranz
• The Community Contributors