src/App/Form/Forms/SearchForm.php line 44

Open in your IDE?
  1. <?php
  3. namespace App\Form\Forms;
  5. use App\Model\Searching\AbstractSearch;
  6. use Products\SchoolNowBundle\Form\Type\SimpleSelectType;
  7. use Symfony\Component\Form\AbstractType;
  8. use Symfony\Component\Form\Extension\Core\Type\HiddenType;
  9. use Symfony\Component\Form\FormBuilderInterface;
  10. use Symfony\Component\Form\FormInterface;
  11. use Symfony\Component\Form\FormView;
  12. use Symfony\Component\OptionsResolver\OptionsResolver;
  14. /**
  15.  * Base search form that all other search forms should extend.
  16.  * NOTE: since this is a base class, be sure to call parent methods when overriding anything.
  17.  */
  18. abstract class SearchForm extends AbstractType
  19. {
  20.     /**
  21.      * Override to set a more appropriate search class type.
  22.      */
  23.     protected const DATA_CLASS = AbstractSearch::class;
  25.     /**
  26.      * {@inheritDoc}
  27.      */
  28.     public function buildForm(FormBuilderInterface $builder, array $options)
  29.     {
  30.         // form should have a search type assigned to it
  31.         $search = $builder->getData();
  32.         if ( ! $search instanceof AbstractSearch) {
  33.             throw new \Exception();
  34.         }
  36.         // all search forms will be get requests (so data comes across in url query string)
  37.         $builder->setMethod('GET');
  39.         // filters are not always used
  40.         if ($search::FILTERS) {
  41.             $builder->add('filter', SimpleSelectType::class, [
  42.                 'empty_data' => $search::FILTERS__DEFAULT,
  43.                 'choices' => $search::FILTERS,
  44.                 'choice_label' => function ($choice, $key, $value) use ($options) {
  45.                     if ($options['search_filters_label_format']) {
  46.                         return sprintf(
  47.                             $options['search_filters_label_format'],
  48.                             $value,
  49.                         );
  50.                     }
  51.                     return $value;
  52.                 },
  53.             ]);
  54.         }
  56.         // attach fields
  57.         $builder
  58.             ->add('sort', HiddenType::class, [
  59.                 'empty_data' => $search::SORTS__DEFAULT,
  60.             ])
  61.             ->add('direction', HiddenType::class, [
  62.                 'empty_data' => $search::DIRECTIONS[$search::SORTS__DEFAULT],
  63.             ])
  64.         ;
  65.     }
  67.     /**
  68.      * {@inheritDoc}
  69.      */
  70.     public function buildView(FormView $view, FormInterface $form, array $options)
  71.     {
  72.         // form should have a sort type assigned to it
  73.         $search = $form->getData();
  74.         if ( ! $search instanceof AbstractSearch) {
  75.             throw new \Exception();
  76.         }
  78.         // attach information about the sorting so that we can use it in templates
  79.         $view->vars['filters'] = $options['search_filters'];
  80.         $view->vars['sorts'] = $options['search_sorts'];
  81.         $view->vars['dirs'] = $search::DIRECTIONS;
  83.         // legacy
  84.         $view->vars['search_filters'] = $search::FILTERS;
  85.         $view->vars['search_sorts'] = $search::DIRECTIONS;
  86.     }
  88.     /**
  89.      * {@inheritDoc}
  90.      */
  91.     public function configureOptions(OptionsResolver $resolver)
  92.     {
  93.         $resolver->setDefaults([
  94.             'csrf_protection' => false,
  95.             'data_class' => static::DATA_CLASS,
  96.             'search_filters' => defined(static::DATA_CLASS . '::FILTERS') ? constant(static::DATA_CLASS . '::FILTERS') : [],
  97.             'search_sorts' => array_keys(defined(static::DATA_CLASS . '::DIRECTIONS') ? constant(static::DATA_CLASS . '::DIRECTIONS') : []),
  98.             'search_filters_label_format' => null,
  99.         ]);
  100.     }
  102.     /**
  103.      * {@inheritDoc}
  104.      */
  105.     public function getBlockPrefix(): string
  106.     {
  107.         // all search forms will use the same naming pattern
  108.         return 'query';
  109.     }
  110. }