public function GroupContentMenu::buildConfigurationForm in Group Content Menu 8

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 GroupContentEnablerBase::buildConfigurationForm

File

src/Plugin/GroupContentEnabler/GroupContentMenu.php, line 74

Class

GroupContentMenu

Provides a content enabler for group menus.

Namespace

Drupal\group_content_menu\Plugin\GroupContentEnabler

Code

public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
  $form = parent::buildConfigurationForm($form, $form_state);
  $configuration = $this
    ->getConfiguration();

  // Disable the entity and group cardinality field as the functionality of
  // this module relies on a cardinality of 1. We don't just hide it, though,
  // to keep a UI that's consistent with other content enabler plugins.
  $info = $this
    ->t("This field has been disabled by the plugin to guarantee the functionality that's expected of it.");
  $form['group_cardinality']['#disabled'] = TRUE;
  $form['group_cardinality']['#description'] .= '<br /><em>' . $info . '</em>';
  $form['entity_cardinality']['#disabled'] = TRUE;
  $form['entity_cardinality']['#description'] .= '<br /><em>' . $info . '</em>';
  $form['auto_create_group_menu'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Automatically create a menu when a group is created.'),
    '#description' => $this
      ->t('The menu will be added to the new group as a group menu. The menu will be deleted when group is deleted.'),
    '#default_value' => $configuration['auto_create_group_menu'],
  ];
  $form['auto_create_home_link'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Automatically create a "Home" link for the menu.'),
    '#description' => $this
      ->t('The "Home" link will link to the canonical URL of the group.'),
    '#default_value' => $configuration['auto_create_home_link'],
    '#states' => [
      'visible' => [
        ':input[name="auto_create_group_menu"]' => [
          'checked' => TRUE,
        ],
      ],
    ],
  ];
  $form['auto_create_home_link_title'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Link title'),
    '#default_value' => $configuration['auto_create_home_link_title'],
    '#required' => TRUE,
    '#states' => [
      'visible' => [
        ':input[name="auto_create_home_link"]' => [
          'checked' => TRUE,
        ],
      ],
    ],
  ];
  return $form;
}