You are here

class XmlSitemapRebuildForm in XML sitemap 2.x

Same name and namespace in other branches
  1. 8 src/Form/XmlSitemapRebuildForm.php \Drupal\xmlsitemap\Form\XmlSitemapRebuildForm

Configure xmlsitemap settings for this site.

Hierarchy

Expanded class hierarchy of XmlSitemapRebuildForm

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

File

src/Form/XmlSitemapRebuildForm.php, line 15

Namespace

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

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

  /**
   * Constructs a new XmlSitemapRebuildForm object.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The factory for configuration objects.
   * @param \Drupal\Core\State\StateInterface $state
   *   The state service.
   */
  public function __construct(ConfigFactoryInterface $config_factory, StateInterface $state) {
    parent::__construct($config_factory);
    $this->state = $state;
  }

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

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $request = $this
      ->getRequest();
    if (!$request->request && !$this->state
      ->get('xmlsitemap_rebuild_needed')) {
      if (!$this->state
        ->get('xmlsitemap_regenerate_needed')) {
        $this
          ->messenger()
          ->addError($this
          ->t('Your sitemap is up to date and does not need to be rebuilt.'));
      }
      else {
        $request->query
          ->set('destination', 'admin/config/search/xmlsitemap');
        $this
          ->messenger()
          ->addWarning($this
          ->t('A rebuild is not necessary. If you are just wanting to regenerate the XML sitemap files, you can <a href="@link-cron">run cron manually</a>.', [
          '@link-cron' => Url::fromRoute('system.run_cron', [], [
            'query' => $this
              ->getDestinationArray(),
          ]),
        ]));
        $this
          ->setRequest($request);
      }
    }

    // Build a list of rebuildable link types.
    $rebuild_types = xmlsitemap_get_rebuildable_link_types();
    $rebuild_types = array_combine($rebuild_types, $rebuild_types);
    $form['entity_type_ids'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Select which link types you would like to rebuild'),
      '#description' => $this
        ->t('If no link types are selected, the sitemap files will just be regenerated.'),
      '#multiple' => TRUE,
      '#options' => $rebuild_types,
      '#default_value' => $this->state
        ->get('xmlsitemap_rebuild_needed') || !$this->state
        ->get('xmlsitemap_developer_mode') ? $rebuild_types : [],
      '#access' => $this->state
        ->get('xmlsitemap_developer_mode'),
    ];
    $form['save_custom'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Save and restore any custom inclusion and priority links.'),
      '#default_value' => TRUE,
    ];
    return parent::buildForm($form, $form_state);
  }

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

    // Save any changes to the frontpage link.
    $entity_type_ids = $form_state
      ->getValue('entity_type_ids');
    $save_custom = $form_state
      ->getValue('save_custom');
    $batch = xmlsitemap_rebuild_batch($entity_type_ids, $save_custom);
    batch_set($batch);
    $form_state
      ->setRedirect('xmlsitemap.admin_search');
    parent::submitForm($form, $form_state);
  }

}

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