You are here

Home » API reference » XML sitemap 8 » XmlSitemapSettingsForm.php

class XmlSitemapSettingsForm in XML sitemap 8

Same name and namespace in other branches
  1. 2.x src/Form/XmlSitemapSettingsForm.php \Drupal\xmlsitemap\Form\XmlSitemapSettingsForm

Configure xmlsitemap settings for this site.

Hierarchy

Expanded class hierarchy of XmlSitemapSettingsForm

1 string reference to 'XmlSitemapSettingsForm'
xmlsitemap.routing.yml in ./xmlsitemap.routing.yml
xmlsitemap.routing.yml

File

src/Form/XmlSitemapSettingsForm.php, line 20

Namespace

Drupal\xmlsitemap\Form
View source 
class XmlSitemapSettingsForm extends ConfigFormBase {

  /**
   * The state store.
   *
   * @var \Drupal\Core\State\StateInterface
   */
  protected $state;

  /**
   * The date service.
   *
   * @var \Drupal\Core\Datetime\DateFormatterInterface
   */
  protected $date;

  /**
   * The xmlsitemap.link_storage service.
   *
   * @var \Drupal\xmlsitemap\XmlSitemapLinkStorageInterface
   */
  protected $linkStorage;

  /**
   * The module handler.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

  /**
   * Constructs a new XmlSitemapSettingsForm object.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The factory for configuration objects.
   * @param \Drupal\Core\State\StateInterface $state
   *   The state service.
   * @param \Drupal\Core\Datetime\DateFormatterInterface $date
   *   The date formatter service.
   * @param \Drupal\xmlsitemap\XmlSitemapLinkStorageInterface $link_storage
   *   The xmlsitemap link storage service.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler.
   */
  public function __construct(ConfigFactoryInterface $config_factory, StateInterface $state, DateFormatterInterface $date, XmlSitemapLinkStorageInterface $link_storage, ModuleHandlerInterface $module_handler) {
    parent::__construct($config_factory);
    $this->state = $state;
    $this->date = $date;
    $this->linkStorage = $link_storage;
    $this->moduleHandler = $module_handler;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('config.factory'), $container
      ->get('state'), $container
      ->get('date.formatter'), $container
      ->get('xmlsitemap.link_storage'), $container
      ->get('module_handler'));
  }

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

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [
      'xmlsitemap.settings',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('xmlsitemap.settings');
    $intervals = [
      300,
      900,
      1800,
      3600,
      10800,
      21600,
      43200,
      86400,
      172800,
      259200,
      604800,
    ];
    $intervals = array_combine($intervals, $intervals);
    $format_intervals = [];
    foreach ($intervals as $key => $value) {
      $format_intervals[$key] = $this->date
        ->formatInterval($key);
    }
    $form['minimum_lifetime'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Minimum sitemap lifetime'),
      '#options' => [
        0 => $this
          ->t('No minimum'),
      ] + $format_intervals,
      '#description' => $this
        ->t('The minimum amount of time that will elapse before the sitemaps are regenerated. The sitemaps will also only be regenerated on cron if any links have been added, updated, or deleted.<br />Recommended value: <em>1 day</em>.'),
      '#default_value' => $config
        ->get('minimum_lifetime'),
    ];
    $form['xsl'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Include a stylesheet in the sitemaps for humans.'),
      '#description' => $this
        ->t('When enabled, this will add formatting and tables with sorting to make it easier to view the XML sitemap data instead of viewing raw XML output. Search engines will ignore this.'),
      '#default_value' => $config
        ->get('xsl'),
    ];
    $form['prefetch_aliases'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Prefetch URL aliases during sitemap generation.'),
      '#description' => $this
        ->t('When enabled, this will fetch all URL aliases at once instead of one at a time during sitemap generation. For medium or large sites, it is recommended to disable this feature as it uses a lot of memory.'),
      '#default_value' => $config
        ->get('prefetch_aliases'),
      '#access' => FALSE,
    ];
    $form['metatag_exclude_noindex'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Exclude individual items that has the Robots meta tag set to <em>Prevents search engines from indexing this page</em>.'),
      '#description' => $this
        ->t('Note this will ignore default metatags, only when items have overridden the Robots meta tag.'),
      '#default_value' => $config
        ->get('metatag_exclude_noindex'),
      '#access' => $this->moduleHandler
        ->moduleExists('metatag'),
    ];
    $form['advanced'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Advanced settings'),
      '#collapsible' => TRUE,
      '#collapsed' => !$this->state
        ->get('xmlsitemap_developer_mode'),
      '#weight' => 10,
    ];
    $form['advanced']['gz'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Generate additional compressed sitemaps using gzip.'),
      '#default_value' => $config
        ->get('gz'),
      '#disabled' => !function_exists('gzencode'),
    ];
    $chunk_sizes = [
      100,
      500,
      1000,
      2500,
      5000,
      10000,
      25000,
      XMLSITEMAP_MAX_SITEMAP_LINKS,
    ];
    $form['advanced']['chunk_size'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Number of links in each sitemap page'),
      '#options' => [
        'auto' => $this
          ->t('Automatic (recommended)'),
      ] + array_combine($chunk_sizes, $chunk_sizes),
      '#default_value' => xmlsitemap_var('chunk_size'),
      // @todo This description is not clear.
      '#description' => $this
        ->t('If there are problems with rebuilding the sitemap, you may want to manually set this value. If you have more than @max links, an index with multiple sitemap pages will be generated. There is a maximum of @max sitemap pages.', [
        '@max' => XMLSITEMAP_MAX_SITEMAP_LINKS,
      ]),
    ];
    $batch_limits = [
      5,
      10,
      25,
      50,
      100,
      250,
      500,
      1000,
      2500,
      5000,
    ];
    $form['advanced']['batch_limit'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Maximum number of sitemap links to process at once'),
      '#options' => array_combine($batch_limits, $batch_limits),
      '#default_value' => xmlsitemap_var('batch_limit'),
      '#description' => $this
        ->t('If you have problems running cron or rebuilding the sitemap, you may want to lower this value.'),
    ];
    if (!xmlsitemap_check_directory()) {
      $form_state
        ->setErrorByName('path', $this
        ->t('The directory %directory does not exist or is not writable.', [
        '%directory' => xmlsitemap_get_directory(),
      ]));
    }
    $form['advanced']['path'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Sitemap cache directory'),
      '#default_value' => $config
        ->get('path'),
      '#size' => 30,
      '#maxlength' => 255,
      '#description' => $this
        ->t('Subdirectory where the sitemap data will be stored. This folder <strong>must not be shared</strong> with any other Drupal site or install using XML sitemap.'),
      '#field_prefix' => file_build_uri(''),
      '#required' => TRUE,
    ];
    $base_url_override = Settings::get('xmlsitemap_base_url', FALSE);
    $form['advanced']['xmlsitemap_base_url'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Default base URL'),
      '#default_value' => $base_url_override ? $base_url_override : $this->state
        ->get('xmlsitemap_base_url'),
      '#size' => 30,
      '#description' => $this
        ->t('This is the default base URL used for sitemaps and sitemap links.'),
      '#required' => TRUE,
      '#disabled' => !empty($base_url_override),
    ];
    $form['advanced']['lastmod_format'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Last modification date format'),
      '#options' => [
        XMLSITEMAP_LASTMOD_SHORT => $this
          ->t('Short'),
        XMLSITEMAP_LASTMOD_MEDIUM => $this
          ->t('Medium'),
        XMLSITEMAP_LASTMOD_LONG => $this
          ->t('Long'),
      ],
      '#default_value' => $config
        ->get('lastmod_format'),
    ];
    foreach ($form['advanced']['lastmod_format']['#options'] as $key => &$label) {
      $label .= ' (' . gmdate($key) . ')';
    }
    $form['advanced']['xmlsitemap_developer_mode'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Enable developer mode to expose additional settings.'),
      '#default_value' => $this->state
        ->get('xmlsitemap_developer_mode'),
    ];
    $form['advanced']['disable_cron_regeneration'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Disable cron generation of sitemap files.'),
      '#default_value' => $config
        ->get('disable_cron_regeneration'),
      '#description' => $this
        ->t('This can be disabled if other methods are being used to generate the sitemap files, i.e. the <code>drush xmlsitemap:regenerate</code> command.'),
    ];
    $form['xmlsitemap_settings'] = [
      '#type' => 'vertical_tabs',
      '#weight' => 20,
    ];
    $entities = xmlsitemap_get_link_info(NULL, TRUE);
    foreach ($entities as $entity => $entity_info) {
      $form[$entity] = [
        '#type' => 'details',
        '#title' => $entity_info['label'],
        '#collapsible' => TRUE,
        '#collapsed' => TRUE,
        '#group' => 'xmlsitemap_settings',
      ];
      if (!empty($entity_info['bundles'])) {

        // If this entity has bundles, show a bundle setting summary.
        xmlsitemap_add_form_entity_summary($form[$entity], $entity, $entity_info);
      }
      if (!empty($entity_info['xmlsitemap']['settings callback'])) {

        // Add any entity-specific settings.
        $entity_info['xmlsitemap']['settings callback']($form[$entity]);
      }

      // Ensure that the entity fieldset is not shown if there are no accessible
      // sub-elements.
      $form[$entity]['#access'] = (bool) Element::getVisibleChildren($form[$entity]);
    }
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {

    // Check that the chunk size will not create more than 1000 chunks.
    $chunk_size = $form_state
      ->getValue('chunk_size');
    if ($chunk_size != 'auto' && $chunk_size != 50000 && xmlsitemap_get_link_count() / $chunk_size > 1000) {
      $form_state
        ->setErrorByName('chunk_size', $this
        ->t('The sitemap page link count of @size will create more than 1,000 sitemap pages. Please increase the link count.', [
        '@size' => $chunk_size,
      ]));
    }
    $base_url = $form_state
      ->getValue('xmlsitemap_base_url');
    $base_url = rtrim($base_url, '/');
    $form_state
      ->setValue('xmlsitemap_base_url', $base_url);
    if ($base_url != '' && !UrlHelper::isValid($base_url, TRUE)) {
      $form_state
        ->setErrorByName('xmlsitemap_base_url', $this
        ->t('Invalid base URL.'));
    }
    parent::validateForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {

    // Save any changes to the frontpage link.
    $config = $this
      ->config('xmlsitemap.settings');

    // Remove button and internal Form API values from submitted values.
    $form_state
      ->cleanValues();
    $values = $form_state
      ->getValues();
    if (isset($form['frontpage'])) {
      $this->linkStorage
        ->save([
        'type' => 'frontpage',
        'id' => 0,
        'loc' => '/',
        'subtype' => '',
        'priority' => $values['frontpage_priority'],
        'changefreq' => $values['frontpage_changefreq'],
      ]);
    }
    $this->state
      ->set('xmlsitemap_developer_mode', $values['xmlsitemap_developer_mode']);
    $this->state
      ->set('xmlsitemap_base_url', $values['xmlsitemap_base_url']);
    unset($values['xmlsitemap_developer_mode']);
    unset($values['xmlsitemap_base_url']);
    foreach ($values as $key => $value) {
      $config
        ->set($key, $value);
    }
    $config
      ->save();
    parent::submitForm($form, $form_state);
  }

}

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.
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.
XmlSitemapSettingsForm::$date protected property The date service.
XmlSitemapSettingsForm::$linkStorage protected property The xmlsitemap.link_storage service.
XmlSitemapSettingsForm::$moduleHandler protected property The module handler.
XmlSitemapSettingsForm::$state protected property The state store.
XmlSitemapSettingsForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
XmlSitemapSettingsForm::create public static function Instantiates a new instance of this class. Overrides ConfigFormBase::create
XmlSitemapSettingsForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
XmlSitemapSettingsForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
XmlSitemapSettingsForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
XmlSitemapSettingsForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
XmlSitemapSettingsForm::__construct public function Constructs a new XmlSitemapSettingsForm object. Overrides ConfigFormBase::__construct