samson/autocomplete-bundle

Easily integrate the Select2 autocomplete widget into your Symfony application to search Doctrine entities

README

Checkout SamsonIT/ShowCase to see a working example of how to use this bundle., _(*1)

How to install

Currently, you'll need to follow these steps to ensure the autocomplete will work:, _(*2)

• Enable this and the UnexpectedResponseBundle in your AppKernel

Example: https://github.com/SamsonIT/ShowCase/blob/master/app/AppKernel.php#L22, _(*3)

• Make sure the latest JQuery version is loaded (JQuery UI is not necessary)
• Make sure the latest Select2 javascript is loaded
• Make sure the latest Select2 css files are loaded and that the images bundled with it are in place
• Make sure the autocomplete.js file in this bundle is loaded
• Make sure the autocomplete.css file in this bundle is loaded (this one is not all that necessary)

An example of the above requirements can be found in https://github.com/SamsonIT/ShowCase/blob/master/src/Samson/Bundle/ShowCaseBundle/Resources/views/Autocomplete/index.html.twig, _(*4)

• Make sure the autocomplete.html.twig form theme is included into twig

Find an example here: https://github.com/SamsonIT/ShowCase/blob/master/app/config/config.yml#L24, _(*5)

How to use

Using the autocomplete is very simple. There are three required options to configure the Form type, and one recommended:, _(*6)

$form = $this->createForm('autocomplete', null, array(
  'class' => 'SomeEntityClass',
  'template' => 'Template to use to display the entity.html.twig',
  'search_fields' => array('list of fields to search in'),
  'query_builder' => function(EntityRepository $er) {
    return $er->createQueryBuilder('s');
  }
);

The template can be defined as follows:, _(*7)

{% if highlight %}
Found: {{ result.name|highlight }}
{% else %}
{{ result.name }}
{% endif %}

The highlight filter will simply do nothing if the highlight property is false, so this is also a valid template:, _(*8)

{{ result.name|highlight }}

Upgrade

See Upgrade.md, _(*9)