schranz-search / symfony-bundle
An integration of CMS-IG SEAL search abstraction into Symfony Framework.
Fund package maintenance!
alexander-schranz
paypal.me/L91
Installs: 15 585
Dependents: 0
Suggesters: 0
Security: 0
Stars: 15
Watchers: 2
Forks: 1
Type:symfony-bundle
pkg:composer/schranz-search/symfony-bundle
Requires
- php: ^8.1
- cmsig/seal: ^0.12
- symfony/config: ^6.1 || ^7.0 || ^8.0
- symfony/console: ^6.1 || ^7.0 || ^8.0
- symfony/dependency-injection: ^6.1 || ^7.0 || ^8.0
- symfony/http-kernel: ^6.1 || ^7.0 || ^8.0
Requires (Dev)
- cmsig/seal-algolia-adapter: ^0.12
- cmsig/seal-elasticsearch-adapter: ^0.12
- cmsig/seal-loupe-adapter: ^0.12
- cmsig/seal-meilisearch-adapter: ^0.12
- cmsig/seal-memory-adapter: ^0.12
- cmsig/seal-multi-adapter: ^0.12
- cmsig/seal-opensearch-adapter: ^0.12
- cmsig/seal-read-write-adapter: ^0.12
- cmsig/seal-redisearch-adapter: ^0.12
- cmsig/seal-solr-adapter: ^0.12
- cmsig/seal-typesense-adapter: ^0.12
- php-cs-fixer/shim: ^3.51
- phpstan/extension-installer: ^1.0
- phpstan/phpstan: ^2.0
- phpstan/phpstan-phpunit: ^2.0
- phpunit/phpunit: ^10.3
- rector/rector: ^2.0
Conflicts
- cmsig/seal-algolia-adapter: <0.12 || >=0.13
- cmsig/seal-elasticsearch-adapter: <0.12 || >=0.13
- cmsig/seal-loupe-adapter: <0.12 || >=0.13
- cmsig/seal-meilisearch-adapter: <0.12 || >=0.13
- cmsig/seal-memory-adapter: <0.12 || >=0.13
- cmsig/seal-multi-adapter: <0.12 || >=0.13
- cmsig/seal-opensearch-adapter: <0.12 || >=0.13
- cmsig/seal-read-write-adapter: <0.12 || >=0.13
- cmsig/seal-redisearch-adapter: <0.12 || >=0.13
- cmsig/seal-solr-adapter: <0.12 || >=0.13
- cmsig/seal-typesense-adapter: <0.12 || >=0.13
Replaces
- schranz-search/symfony-bundle: 0.12.8
README
Your feedback is important 📘Note: This is part of the
cmsig/searchproject create issues in the main repository.
Are you working with SEAL? Let us know! | Which Search Engines do you use and why?
SEAL
Symfony Integration
Integration of the CMS-IG — Search Engine Abstraction Layer (SEAL) into Symfony.
Note: This project is heavily under development and any feedback is greatly appreciated.
Installation
Use composer for install the package:
composer require cmsig/seal-symfony-bundle
Also install one of the listed adapters.
List of adapters
The following adapters are available:
- MemoryAdapter:
cmsig/seal-memory-adapter - ElasticsearchAdapter:
cmsig/seal-elasticsearch-adapter - OpensearchAdapter:
cmsig/seal-opensearch-adapter - MeilisearchAdapter:
cmsig/seal-meilisearch-adapter - AlgoliaAdapter:
cmsig/seal-algolia-adapter - LoupeAdapter:
cmsig/seal-loupe-adapter - SolrAdapter:
cmsig/seal-solr-adapter - RediSearchAdapter:
cmsig/seal-redisearch-adapter - TypesenseAdapter:
cmsig/seal-typesense-adapter - ... more coming soon
Additional Wrapper adapters:
- ReadWriteAdapter:
cmsig/seal-read-write-adapter - MultiAdapter:
cmsig/seal-multi-adapter
Creating your own adapter? Add the seal-php-adapter Topic to your GitHub Repository.
Configuration
The following code shows how to configure the package:
# 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:
# 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'
loupe:
adapter: 'loupe://var/indexes'
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: ''
Usage
The default engine is available as Engine:
class Some {
public function __construct(
private readonly \CmsIg\Seal\EngineInterface $engine,
) {
}
}
A specific engine is available under the config key suffix with Engine:
class Some {
public function __construct(
private readonly \CmsIg\Seal\EngineInterface $algoliaEngine,
) {
}
}
Multiple engines can be accessed via the EngineRegistry:
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.
Commands
The bundle provides the following commands:
Create configured indexes
bin/console cmsig:seal:index-create --help
Drop configured indexes
bin/console cmsig:seal:index-drop --help
Reindex configured indexes
bin/console cmsig:seal:reindex --help