ViewsExposedForm::buildForm

public ViewsExposedForm::buildForm(array $form, FormStateInterface $form_state)

Form constructor.

Parameters

array $form: An associative array containing the structure of the form.

\Drupal\Core\Form\FormStateInterface $form_state: The current state of the form.

Return value

array The form structure.

Overrides FormInterface::buildForm

File

core/modules/views/src/Form/ViewsExposedForm.php, line 52

Class

ViewsExposedForm
Provides the views exposed form.

Namespace

Drupal\views\Form

Code

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
public function buildForm(array $form, FormStateInterface $form_state) {
  // Don't show the form when batch operations are in progress.
  if ($batch = batch_get() && isset($batch['current_set'])) {
    return array(
      // Set the theme callback to be nothing to avoid errors in template_preprocess_views_exposed_form().
      '#theme' => '',
    );
  }
 
  // Make sure that we validate because this form might be submitted
  // multiple times per page.
  $form_state->setValidationEnforced();
  /** @var \Drupal\views\ViewExecutable $view */
  $view = $form_state->get('view');
  $display = &$form_state->get('display');
 
  $form_state->setUserInput($view->getExposedInput());
 
  // Let form plugins know this is for exposed widgets.
  $form_state->set('exposed', TRUE);
  // Check if the form was already created
  if ($cache = $this->exposedFormCache->getForm($view->storage->id(), $view->current_display)) {
    return $cache;
  }
 
  $form['#info'] = array();
 
  // Go through each handler and let it generate its exposed widget.
  foreach ($view->display_handler->handlers as $type => $value) {
    /** @var \Drupal\views\Plugin\views\ViewsHandlerInterface $handler */
    foreach ($view->$type as $id => $handler) {
      if ($handler->canExpose() && $handler->isExposed()) {
        // Grouped exposed filters have their own forms.
        // Instead of render the standard exposed form, a new Select or
        // Radio form field is rendered with the available groups.
        // When an user choose an option the selected value is split
        // into the operator and value that the item represents.
        if ($handler->isAGroup()) {
          $handler->groupForm($form, $form_state);
          $id = $handler->options['group_info']['identifier'];
        }
        else {
          $handler->buildExposedForm($form, $form_state);
        }
        if ($info = $handler->exposedInfo()) {
          $form['#info']["$type-$id"] = $info;
        }
      }
    }
  }
 
  $form['actions'] = array(
    '#type' => 'actions'
  );
  $form['actions']['submit'] = array(
    // Prevent from showing up in \Drupal::request()->query.
    '#name' => '',
    '#type' => 'submit',
    '#value' => $this->t('Apply'),
    '#id' => Html::getUniqueId('edit-submit-' . $view->storage->id()),
  );
 
  $form['#action'] = $view->hasUrl() ? $view->getUrl()->toString() : Url::fromRoute('<current>')->toString();
  $form['#theme'] = $view->buildThemeFunctions('views_exposed_form');
  $form['#id'] = Html::cleanCssIdentifier('views_exposed_form-' . $view->storage->id() . '-' . $display['id']);
 
  /** @var \Drupal\views\Plugin\views\exposed_form\ExposedFormPluginInterface $exposed_form_plugin */
  $exposed_form_plugin = $view->display_handler->getPlugin('exposed_form');
  $exposed_form_plugin->exposedFormAlter($form, $form_state);
 
  // Save the form.
  $this->exposedFormCache->setForm($view->storage->id(), $view->current_display, $form);
 
  return $form;
}
doc_Drupal
2025-01-10 15:47:30
Comments
Leave a Comment

Please login to continue.