Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/php-cmsig/seal-symfony-bundle
An integration of CMS-IG SEAL search abstraction via a Bundle into the Symfony Framework. Part of the https://github.com/php-cmsig/search project. READ-ONLY Repository
https://github.com/php-cmsig/seal-symfony-bundle
cmsig php seal-integration seal-search search symfony
Last synced: 30 days ago
JSON representation
An integration of CMS-IG SEAL search abstraction via a Bundle into the Symfony Framework. Part of the https://github.com/php-cmsig/search project. READ-ONLY Repository
- Host: GitHub
- URL: https://github.com/php-cmsig/seal-symfony-bundle
- Owner: PHP-CMSIG
- License: mit
- Created: 2023-04-02T13:53:04.000Z (over 1 year ago)
- Default Branch: 0.6
- Last Pushed: 2024-11-16T22:01:24.000Z (about 1 month ago)
- Last Synced: 2024-11-16T22:19:26.248Z (about 1 month ago)
- Topics: cmsig, php, seal-integration, seal-search, search, symfony
- Language: PHP
- Homepage:
- Size: 458 KB
- Stars: 8
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
Logo created by Meine Wilma
SEAL
Symfony Integration
Integration of the CMS-IG — Search Engine Abstraction Layer (SEAL) into Symfony.
> **Note**:
> This is part of the `cmsig/search` project create issues in the [main repository](https://github.com/php-cmsig/search).
> **Note**:
> This project is heavily under development and any feedback is greatly appreciated.
## Installation
Use [composer](https://getcomposer.org/) for install the package:
```bash
composer require cmsig/seal-symfony-bundle
```
Also install one of the listed adapters.
### List of adapters
The following adapters are available:
- [MemoryAdapter](../../packages/seal-memory-adapter): `cmsig/seal-memory-adapter`
- [ElasticsearchAdapter](../../packages/seal-elasticsearch-adapter): `cmsig/seal-elasticsearch-adapter`
- [OpensearchAdapter](../../packages/seal-opensearch-adapter): `cmsig/seal-opensearch-adapter`
- [MeilisearchAdapter](../../packages/seal-meilisearch-adapter): `cmsig/seal-meilisearch-adapter`
- [AlgoliaAdapter](../../packages/seal-algolia-adapter): `cmsig/seal-algolia-adapter`
- [SolrAdapter](../../packages/seal-solr-adapter): `cmsig/seal-solr-adapter`
- [RediSearchAdapter](../../packages/seal-redisearch-adapter): `cmsig/seal-redisearch-adapter`
- [TypesenseAdapter](../../packages/seal-typesense-adapter): `cmsig/seal-typesense-adapter`
- ... more coming soon
Additional Wrapper adapters:
- [ReadWriteAdapter](../../packages/seal-read-write-adapter): `cmsig/seal-read-write-adapter`
- [MultiAdapter](../../packages/seal-multi-adapter): `cmsig/seal-multi-adapter`
Creating your own adapter? Add the [`seal-php-adapter`](https://github.com/topics/seal-php-adapter) Topic to your Github Repository.
## Configuration
The following code shows how to configure the package:
```yaml
# config/packages/cmsig_seal.yaml
cmsig_seal:
schemas:
app:
dir: '%kernel.project_dir%/config/schemas'
# engine: 'default'
engines:
default:
adapter: '%env(ENGINE_URL)%'
```
A more complex configuration can be here found:
```yaml
# config/packages/cmsig_seal.yaml
cmsig_seal:
schemas:
app:
dir: '%kernel.project_dir%/config/schemas/app'
other:
dir: '%kernel.project_dir%/config/schemas/other'
engine: algolia
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://[email protected]:6379'
solr:
adapter: 'solr://127.0.0.1:8983'
typesense:
adapter: 'typesense://[email protected]:8108'
# ...
multi:
adapter: 'multi://elasticsearch?adapters[]=opensearch'
read-write:
adapter: 'read-write://elasticsearch?write=multi'
index_name_prefix: ''
```
## Usage
The default engine is available as `Engine`:
```php
class Some {
public function __construct(
private readonly \CmsIg\Seal\EngineInterface $engine,
) {
}
}
```
A specific engine is available under the config key suffix with `Engine`:
```php
class Some {
public function __construct(
private readonly \CmsIg\Seal\EngineInterface $algoliaEngine,
) {
}
}
```
Multiple engines can be accessed via the `EngineRegistry`:
```php
class Some {
private Engine $engine;
public function __construct(
private readonly \CmsIg\Seal\EngineRegistry $engineRegistry,
) {
$this->engine = $this->engineRegistry->get('algolia');
}
}
```
How to create a `Schema` file and use your `Engine` can be found [SEAL Documentation](../../README.md#usage).
### Commands
The bundle provides the following commands:
**Create configured indexes**
```bash
bin/console cmsig:seal:index-create --help
```
**Drop configured indexes**
```bash
bin/console cmsig:seal:index-drop --help
```
**Reindex configured indexes**
```bash
bin/console cmsig:seal:reindex --help
```
## Authors
- [Alexander Schranz](https://github.com/alexander-schranz/)
- [The Community Contributors](https://github.com/php-cmsig/search/graphs/contributors)