You are here

Home » API reference » Simple XML sitemap 8.2 » SimplesitemapSettingsForm.php » SimplesitemapSettingsForm

public function SimplesitemapSettingsForm::buildForm in Simple XML sitemap 8.2

Same name and namespace in other branches
  1. 8.3 src/Form/SimplesitemapSettingsForm.php \Drupal\simple_sitemap\Form\SimplesitemapSettingsForm::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/SimplesitemapSettingsForm.php, line 24

Class

SimplesitemapSettingsForm
Class SimplesitemapSettingsForm @package Drupal\simple_sitemap\Form

Namespace

Drupal\simple_sitemap\Form

Code

public function buildForm(array $form, FormStateInterface $form_state) {
  $form['simple_sitemap_settings']['#prefix'] = $this
    ->getDonationText();
  $form['simple_sitemap_settings']['regenerate'] = [
    '#type' => 'fieldset',
    '#title' => $this
      ->t('Regenerate sitemap'),
    '#markup' => '<p>' . $this
      ->t('This will regenerate the XML sitemap immediately.') . '</p>',
  ];
  $form['simple_sitemap_settings']['regenerate']['regenerate_submit'] = [
    '#type' => 'submit',
    '#value' => $this
      ->t('Regenerate sitemap'),
    '#submit' => [
      '::generateSitemap',
    ],
    // Skip form-level validator.
    '#validate' => [],
  ];
  $form['simple_sitemap_settings']['settings'] = [
    '#type' => 'fieldset',
    '#title' => $this
      ->t('Settings'),
  ];
  $form['simple_sitemap_settings']['settings']['cron_generate'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Regenerate the sitemap during cron runs'),
    '#description' => $this
      ->t('Uncheck this if you intend to only regenerate the sitemap manually or via drush.'),
    '#default_value' => $this->generator
      ->getSetting('cron_generate', TRUE),
  ];
  $form['simple_sitemap_settings']['settings']['cron_generate_interval'] = [
    '#type' => 'select',
    '#title' => $this
      ->t('Sitemap generation interval'),
    '#description' => $this
      ->t('The sitemap will be generated according to this interval.'),
    '#default_value' => $this->generator
      ->getSetting('cron_generate_interval', 0),
    '#options' => [
      0 => $this
        ->t('On every cron run'),
      1 => $this
        ->t('Once an hour'),
      3 => $this
        ->t('Once every @hours hours', [
        '@hours' => 3,
      ]),
      6 => $this
        ->t('Once every @hours hours', [
        '@hours' => 6,
      ]),
      12 => $this
        ->t('Once every @hours hours', [
        '@hours' => 12,
      ]),
      24 => $this
        ->t('Once a day'),
      48 => $this
        ->t('Once every @days days', [
        '@days' => 48 / 24,
      ]),
      72 => $this
        ->t('Once every @days days', [
        '@days' => 72 / 24,
      ]),
      96 => $this
        ->t('Once every @days days', [
        '@days' => 96 / 24,
      ]),
      120 => $this
        ->t('Once every @days days', [
        '@days' => 120 / 24,
      ]),
      144 => $this
        ->t('Once every @days days', [
        '@days' => 144 / 24,
      ]),
      168 => $this
        ->t('Once a week'),
    ],
    '#states' => [
      'visible' => [
        ':input[name="cron_generate"]' => [
          'checked' => TRUE,
        ],
      ],
    ],
  ];
  $form['simple_sitemap_settings']['advanced'] = [
    '#type' => 'details',
    '#title' => $this
      ->t('Advanced settings'),
    '#open' => TRUE,
  ];
  $form['simple_sitemap_settings']['advanced']['base_url'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Default base URL'),
    '#default_value' => $this->generator
      ->getSetting('base_url', ''),
    '#size' => 30,
    '#description' => $this
      ->t('On some hosting providers it is impossible to pass parameters to cron to tell Drupal which URL to bootstrap with. In this case the base URL of sitemap links can be overridden here.<br/>Example: <em>@url</em>', [
      '@url' => $GLOBALS['base_url'],
    ]),
  ];
  $form['simple_sitemap_settings']['advanced']['remove_duplicates'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Exclude duplicate links'),
    '#description' => $this
      ->t('Uncheck this to significantly speed up the sitemap generation process on a huge site (more than 20 000 indexed entities).'),
    '#default_value' => $this->generator
      ->getSetting('remove_duplicates', TRUE),
  ];
  $form['simple_sitemap_settings']['advanced']['max_links'] = [
    '#type' => 'number',
    '#title' => $this
      ->t('Maximum links in a sitemap'),
    '#min' => 1,
    '#description' => $this
      ->t('The maximum number of links one sitemap can hold. If more links are generated than set here, a sitemap index will be created and the links split into several sub-sitemaps.<br/>50 000 links is the maximum Google will parse per sitemap, however it is advisable to set this to a lower number. If left blank, all links will be shown on a single sitemap.'),
    '#default_value' => $this->generator
      ->getSetting('max_links', 2000),
  ];
  $form['simple_sitemap_settings']['advanced']['batch_process_limit'] = [
    '#type' => 'number',
    '#title' => $this
      ->t('Refresh batch every n links'),
    '#min' => 1,
    '#description' => $this
      ->t('During sitemap generation, the batch process will issue a page refresh after n links processed to prevent PHP timeouts and memory exhaustion.<br/>Increasing this number will reduce the number of times Drupal has to bootstrap (thus speeding up the generation process), but will require more memory and less strict PHP timeout settings.'),
    '#default_value' => $this->generator
      ->getSetting('batch_process_limit', 1500),
    '#required' => TRUE,
  ];
  $form['simple_sitemap_settings']['advanced']['languages'] = [
    '#type' => 'details',
    '#title' => $this
      ->t('Language settings'),
    '#open' => FALSE,
  ];
  $language_options = [];
  foreach ($this->languageManager
    ->getLanguages() as $language) {
    if (!$language
      ->isDefault()) {
      $language_options[$language
        ->getId()] = $language
        ->getName();
    }
  }
  $form['simple_sitemap_settings']['advanced']['languages']['skip_untranslated'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Skip non-existent translations'),
    '#description' => $this
      ->t('If checked, entity links are generated exclusively for languages the entity has been translated to as long as the language is not excluded below.<br/>Otherwise entity links are generated for every language installed on the site apart from languages excluded below.<br/>Bear in mind that non-entity paths like homepage will always be generated for every non-excluded language.'),
    '#default_value' => $this->generator
      ->getSetting('skip_untranslated', FALSE),
  ];
  $form['simple_sitemap_settings']['advanced']['languages']['excluded_languages'] = [
    '#title' => $this
      ->t('Exclude languages'),
    '#type' => 'checkboxes',
    '#options' => $language_options,
    '#description' => !empty($language_options) ? $this
      ->t('There will be no links generated for languages checked here.') : $this
      ->t('There are no languages other than the default language <a href="@url">available</a>.', [
      '@url' => $GLOBALS['base_url'] . '/admin/config/regional/language',
    ]),
    '#default_value' => $this->generator
      ->getSetting('excluded_languages', []),
  ];
  $this->formHelper
    ->displayRegenerateNow($form['simple_sitemap_settings']);
  return parent::buildForm($form, $form_state);
}