kunstmaan/search-bundle

The KunstmaanSearchBundle works with ElasticSearch and supports different search providers. The bundle currently supports Elastica as a provider. Add your own objects to index using a tagged service which implements the SearchConfigurationInterface

7.1.2 2024-03-31 20:24 UTC

Requires

• php: ^8.1
• ruflin/elastica: ^7.0
• symfony/config: ^5.4|^6.4
• symfony/console: ^5.4|^6.4
• symfony/dependency-injection: ^5.4|^6.4
• symfony/framework-bundle: ^5.4|^6.4
• symfony/http-kernel: ^5.4|^6.4
• symfony/yaml: ^5.4|^6.4
• twig/extra-bundle: ^3.6
• twig/string-extra: ^3.6

Requires (Dev)

• matthiasnoback/symfony-config-test: ^4.2.1
• matthiasnoback/symfony-dependency-injection-test: ^4.2.1
• phpunit/phpunit: ^9.5.5
• symfony/phpunit-bridge: ^7.0

Suggests

• kunstmaan/search-bundle: ^7.0

MIT

• Kunstmaan CMS Team

• search
• elasticsearch
• kunstmaan

README

The KunstmaanSearchBundle works with ElasticSearch and supports different search providers.

• Add your own objects to index using a tagged service which implements the SearchConfigurationInterface
• Want to add another search provider ? It's easy, just add a tagged service which implements the SearchProviderInterface

More about these features can be found in our bundle documentation

Make sure you run ElasticSearch. You can download it here and extract the files. Then run the executable 'elasticsearch' in the bin directory.

Installation

composer.json

    "require": {
        "kunstmaan/search-bundle": "*"
    },

AppKernel.php:

    public function registerBundles()
    {
        $bundles = array(
            // ...
            new Kunstmaan\SearchBundle\KunstmaanSearchBundle(),
            // ...
        );

Configuration

Parameter

Add the following parameter to your parameters file (ini, yml, ...), the prefix will be automatically used before each indexname you specify.

 searchindexprefix: prefix_

Documentation

Further documentation on how to use and extend this bundle can be found here.

Reporting an issue or a feature request

Issues and feature requests are tracked in the Github issue tracker.

When reporting a bug, it may be a good idea to reproduce it in a basic project built using the Symfony Standard Edition to allow developers of the bundle to reproduce the issue by simply cloning it and following some steps.