function HandlerBase::buildOptionsForm

Overrides PluginBase::buildOptionsForm

File

core/modules/views/src/Plugin/views/HandlerBase.php, line 263

Class

HandlerBase

Base class for Views handler plugins.

Namespace

Code

public function buildOptionsForm(&$form, FormStateInterface $form_state) {
  // Some form elements belong in a fieldset for presentation, but can't
  // be moved into one because of the $form_state->getValues() hierarchy. Those
  // elements can add a #fieldset => 'fieldset_name' property, and they'll
  // be moved to their fieldset during pre_render.
  $form['#pre_render'][] = [
    static::class,
    'preRenderAddFieldsetMarkup',
  ];
  parent::buildOptionsForm($form, $form_state);
  $form['fieldsets'] = [
    '#type' => 'value',
    '#value' => [
      'more',
      'admin_label',
    ],
  ];
  $form['admin_label'] = [
    '#type' => 'details',
    '#title' => $this->t('Administrative title'),
    '#weight' => 150,
  ];
  $form['admin_label']['admin_label'] = [
    '#type' => 'textfield',
    '#title' => $this->t('Administrative title'),
    '#description' => $this->t('This title will be displayed on the views edit page instead of the default one. This might be useful if you have the same item twice.'),
    '#default_value' => $this->options['admin_label'],
    '#parents' => [
      'options',
      'admin_label',
    ],
  ];
  // This form is long and messy enough that the "Administrative title" option
  // belongs in "Administrative title" fieldset at the bottom of the form.
  $form['more'] = [
    '#type' => 'details',
    '#title' => $this->t('More'),
    '#weight' => 200,
    '#optional' => TRUE,
  ];
  // Allow to alter the default values brought into the form.
  // @todo Do we really want to keep this hook.
  $this->getModuleHandler()
    ->alter('views_handler_options', $this->options, $this->view);
}