public function ViewsBlockBase::buildConfigurationForm in Drupal 9

Same name and namespace in other branches

8 core/modules/views/src/Plugin/Block/ViewsBlockBase.php \Drupal\views\Plugin\Block\ViewsBlockBase::buildConfigurationForm()

Form constructor.

Plugin forms are embedded in other forms. In order to know where the plugin form is located in the parent form, #parents and #array_parents must be known, but these are not available during the initial build phase. In order to have these properties available when building the plugin form's elements, let this method return a form element that has a #process callback and build the rest of the form in the callback. By the time the callback is executed, the element's #parents and #array_parents properties will have been set by the form API. For more documentation on #parents and #array_parents, see \Drupal\Core\Render\Element\FormElement.

Parameters

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

\Drupal\Core\Form\FormStateInterface $form_state: The current state of the form. Calling code should pass on a subform state created through \Drupal\Core\Form\SubformState::createForSubform().

Return value

array The form structure.

Overrides BlockBase::buildConfigurationForm

File

core/modules/views/src/Plugin/Block/ViewsBlockBase.php, line 124

Class

ViewsBlockBase: Base class for Views block plugins.

Namespace

Drupal\views\Plugin\Block

Code

public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
  $form = parent::buildConfigurationForm($form, $form_state);

  // Set the default label to '' so the views internal title is used.
  $form['label']['#default_value'] = '';
  $form['label']['#access'] = FALSE;

  // Unset the machine_name provided by BlockForm.
  unset($form['id']['#machine_name']['source']);

  // Prevent users from changing the auto-generated block machine_name.
  $form['id']['#access'] = FALSE;
  $form['#pre_render'][] = '\\Drupal\\views\\Plugin\\views\\PluginBase::preRenderAddFieldsetMarkup';

  // Allow to override the label on the actual page.
  $form['views_label_checkbox'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Override title'),
    '#default_value' => !empty($this->configuration['views_label']),
  ];
  $form['views_label_fieldset'] = [
    '#type' => 'fieldset',
    '#states' => [
      'visible' => [
        [
          ':input[name="settings[views_label_checkbox]"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ],
  ];
  $form['views_label'] = [
    '#title' => $this
      ->t('Title'),
    '#type' => 'textfield',
    '#default_value' => $this->configuration['views_label'] ?: $this->view
      ->getTitle(),
    '#states' => [
      'visible' => [
        [
          ':input[name="settings[views_label_checkbox]"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ],
    '#fieldset' => 'views_label_fieldset',
  ];
  if ($this->view->storage
    ->access('edit') && \Drupal::moduleHandler()
    ->moduleExists('views_ui')) {
    $form['views_label']['#description'] = $this
      ->t('Changing the title here means it cannot be dynamically altered anymore. (Try changing it directly in <a href=":url">@name</a>.)', [
      ':url' => Url::fromRoute('entity.view.edit_display_form', [
        'view' => $this->view->storage
          ->id(),
        'display_id' => $this->displayID,
      ])
        ->toString(),
      '@name' => $this->view->storage
        ->label(),
    ]);
  }
  else {
    $form['views_label']['#description'] = $this
      ->t('Changing the title here means it cannot be dynamically altered anymore.');
  }
  return $form;
}

You are here