public function SitemapSettingsForm::buildForm in Sitemap 2.0.x

Same name and namespace in other branches

1. 8.2 src/Form/SitemapSettingsForm.php \Drupal\sitemap\Form\SitemapSettingsForm::buildForm()
2. 8 src/Form/SitemapSettingsForm.php \Drupal\sitemap\Form\SitemapSettingsForm::buildForm()

Form constructor.

Parameters

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

\Drupal\Core\Form\FormStateInterface $form_state: The current state of the form.

Return value

array The form structure.

Overrides ConfigFormBase::buildForm

File

src/Form/SitemapSettingsForm.php, line 66

Class

SitemapSettingsForm

Provides a configuration form for sitemap.

Namespace

Drupal\sitemap\Form

Code

public function buildForm(array $form, FormStateInterface $form_state) {
  $config = $this->configFactory
    ->get('sitemap.settings');
  $form['page_title'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Page title'),
    '#default_value' => $config
      ->get('page_title'),
    '#description' => $this
      ->t('Page title that will be used on the @sitemap_page.', [
      '@sitemap_page' => Link::fromTextAndUrl($this
        ->t('sitemap page'), Url::fromRoute('sitemap.page'))
        ->toString(),
    ]),
  ];
  $sitemap_message = $config
    ->get('message');
  $form['message'] = [
    '#type' => 'text_format',
    '#format' => isset($sitemap_message['format']) ? $sitemap_message['format'] : NULL,
    '#title' => $this
      ->t('Sitemap message'),
    '#default_value' => $sitemap_message['value'],
    '#description' => $this
      ->t('Define a message to be displayed above the sitemap.'),
  ];

  // Retrieve stored configuration for the plugins.
  $plugins = $config
    ->get('plugins');
  $plugin_config = [];

  // Create plugin instances for all available Sitemap plugins, including both
  // enabled/configured ones as well as new and not yet configured ones.
  $definitions = $this->sitemapManager
    ->getDefinitions();
  foreach ($definitions as $id => $definition) {
    if ($this->sitemapManager
      ->hasDefinition($id)) {
      if (!empty($plugins[$id])) {
        $plugin_config = $plugins[$id];
      }
      $this->plugins[$id] = $this->sitemapManager
        ->createInstance($id, $plugin_config);
    }
  }

  // Plugin status.
  $form['plugins']['enabled'] = [
    '#type' => 'item',
    '#title' => $this
      ->t('Enabled plugins'),
    '#prefix' => '<div id="sitemap-enabled-wrapper">',
    '#suffix' => '</div>',
    // This item is used as a pure wrapping container with heading. Ignore its
    // value, since 'plugins' should only contain plugin definitions.
    // See https://www.drupal.org/node/1829202.
    '#input' => FALSE,
  ];

  // Plugin order (tabledrag).
  $form['plugins']['order'] = [
    '#type' => 'table',
    // For sitemap.admin.js.
    '#attributes' => [
      'id' => 'sitemap-order',
    ],
    '#title' => $this
      ->t('Plugin display order'),
    '#tabledrag' => [
      [
        'action' => 'order',
        'relationship' => 'sibling',
        'group' => 'plugin-order-weight',
      ],
    ],
    '#tree' => FALSE,
    '#input' => FALSE,
    '#theme_wrappers' => [
      'form_element',
    ],
  ];

  // Map settings.
  $form['plugin_settings'] = [
    '#type' => 'vertical_tabs',
    '#title' => $this
      ->t('Plugin settings'),
  ];
  $defaultSort = $this->plugins;
  $sorted = $this
    ->sortPlugins($this->plugins);
  foreach ($sorted as $id => $plugin) {

    /* @var $plugin \Drupal\sitemap\SitemapBase */
    $form['plugins']['enabled'][$id] = [
      '#type' => 'checkbox',
      '#title' => $plugin
        ->getLabel(),
      '#default_value' => $plugin->enabled,
      '#parents' => [
        'plugins',
        $id,
        'enabled',
      ],
      '#description' => $plugin
        ->getDescription(),
      // Default sort groups by plugin type.
      '#weight' => $defaultSort[$id]->weight,
    ];
    $form['plugins']['order'][$id]['#attributes']['class'][] = 'draggable';
    $form['plugins']['order'][$id]['#weight'] = $plugin->weight;
    $form['plugins']['order'][$id]['filter'] = [
      '#markup' => $plugin
        ->getLabel(),
    ];
    $form['plugins']['order'][$id]['weight'] = [
      '#type' => 'weight',
      '#title' => $this
        ->t('Weight for @title', [
        '@title' => $plugin
          ->getLabel(),
      ]),
      '#title_display' => 'invisible',
      '#delta' => 50,
      '#default_value' => $plugin->weight,
      '#parents' => [
        'plugins',
        $id,
        'weight',
      ],
      '#attributes' => [
        'class' => [
          'plugin-order-weight',
        ],
      ],
    ];

    // Retrieve the settings form of the Sitemap plugin.
    $settings_form = [
      '#parents' => [
        'plugins',
        $id,
        'settings',
      ],
      '#tree' => TRUE,
    ];
    $settings_form = $plugin
      ->settingsForm($settings_form, $form_state);
    if (!empty($settings_form)) {
      $form['plugins']['settings'][$id] = [
        '#type' => 'details',
        '#title' => $plugin
          ->getLabel(),
        '#open' => TRUE,
        '#weight' => $plugin->weight,
        '#parents' => [
          'plugins',
          $id,
          'settings',
        ],
        '#group' => 'plugin_settings',
      ];
      $form['plugins']['settings'][$id] += $settings_form;
    }
  }
  $form['#attached']['library'][] = 'sitemap/sitemap.admin';

  // Sitemap CSS settings.
  $form['css'] = [
    '#type' => 'details',
    '#title' => $this
      ->t('CSS settings'),
  ];
  $form['css']['include_css'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Include sitemap CSS file'),
    '#default_value' => $config
      ->get('include_css'),
    '#description' => $this
      ->t("Select this box if you wish to load the CSS file included with the module. To learn how to override or specify the CSS at the theme level, visit the @documentation_page.", [
      '@documentation_page' => Link::fromTextAndUrl($this
        ->t("documentation page"), Url::fromUri('https://www.drupal.org/node/2615568'))
        ->toString(),
    ]),
  ];
  return parent::buildForm($form, $form_state);
}