This is a Symfony bundle which enables the popular Select2 component to be used as a drop-in replacement for a standard entity, document and choice fields on a Symfony form.
The main feature of this bundle is that the list of choices is retrieved via a remote ajax call.
Add the sirian/suggest-bundle package to your require section in the composer.json file.
$ composer require sirian/suggest-bundleAdd the SuggestBundle to your application's kernel:
<?php
public function registerBundles()
{
$bundles = array(
// ...
new Sirian\SuggestBundle\SirianSuggestBundle(),
// ...
);
...
}After installing the bundle, make sure you add this route to your routing:
# app/config/routing.yml
_sirian_suggest:
resource: "@SirianSuggestBundle/Resources/config/routing.yml"
prefix: /suggestAnd choose default widget for form (depends on select2 version you use). One of select2_v3, select2_v4. You could also specify other default form options for SuggestType::class
# app/config/config.yml
...
sirian_suggest:
form_options:
widget: select2_v4
attr:
placeholder: "Search..."# app/config/config.yml
...
sirian_suggest:
odm:
category:
class: "MainBundle:Category"
property: name
user:
class: "MainBundle:User"
property: username
search:
email: ~
username: ~# app/config/config.yml
...
sirian_suggest:
orm:
category:
class: "MainBundle:Category"
property: name
user:
class: "MainBundle:User"
property: username
search:
email: ~
username: ~When you need some additional logic - you could create your own suggester. For example let's create AdminSuggester which suggests only users having ROLE_ADMIN role
<?php
namespace App\MainBundle\Suggest;
use App\MainBundle\Document\User;
use Doctrine\Common\Persistence\ManagerRegistry;
use Sirian\SuggestBundle\Suggest\DocumentSuggester;
use Sirian\SuggestBundle\Suggest\Item;
use Sirian\SuggestBundle\Suggest\SuggestQuery;
class AdminSuggester extends DocumentSuggester
{
public function __construct(ManagerRegistry $registry)
{
$options = [
'class' => User::class,
'id_property' => 'id',
'property' => 'username',
'search' => [
'name' => DocumentSuggester::SEARCH_MIDDLE,
'username' => DocumentSuggester::SEARCH_MIDDLE,
'email' => DocumentSuggester::SEARCH_MIDDLE
]
];
parent::__construct($registry, $options);
}
protected function createSuggestQueryBuilder(SuggestQuery $query)
{
$qb = parent::createSuggestQueryBuilder($query);
$qb->field('roles')->equals('ROLE_ADMIN');
return $qb;
}
protected function transformObject($user)
{
$item = new Item();
$item->id = $user->getId();
$item->text = $user->getName() . ' ( ' . $user->getUsername() . ', ' . $user->getEmail() . ')';
return $item;
}
}
Define service services.yml with sirian_suggest.suggester tag
app.suggester.admin:
class: App\MainBundle\Suggest\AdminSuggester
arguments: ["@doctrine_mongodb"]
tags:
- {name: 'sirian_suggest.suggester', alias: 'admin'}Alias admin will be used in suggester option for SuggestType::class and in /suggest/admin url pattern.
Now you can use configured suggesters in forms
$formBuilder->add('category', SuggestType::class, [
'suggester' => 'category'
])You could restrict access to suggesters by securing URL patterns
security:
...
access_control:
...
- { path: ^/suggest/category, roles: ROLE_USER }
- { path: ^/suggest, roles: ROLE_ADMIN }Sometimes you need to pass additional parameters to Suggester.
Let's start with simple example. You have brands and models and you want to display only models for one specific brand.
Create class ModelSuggester
<?php
namespace App\MainBundle\Suggest;
use App\MainBundle\Document\Model;
use Doctrine\Common\Persistence\ManagerRegistry;
use Sirian\SuggestBundle\Suggest\DocumentSuggester;
use Sirian\SuggestBundle\Suggest\SuggestQuery;
class ModelSuggester extends DocumentSuggester
{
public function __construct(ManagerRegistry $registry)
{
$options = [
'class' => Model::class,
'id_property' => 'id',
'property' => 'name',
];
parent::__construct($registry, $options);
}
protected function createSuggestQueryBuilder(SuggestQuery $query)
{
$qb = parent::createSuggestQueryBuilder($query);
$brandId = $query->extra['brand_id'];
$qb->field('brand')->equals($brandId);
return $qb;
}
}Define service
app.suggester.model:
class: App\MainBundle\Suggest\ModelSuggester
arguments: ["@doctrine_mongodb"]
tags:
- {name: 'sirian_suggest.suggester', alias: 'model'}and add extra option to form options:
$formBuilder->add('model', SuggestType::class, [
'suggester' => 'model',
'extra' => [
'brand_id' => 123
]
])Now let's see an example when you have 2 suggest fields brand and model and in second select you want to display models for selected brand.
You need to create ModelSuggester and define suggester service (like in previous section).
And then customize form widget to pass brand_id extra option to suggester
{% block _form_model_widget %}
{{ form_widget(form) }}
<script>
(function () {
// get prepared options for select2
var options = $('#{{ id }}').data('suggest-options');
// update ajax.data option
options.ajax.data = function (term, page) {
return {
q: term,
page: page,
extra: {
brand_id: $('#form_brand').val() // get brand_id from another select
}
}
}
}());
</script>
{% endblock %}