Merge pull request tetranz#84 from n3o77/master

Allow to add the values from dependent fields

Author: tetranz

Form/Type/Select2EntityType.php

@@ -13,6 +13,7 @@
 use Symfony\Component\Routing\RouterInterface;
 use Tetranz\Select2EntityBundle\Form\DataTransformer\EntitiesToPropertyTransformer;
 use Tetranz\Select2EntityBundle\Form\DataTransformer\EntityToPropertyTransformer;
+use Symfony\Component\PropertyAccess\PropertyAccess;
 
 /**
  *
@@ -94,6 +95,17 @@ public function finishView(FormView $view, FormInterface $form, array $options)
             $view->vars[$varName] = $options[$varName];
         }
 
+        if (isset($options['req_params']) && is_array($options['req_params']) && count($options['req_params']) > 0) {
+            $accessor = PropertyAccess::createPropertyAccessor();
+
+            $reqParams = [];
+            foreach ($options['req_params'] as $key => $reqParam) {
+                $reqParams[$key] = $accessor->getValue($view,  $reqParam . '.vars[full_name]');
+            }
+
+            $view->vars['attr']['data-req_params'] = json_encode($reqParams);
+        }
+
         //tags options
         $varNames = array_keys($this->config['allow_add']);
         foreach ($varNames as $varName) {
@@ -154,6 +166,9 @@ public function configureOptions(OptionsResolver $resolver)
                 'transformer' => null,
                 'autostart' => true,
                 'width' => isset($this->config['width']) ? $this->config['width'] : null,
+                'req_params' => array(),
+                'property' => null,
+                'callback' => null,
             )
         );
     }

README.md

@@ -241,6 +241,88 @@ $builder
     ]);
 ```
 
+### Including other field values in request
+
+If you need to include other field values because the selection depends on it you can add the `req_params` option.
+The key is the name of the parameter in the query string, the value is the path in the FormView (if you don't know the path you can do something like `{{ dump(form) }}` in your template.) 
+
+The `property` option refers to your entity field which is used for the label as well as for the search term.
+
+In the callback you get the QueryBuilder to modify the result query and the data object as parameter (data can be a simple Request object or a plain array. See AutocompleteService.php for more details). 
+
+```php
+$builder
+    ->add('firstName', TextType::class)
+        ->add('lastName', TextType::class)
+        ->add('state', EntityType::class, array('class' => State::class))
+        ->add('county', Select2EntityType::class, [
+            'required' => true,
+            'multiple' => false,
+            'remote_route' => 'ajax_autocomplete',
+            'class' => County::class,
+            'minimum_input_length' => 0,
+            'page_limit' => 10,
+            'scroll' => true,
+            'allow_clear' => false,
+            'req_params' => ['state' => 'parent.children[state]'],
+            'property' => 'name',
+            'callback'    => function (QueryBuilder $qb, $data) {
+                $qb->andWhere('e.state = :state');
+
+                if ($data instanceof Request) {
+                    $qb->setParameter('state', $data->get('state'));
+                } else {
+                    $qb->setParameter('state', $data['state']);
+                }
+
+            },
+        ])
+    ->add('city', Select2EntityType::class, [
+        'required' => true,
+        'multiple' => false,
+        'remote_route' => 'ajax_autocomplete',
+        'class' => City::class,
+        'minimum_input_length' => 0,
+        'page_limit' => 10,
+        'scroll' => true,
+        'allow_clear' => false,
+        'req_params' => ['county' => 'parent.children[county]'],
+        'property' => 'name',
+        'callback'    => function (QueryBuilder $qb, $data) {
+            $qb->andWhere('e.county = :county');
+
+            if ($data instanceof Request) {
+                $qb->setParameter('county', $data->get('county'));
+            } else {
+                $qb->setParameter('county', $data['county']);
+            }
+
+        },
+    ]);
+``` 
+
+Because the handling of requests is usually very similar you can use a service which helps you with your results. To use it just add a route in one of your controllers:
+
+```php
+    /**
+     * @param Request $request
+     *
+     * @Route("/autocomplete", name="ajax_autocomplete")
+     *
+     * @return Response
+     */
+    public function autocompleteAction(Request $request)
+    {
+        // Check security etc. if needed
+    
+        $as = $this->get('tetranz_select2entity.autocomplete_service');
+
+        $result = $as->getAutocompleteResults($request, YourFormType::class);
+
+        return new JsonResponse($result);
+    }
+```
+
 
 ### Templating
 

Resources/config/services.xml

@@ -11,6 +11,9 @@
             <argument type="service" id="router" />
             <argument>%tetranz_select2_entity.config%</argument>
         </service>
+        <service id="tetranz_select2entity.autocomplete_service" class="Tetranz\Select2EntityBundle\Service\AutocompleteService">
+            <argument type="service" id="service_container" />
+        </service>
     </services>
 
 </container>

Resources/public/js/select2entity.js

@@ -10,6 +10,17 @@
                 scroll = $s2.data('scroll'),
                 prefix = Date.now(),
                 cache = [];
+
+            var reqParams = $s2.data('req_params');
+            if (reqParams) {
+                $.each(reqParams, function (key, value) {
+                    $('*[name="'+value+'"]').on('change', function () {
+                        $s2.val(null);
+                        $s2.trigger('change');
+                    });
+                });
+            }
+
             // Deep-merge the options
             $s2.select2($.extend(true, {
                 // Tags support
@@ -50,17 +61,24 @@
                         }
                     },
                     data: function (params) {
+                        var ret = {
+                            'q': params.term,
+                            'field_name': $s2.data('name')
+                        };
+
+                        var reqParams = $s2.data('req_params');
+                        if (reqParams) {
+                            $.each(reqParams, function (key, value) {
+                                ret[key] = $('*[name="'+value+'"]').val()
+                            });
+                        }
+
                         // only send the 'page' parameter if scrolling is enabled
                         if (scroll) {
-                            return {
-                                q: params.term,
-                                page: params.page || 1
-                            };
+                            ret['page'] = params.page || 1;
                         }
 
-                        return {
-                            q: params.term
-                        };
+                        return ret;
                     },
                     processResults: function (data, params) {
                         var results, more = false, response = {};

Resources/views/Form/fields.html.twig

@@ -11,7 +11,8 @@
     'data-page-limit':page_limit,
     'data-scroll':scroll ? 'true' : 'false',
     'data-autostart':autostart ? 'true' : 'false',
-    'class' : (attr.class|default('') ~ ' select2entity form-control')|trim
+    'class' : (attr.class|default('') ~ ' select2entity form-control')|trim,
+    'data-name' : name|e('html_attr')
     }) %}
 
     {% if allow_add.enabled %}

Service/AutocompleteService.php

@@ -0,0 +1,78 @@
+<?php
+
+namespace Tetranz\Select2EntityBundle\Service;
+
+use Doctrine\ORM\EntityRepository;
+use Symfony\Component\DependencyInjection\ContainerAwareInterface;
+use Symfony\Component\DependencyInjection\ContainerAwareTrait;
+use Symfony\Component\DependencyInjection\ContainerInterface;
+use Symfony\Component\Form\FormTypeInterface;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\PropertyAccess\PropertyAccess;
+
+class AutocompleteService implements ContainerAwareInterface
+{
+    use ContainerAwareTrait;
+
+
+    public function __construct(ContainerInterface $container)
+    {
+        $this->setContainer($container);
+    }
+
+    /**
+     * @param Request                  $request
+     * @param string|FormTypeInterface $type
+     *
+     * @return array
+     */
+    public function getAutocompleteResults(Request $request, $type)
+    {
+        $form = $this->container->get('form.factory')->create($type);
+        $fieldOptions = $form->get($request->get('field_name'))->getConfig()->getOptions();
+
+        /** @var EntityRepository $repo */
+        $repo = $this->container->get('doctrine')->getRepository($fieldOptions['class']);
+
+        $term = $request->get('q');
+
+        $countQB = $repo->createQueryBuilder('e');
+        $countQB
+            ->select($countQB->expr()->count('e'))
+            ->where('e.'.$fieldOptions['property'].' LIKE :term')
+            ->setParameter('term', '%' . $term . '%')
+        ;
+
+        $maxResults = $fieldOptions['page_limit'];
+        $offset = ($request->get('page', 1) - 1) * $maxResults;
+
+        $resultQb = $repo->createQueryBuilder('e');
+        $resultQb
+            ->where('e.'.$fieldOptions['property'].' LIKE :term')
+            ->setParameter('term', '%' . $term . '%')
+            ->setMaxResults($maxResults)
+            ->setFirstResult($offset)
+        ;
+
+
+        if (array_key_exists('callback', $fieldOptions)) {
+            $cb = $fieldOptions['callback'];
+
+            $cb($countQB, $request);
+            $cb($resultQb, $request);
+        }
+
+        $count = $countQB->getQuery()->getSingleScalarResult();
+        $paginationResults = $resultQb->getQuery()->getResult();
+
+        $result = ['results' => null, 'more' => $count > ($offset + $maxResults)];
+
+        $accessor = PropertyAccess::createPropertyAccessor();
+
+        $result['results'] = array_map(function ($item) use ($accessor, $fieldOptions) {
+            return ['id' => $accessor->getValue($item, $fieldOptions['primary_key']), 'text' => $accessor->getValue($item, $fieldOptions['property'])];
+        }, $paginationResults);
+
+        return $result;
+    }
+}