schranz-search / symfony-bundle
An integration of schranz-search search abstraction via a Bundle into the Symfony Framework.
Fund package maintenance!
alexander-schranz
paypal.me/L91
Installs: 12 415
Dependents: 2
Suggesters: 0
Security: 0
Stars: 8
Watchers: 3
Forks: 1
Type:symfony-bundle
Requires
- php: ^8.1
- schranz-search/seal: ^0.5
- symfony/config: ^6.1 || ^7.0
- symfony/console: ^6.1 || ^7.0
- symfony/dependency-injection: ^6.1 || ^7.0
- symfony/http-kernel: ^6.1 || ^7.0
Requires (Dev)
- php-cs-fixer/shim: ^3.51
- phpstan/extension-installer: ^1.2
- phpstan/phpstan: ^1.10
- phpstan/phpstan-phpunit: ^1.3
- phpunit/phpunit: ^10.3
- rector/rector: ^1.0
- schranz-search/seal-algolia-adapter: ^0.5
- schranz-search/seal-elasticsearch-adapter: ^0.5
- schranz-search/seal-loupe-adapter: ^0.5
- schranz-search/seal-meilisearch-adapter: ^0.5
- schranz-search/seal-memory-adapter: ^0.5
- schranz-search/seal-multi-adapter: ^0.5
- schranz-search/seal-opensearch-adapter: ^0.5
- schranz-search/seal-read-write-adapter: ^0.5
- schranz-search/seal-redisearch-adapter: ^0.5
- schranz-search/seal-solr-adapter: ^0.5
- schranz-search/seal-typesense-adapter: ^0.5
Conflicts
- schranz-search/seal-algolia-adapter: <0.5 || >=0.6
- schranz-search/seal-elasticsearch-adapter: <0.5 || >=0.6
- schranz-search/seal-loupe-adapter: <0.5 || >=0.6
- schranz-search/seal-meilisearch-adapter: <0.5 || >=0.6
- schranz-search/seal-memory-adapter: <0.5 || >=0.6
- schranz-search/seal-multi-adapter: <0.5 || >=0.6
- schranz-search/seal-opensearch-adapter: <0.5 || >=0.6
- schranz-search/seal-read-write-adapter: <0.5 || >=0.6
- schranz-search/seal-redisearch-adapter: <0.5 || >=0.6
- schranz-search/seal-solr-adapter: <0.5 || >=0.6
- schranz-search/seal-typesense-adapter: <0.5 || >=0.6
README
Logo created by Meine WilmaSEAL
Symfony Integration
Integration of the Schranz Search — Search Engine Abstraction Layer (SEAL) into Symfony.
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/symfony-bundle
Also install one of the listed adapters.
List of adapters
The following adapters are available:
- MemoryAdapter:
schranz-search/seal-memory-adapter
- ElasticsearchAdapter:
schranz-search/seal-elasticsearch-adapter
- OpensearchAdapter:
schranz-search/seal-opensearch-adapter
- MeilisearchAdapter:
schranz-search/seal-meilisearch-adapter
- AlgoliaAdapter:
schranz-search/seal-algolia-adapter
- SolrAdapter:
schranz-search/seal-solr-adapter
- RediSearchAdapter:
schranz-search/seal-redisearch-adapter
- TypesenseAdapter:
schranz-search/seal-typesense-adapter
- ... more coming soon
Additional Wrapper adapters:
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/schranz_search.yaml schranz_search: 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/schranz_search.yaml schranz_search: 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://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 \Schranz\Search\SEAL\EngineInterface $engine, ) { } }
A specific engine is available under the config key suffix with Engine
:
class Some { public function __construct( private readonly \Schranz\Search\SEAL\EngineInterface $algoliaEngine, ) { } }
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'); } }
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 schranz:search:index-create --help
Drop configured indexes
bin/console schranz:search:index-drop --help