class XmlSitemapRebuildForm in XML sitemap 2.x
Same name and namespace in other branches
- 8 src/Form/XmlSitemapRebuildForm.php \Drupal\xmlsitemap\Form\XmlSitemapRebuildForm
Configure xmlsitemap settings for this site.
Hierarchy
- class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
- class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
- class \Drupal\xmlsitemap\Form\XmlSitemapRebuildForm
- class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
Expanded class hierarchy of XmlSitemapRebuildForm
1 string reference to 'XmlSitemapRebuildForm'
File
- src/
Form/ XmlSitemapRebuildForm.php, line 15
Namespace
Drupal\xmlsitemap\FormView 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
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ConfigFormBaseTrait:: |
protected | function | Retrieves a configuration object. | |
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
public | function | 2 | |
DependencySerializationTrait:: |
public | function | 2 | |
FormBase:: |
protected | property | The config factory. | 3 |
FormBase:: |
protected | property | The request stack. | 1 |
FormBase:: |
protected | property | The route match. | |
FormBase:: |
protected | function | Gets the config factory for this form. | 3 |
FormBase:: |
private | function | Returns the service container. | |
FormBase:: |
protected | function | Gets the current user. | |
FormBase:: |
protected | function | Gets the request object. | |
FormBase:: |
protected | function | Gets the route match. | |
FormBase:: |
protected | function | Gets the logger for a specific channel. | |
FormBase:: |
protected | function | Returns a redirect response object for the specified route. | |
FormBase:: |
public | function | Resets the configuration factory. | |
FormBase:: |
public | function | Sets the config factory for this form. | |
FormBase:: |
public | function | Sets the request stack object to use. | |
FormBase:: |
public | function |
Form validation handler. Overrides FormInterface:: |
72 |
LoggerChannelTrait:: |
protected | property | The logger channel factory service. | |
LoggerChannelTrait:: |
protected | function | Gets the logger for a specific channel. | |
LoggerChannelTrait:: |
public | function | Injects the logger channel factory. | |
MessengerTrait:: |
protected | property | The messenger. | 27 |
MessengerTrait:: |
public | function | Gets the messenger. | 27 |
MessengerTrait:: |
public | function | Sets the messenger. | |
RedirectDestinationTrait:: |
protected | property | The redirect destination service. | 1 |
RedirectDestinationTrait:: |
protected | function | Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url. | |
RedirectDestinationTrait:: |
protected | function | Returns the redirect destination service. | |
RedirectDestinationTrait:: |
public | function | Sets the redirect destination service. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 4 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
XmlSitemapRebuildForm:: |
protected | property | The state store. | |
XmlSitemapRebuildForm:: |
public | function |
Form constructor. Overrides ConfigFormBase:: |
|
XmlSitemapRebuildForm:: |
public static | function |
Instantiates a new instance of this class. Overrides ConfigFormBase:: |
|
XmlSitemapRebuildForm:: |
protected | function |
Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait:: |
|
XmlSitemapRebuildForm:: |
public | function |
Returns a unique string identifying the form. Overrides FormInterface:: |
|
XmlSitemapRebuildForm:: |
public | function |
Form submission handler. Overrides ConfigFormBase:: |
|
XmlSitemapRebuildForm:: |
public | function |
Constructs a new XmlSitemapRebuildForm object. Overrides ConfigFormBase:: |