public function ViewsMenuLinkForm::buildConfigurationForm in Drupal 8

Same name and namespace in other branches

1. 9 core/modules/views/src/Plugin/Menu/Form/ViewsMenuLinkForm.php \Drupal\views\Plugin\Menu\Form\ViewsMenuLinkForm::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 MenuLinkDefaultForm::buildConfigurationForm

File

core/modules/views/src/Plugin/Menu/Form/ViewsMenuLinkForm.php, line 29

Class

ViewsMenuLinkForm

Provides a form to edit Views menu links.

Namespace

Drupal\views\Plugin\Menu\Form

Code

public function buildConfigurationForm(array $form, FormStateInterface $form_state) {

  // Put the title field first.
  $form['title'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Title'),
    // @todo Ensure that the view is not loaded with a localized title.
    //   https://www.drupal.org/node/2309507
    '#default_value' => $this->menuLink
      ->getTitle(),
    '#weight' => -10,
  ];
  $form['description'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Description'),
    '#description' => $this
      ->t('Shown when hovering over the menu link.'),
    // @todo Ensure that the view is not loaded with a localized description.
    //   https://www.drupal.org/node/2309507
    '#default_value' => $this->menuLink
      ->getDescription(),
    '#weight' => -5,
  ];
  $form += parent::buildConfigurationForm($form, $form_state);
  $form['info']['#weight'] = -8;
  $form['path']['#weight'] = -7;
  $view = $this->menuLink
    ->loadView();
  $id = $view->storage
    ->id();
  $label = $view->storage
    ->label();
  if ($this->moduleHandler
    ->moduleExists('views_ui')) {
    $message = $this
      ->t('This link is provided by the Views module. The path can be changed by editing the view <a href=":url">@label</a>', [
      ':url' => Url::fromRoute('entity.view.edit_form', [
        'view' => $id,
      ])
        ->toString(),
      '@label' => $label,
    ]);
  }
  else {
    $message = $this
      ->t('This link is provided by the Views module from view %label.', [
      '%label' => $label,
    ]);
  }
  $form['info']['#title'] = $message;
  return $form;
}