You are here

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

class SimplesitemapSettingsForm 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

Class SimplesitemapSettingsForm @package Drupal\simple_sitemap\Form

Hierarchy

Expanded class hierarchy of SimplesitemapSettingsForm

1 string reference to 'SimplesitemapSettingsForm'
simple_sitemap.routing.yml in ./simple_sitemap.routing.yml
simple_sitemap.routing.yml

File

src/Form/SimplesitemapSettingsForm.php, line 12

Namespace

Drupal\simple_sitemap\Form
View source 
class SimplesitemapSettingsForm extends SimplesitemapFormBase {

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'simple_sitemap_settings_form';
  }

  /**
   * {@inheritdoc}
   */
  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);
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    $base_url = $form_state
      ->getValue('base_url');
    $form_state
      ->setValue('base_url', rtrim($base_url, '/'));
    if ($base_url !== '' && !UrlHelper::isValid($base_url, TRUE)) {
      $form_state
        ->setErrorByName('base_url', t('The base URL is invalid.'));
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    foreach ([
      'max_links',
      'cron_generate',
      'cron_generate_interval',
      'remove_duplicates',
      'skip_untranslated',
      'batch_process_limit',
      'base_url',
    ] as $setting_name) {
      $this->generator
        ->saveSetting($setting_name, $form_state
        ->getValue($setting_name));
    }
    $this->generator
      ->saveSetting('excluded_languages', array_filter($form_state
      ->getValue('excluded_languages')));
    parent::submitForm($form, $form_state);

    // Regenerate sitemaps according to user setting.
    if ($form_state
      ->getValue('simple_sitemap_regenerate_now')) {
      $this->generator
        ->generateSitemap();
    }
  }

  /**
   * @param array $form
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   */
  public function generateSitemap(array &$form, FormStateInterface $form_state) {
    $this->generator
      ->generateSitemap();
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigFormBaseTrait::config protected function Retrieves a configuration object.
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
FormBase::$configFactory protected property The config factory. 1
FormBase::$requestStack protected property The request stack. 1
FormBase::$routeMatch protected property The route match.
FormBase::configFactory protected function Gets the config factory for this form. 1
FormBase::container private function Returns the service container.
FormBase::currentUser protected function Gets the current user.
FormBase::getRequest protected function Gets the request object.
FormBase::getRouteMatch protected function Gets the route match.
FormBase::logger protected function Gets the logger for a specific channel.
FormBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
FormBase::resetConfigFactory public function Resets the configuration factory.
FormBase::setConfigFactory public function Sets the config factory for this form.
FormBase::setRequestStack public function Sets the request stack object to use.
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
SimplesitemapFormBase::$entityHelper protected property
SimplesitemapFormBase::$formHelper protected property
SimplesitemapFormBase::$generator protected property
SimplesitemapFormBase::$languageManager protected property
SimplesitemapFormBase::$pathValidator protected property
SimplesitemapFormBase::create public static function Instantiates a new instance of this class. Overrides ConfigFormBase::create
SimplesitemapFormBase::getDonationText protected function
SimplesitemapFormBase::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
SimplesitemapFormBase::__construct public function SimplesitemapFormBase constructor. Overrides ConfigFormBase::__construct
SimplesitemapSettingsForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
SimplesitemapSettingsForm::generateSitemap public function
SimplesitemapSettingsForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
SimplesitemapSettingsForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
SimplesitemapSettingsForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.