feature #478 [Autocomplete] implement max_results option (DarrHeLL)

This PR was squashed before being merged into the 2.x branch.

Discussion
----------

[Autocomplete] implement max_results option

| Q             | A
| ------------- | ---
| Bug fix?      | no
| New feature?  | yes
| Tickets       |N/A
| License       | MIT

Added max_results option in formType options to control the results number returned by a query on automatic endpoint.

Commits
-------

289463d [Autocomplete] implement max_results option

Author: weaverryan

src/Autocomplete/src/Form/AutocompleteChoiceTypeExtension.php

@@ -67,6 +67,10 @@ public function finishView(FormView $view, FormInterface $form, array $options)
             $values['tom-select-options'] = json_encode($options['tom_select_options']);
         }
 
+        if ($options['max_results']) {
+            $values['max-results'] = $options['max_results'];
+        }
+
         $values['no-results-found-text'] = $this->trans($options['no_results_found_text']);
         $values['no-more-results-text'] = $this->trans($options['no_more_results_text']);
 
@@ -87,6 +91,7 @@ public function configureOptions(OptionsResolver $resolver)
             'allow_options_create' => false,
             'no_results_found_text' => 'No results found',
             'no_more_results_text' => 'No more results',
+            'max_results' => 10,
         ]);
 
         // if autocomplete_url is passed, then HTML options are already supported

src/Autocomplete/src/Form/AutocompleteEntityTypeSubscriber.php

@@ -39,7 +39,7 @@ public function preSetData(FormEvent $event)
         // pass to AutocompleteChoiceTypeExtension
         $options['autocomplete'] = true;
         $options['autocomplete_url'] = $this->autocompleteUrl;
-        unset($options['searchable_fields'], $options['security'], $options['filter_query']);
+        unset($options['searchable_fields'], $options['security'], $options['filter_query'], $options['max_results']);
 
         $form->add('autocomplete', EntityType::class, $options);
     }

src/Autocomplete/src/Form/ParentEntityAutocompleteType.php

@@ -76,10 +76,13 @@ public function configureOptions(OptionsResolver $resolver)
             // set to the string role that's required to view the autocomplete results
             // or a callable: function(Symfony\Component\Security\Core\Security $security): bool
             'security' => false,
+            // set the max results number that a query on automatic endpoint return.
+            'max_results' => 10,
         ]);
 
         $resolver->setRequired(['class']);
         $resolver->setAllowedTypes('security', ['boolean', 'string', 'callable']);
+        $resolver->setAllowedTypes('max_results', ['int', 'null']);
         $resolver->setAllowedTypes('filter_query', ['callable', 'null']);
         $resolver->setNormalizer('searchable_fields', function (Options $options, ?array $searchableFields) {
             if (null !== $searchableFields && null !== $options['filter_query']) {

src/Autocomplete/src/Form/WrappedEntityTypeAutocompleter.php

@@ -54,6 +54,9 @@ public function createFilteredQueryBuilder(EntityRepository $repository, string
             return $queryBuilder;
         }
 
+        // Applying max result limit or not
+        $queryBuilder->setMaxResults($this->getMaxResults());
+
         $this->entitySearchUtil->addSearchClause(
             $queryBuilder,
             $query,
@@ -131,6 +134,11 @@ private function getFilterQuery(): ?callable
         return $this->getForm()->getConfig()->getOption('filter_query');
     }
 
+    private function getMaxResults(): ?int
+    {
+        return $this->getForm()->getConfig()->getOption('max_results');
+    }
+
     private function getEntityMetadata(): EntityMetadata
     {
         if (null === $this->entityMetadata) {

src/Autocomplete/src/Resources/doc/index.rst

@@ -260,6 +260,8 @@ to the options above, you can also pass:
             $qb->andWhere('entity.name LIKE :filter OR entity.description LIKE :filter')
                 ->setParameter('filter', '%'.$query.'%');
         }
+``max_results`` (default: 10)
+    Allow you to control the max number of results returned by the automatic autocomplete endpoint.
 
 Using with a TextType Field
 ---------------------------

src/Autocomplete/tests/Fixtures/Form/CategoryAutocompleteType.php

@@ -41,6 +41,7 @@ public function configureOptions(OptionsResolver $resolver)
             'attr' => [
                 'data-controller' => 'custom-autocomplete',
             ],
+            'max_results' => 5,
         ]);
     }
 

src/Autocomplete/tests/Functional/FieldAutocompleterTest.php

@@ -78,4 +78,16 @@ public function testItEnforcesSecurity(): void
             ->assertJsonMatches('length(results)', 3)
         ;
     }
+
+    public function testItCheckMaxResultsOption() : void
+    {
+        CategoryFactory::createMany(30, ['name' => 'foo']);
+
+        $this->browser()
+            ->throwExceptions()
+            ->get('/test/autocomplete/category_autocomplete_type?query=foo')
+            ->assertSuccessful()
+            ->assertJsonMatches('length(results)', 5)
+        ;
+    }
 }