victoire/search-widget

Victoire Search widget

Installs: 1 351

Dependents: 0

Suggesters: 0

Security: 0

Stars: 5

Watchers: 13

Forks: 5

Open Issues: 7

Type:symfony-bundle

2.0.6 2018-08-01 17:32 UTC

This package is auto-updated.

Last update: 2020-06-18 17:37:21 UTC


README

CircleCI

Victoire Search Bundle

What is the purpose of this bundle

This bundles gives you access to the Search Widget which is a search bar that can find any text.

It works with elastica and searches automatically in every searchable widget (thanks to the widget's embedded configuration). You place an emitter spot (i.e : the search bar) and define the result page where you'll place a receiver spot.

Specific search within BusinessEntities

If you want to search your BusinessEntities, you'll have to define your own configuration for your BusinessEntities:

fos_elastica:
    clients:
        default: { host: 127.0.0.1, port: 9200 }
    serializer:
        callback_class: FOS\ElasticaBundle\Serializer\Callback
        serializer: serializer
    indexes:
        # Widgets are automatically indexed by using 'victoire_search_widgets_index' parameter
        # You can override Widgets indexation configuration
        widgets: %victoire_search_widgets_index%
        # Pages are automatically indexed by using 'victoire_search_pages_index' parameter
        # You can override Pages indexation configuration
        pages: %victoire_search_pages_index%
        # You need to define the business entities you wish to index here
        business:
            types:
                Jedi:
                    serializer:
                        groups: [search]
                    mappings:
                        title: ~
                        city: ~
                        description: ~
                        contractType: ~
                        subtitle: ~
                    persistence:
                        driver: orm
                        model:  Acme\DemoBundle\Entity\Jedi
                        provider: ~
                        listener: ~
                        finder: ~

Initialize elasticsearch mapping

In order to have a relevant elasticsearch mapping, you need to run the following command before running any query:

console fos:elastica:reset

Set Up Victoire

If you haven't already, you can follow the steps to set up Victoire here

Install the bundle

Run the following composer command :

php composer.phar require victoire/search-widget

Reminder

Do not forget to add the bundle in your AppKernel !

    class AppKernel extends Kernel
    {
        public function registerBundles()
        {
            $bundles = array(
                ...
                new Victoire\Widget\SearchBundle\VictoireWidgetSearchBundle(),
                new FOS\ElasticaBundle\FOSElasticaBundle(),
            );

            return $bundles;
        }
    }