public function Single::exposedFormAlter in Better Exposed Filters 8.4

Same name and namespace in other branches

1. 8.5 src/Plugin/better_exposed_filters/filter/Single.php \Drupal\better_exposed_filters\Plugin\better_exposed_filters\filter\Single::exposedFormAlter()

Manipulate views exposed from element.

Parameters

array $form: The views configuration form.

\Drupal\Core\Form\FormStateInterface $form_state: Form state.

Overrides FilterWidgetBase::exposedFormAlter

File

src/Plugin/better_exposed_filters/filter/Single.php, line 39

Class

Single

Single on/off widget implementation.

Namespace

Drupal\better_exposed_filters\Plugin\better_exposed_filters\filter

Code

public function exposedFormAlter(array &$form, FormStateInterface $form_state) {

  /** @var \Drupal\views\Plugin\views\filter\FilterPluginBase $filter */
  $filter = $this->handler;

  // Form element is designated by the element ID which is user-
  // configurable, and stored differently for grouped filters.
  $exposed_id = $filter->options['expose']['identifier'];
  $field_id = $this
    ->getExposedFilterFieldId();
  parent::exposedFormAlter($form, $form_state);
  if (!empty($form[$field_id])) {

    // Views populates missing values in $form_state['input'] with the
    // defaults and a checkbox does not appear in $_GET (or $_POST) so it
    // will appear to be missing when a user submits a form. Because of
    // this, instead of unchecking the checkbox value will revert to the
    // default. More, the default value for select values (i.e. 'Any') is
    // reused which results in the checkbox always checked.
    $input = $form_state
      ->getUserInput();

    // The input value ID is not always consistent.
    // Prioritize the field ID, but default to exposed ID.
    // @todo Remove $exposed_id once
    //   https://www.drupal.org/project/drupal/issues/288429 is fixed.
    $input_value = isset($input[$field_id]) ? $input[$field_id] : (isset($input[$exposed_id]) ? $input[$exposed_id] : NULL);
    $checked = FALSE;

    // We need to be super careful when working with raw input values. Let's
    // make sure the value exists in our list of possible options.
    if (in_array($input_value, array_keys($form[$field_id]['#options'])) && $input_value !== 'All') {
      $checked = (bool) $input_value;
    }
    $form[$field_id]['#type'] = 'checkbox';
    $form[$field_id]['#default_value'] = 0;
    $form[$field_id]['#return_value'] = 1;
    $form[$field_id]['#value'] = $checked ? 1 : 0;
  }
}