You are here

Home » API reference » Simple XML sitemap 4.x » SettingsForm.php

class SettingsForm in Simple XML sitemap 4.x

Class SettingsForm

Hierarchy

Expanded class hierarchy of SettingsForm

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

File

src/Form/SettingsForm.php, line 17

Namespace

Drupal\simple_sitemap\Form
View source 
class SettingsForm extends SimpleSitemapFormBase {

  /**
   * @var \Drupal\Core\Language\LanguageManagerInterface
   */
  protected $languageManager;

  /**
   * SettingsForm constructor.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   * @param \Drupal\simple_sitemap\Manager\Generator $generator
   * @param \Drupal\simple_sitemap\Settings $settings
   * @param \Drupal\simple_sitemap\Form\FormHelper $form_helper
   * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
   */
  public function __construct(ConfigFactoryInterface $config_factory, Generator $generator, Settings $settings, FormHelper $form_helper, LanguageManagerInterface $language_manager) {
    parent::__construct($config_factory, $generator, $settings, $form_helper);
    $this->languageManager = $language_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('config.factory'), $container
      ->get('simple_sitemap.generator'), $container
      ->get('simple_sitemap.settings'), $container
      ->get('simple_sitemap.form_helper'), $container
      ->get('language_manager'));
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) : array {
    $form['simple_sitemap_settings']['#prefix'] = FormHelper::getDonationText();
    $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 sitemaps during cron runs'),
      '#description' => $this
        ->t('Uncheck this if you intend to only regenerate the sitemaps manually or via drush.'),
      '#default_value' => $this->settings
        ->get('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->settings
        ->get('cron_generate_interval', 0),
      '#options' => FormHelper::getCronIntervalOptions(),
      '#states' => [
        'visible' => [
          ':input[name="cron_generate"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $form['simple_sitemap_settings']['settings']['xsl'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Add styling and sorting to sitemaps'),
      '#description' => $this
        ->t('If checked, sitemaps will be displayed as tables with sortable entries and thus become much friendlier towards human visitors. Search engines will not care.'),
      '#default_value' => $this->settings
        ->get('xsl', TRUE),
    ];
    $form['simple_sitemap_settings']['settings']['languages'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Language settings'),
      '#open' => FALSE,
    ];
    $form['simple_sitemap_settings']['settings']['languages']['disable_language_hreflang'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Remove hreflang markup in HTML'),
      '#description' => $this
        ->t('Google recommends displaying hreflang definitions either in the HTML markup or in the sitemap, but not in both places.<br>If checked, hreflang definitions created by the language module will be removed from the markup reducing its size.'),
      '#default_value' => $this->settings
        ->get('disable_language_hreflang', FALSE),
    ];
    $form['simple_sitemap_settings']['settings']['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->settings
        ->get('skip_untranslated', FALSE),
    ];
    $language_options = [];
    foreach ($this->languageManager
      ->getLanguages() as $language) {
      if (!$language
        ->isDefault()) {
        $language_options[$language
          ->getId()] = $language
          ->getName();
      }
    }
    $form['simple_sitemap_settings']['settings']['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->settings
        ->get('excluded_languages', []),
    ];
    $form['simple_sitemap_settings']['advanced'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Advanced settings'),
      '#open' => TRUE,
    ];
    $variants = SimpleSitemap::loadMultiple();
    $default_variant = $this->settings
      ->get('default_variant');
    $form['simple_sitemap_settings']['advanced']['default_variant'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Default sitemap variant'),
      '#description' => $this
        ->t('This sitemap variant will be available under <em>/sitemap.xml</em> in addition to its default path <em>/variant-name/sitemap.xml</em>.<br>Variants can be configured <a href="@url">here</a>.', [
        '@url' => $GLOBALS['base_url'] . '/admin/config/search/simplesitemap/variants',
      ]),
      '#default_value' => isset($variants[$default_variant]) ? $default_variant : '',
      '#options' => [
        '' => $this
          ->t('- None -'),
      ] + array_map(function ($variant) {
        return $this
          ->t($variant
          ->label());
      }, $variants),
    ];
    $form['simple_sitemap_settings']['advanced']['base_url'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Default base URL'),
      '#default_value' => $this->settings
        ->get('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('Prevent per-sitemap variant duplicate links.<br>Unchecking this may help avoiding PHP memory errors on huge sites.'),
      '#default_value' => $this->settings
        ->get('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, but choosing a lower value may be needed to avoid PHP memory errors on huge sites.<br>If left blank, all links will be shown on a single sitemap.'),
      '#default_value' => $this->settings
        ->get('max_links'),
    ];
    $form['simple_sitemap_settings']['advanced']['generate_duration'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Sitemap generation max duration'),
      '#min' => 1,
      '#description' => $this
        ->t('The maximum duration <strong>in seconds</strong> the generation task can run during a single cron run or during one batch process iteration.<br>The higher the number, the quicker the generation process, but higher the risk of PHP timeout errors.'),
      '#default_value' => $this->settings
        ->get('generate_duration', 10000) / 1000,
      '#required' => TRUE,
    ];
    $form['simple_sitemap_settings']['advanced']['entities_per_queue_item'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Entities per queue item'),
      '#min' => 1,
      '#description' => $this
        ->t('The number of entities to process in each queue item.<br>Increasing this number will use more memory but will result in less queries improving generation speed.'),
      '#default_value' => $this->settings
        ->get('entities_per_queue_item', 50),
    ];
    $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', $this
        ->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',
      'xsl',
      'base_url',
      'default_variant',
      'disable_language_hreflang',
      'entities_per_queue_item',
    ] as $setting_name) {
      $this->settings
        ->save($setting_name, $form_state
        ->getValue($setting_name));
    }
    $this->settings
      ->save('excluded_languages', array_filter($form_state
      ->getValue('excluded_languages')));
    $this->settings
      ->save('generate_duration', $form_state
      ->getValue('generate_duration') * 1000);
    parent::submitForm($form, $form_state);

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

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigFormBaseTrait::config protected function Retrieves a configuration object.
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
FormBase::$configFactory protected property The config factory. 3
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. 3
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.
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.
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. 27
MessengerTrait::messenger public function Gets the messenger. 27
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.
SettingsForm::$languageManager protected property
SettingsForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
SettingsForm::create public static function Instantiates a new instance of this class. Overrides SimpleSitemapFormBase::create
SettingsForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
SettingsForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
SettingsForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
SettingsForm::__construct public function SettingsForm constructor. Overrides SimpleSitemapFormBase::__construct
SimpleSitemapFormBase::$formHelper protected property
SimpleSitemapFormBase::$generator protected property
SimpleSitemapFormBase::$settings protected property
SimpleSitemapFormBase::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
StringTranslationTrait::$stringTranslation protected property The string translation service. 4
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.