SimplesitemapEntitiesForm.php 8.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192
  1. <?php
  2. namespace Drupal\simple_sitemap\Form;
  3. use Symfony\Component\DependencyInjection\ContainerInterface;
  4. use Drupal\Core\Form\FormStateInterface;
  5. use Drupal\simple_sitemap\Simplesitemap;
  6. use Drupal\simple_sitemap\EntityHelper;
  7. /**
  8. * Class SimplesitemapEntitiesForm
  9. * @package Drupal\simple_sitemap\Form
  10. */
  11. class SimplesitemapEntitiesForm extends SimplesitemapFormBase {
  12. /**
  13. * @var \Drupal\simple_sitemap\EntityHelper
  14. */
  15. protected $entityHelper;
  16. /**
  17. * SimplesitemapEntitiesForm constructor.
  18. * @param \Drupal\simple_sitemap\Simplesitemap $generator
  19. * @param \Drupal\simple_sitemap\Form\FormHelper $form_helper
  20. * @param \Drupal\simple_sitemap\EntityHelper $entity_helper
  21. */
  22. public function __construct(
  23. Simplesitemap $generator,
  24. FormHelper $form_helper,
  25. EntityHelper $entity_helper
  26. ) {
  27. parent::__construct(
  28. $generator,
  29. $form_helper
  30. );
  31. $this->entityHelper = $entity_helper;
  32. }
  33. /**
  34. * {@inheritdoc}
  35. */
  36. public static function create(ContainerInterface $container) {
  37. return new static(
  38. $container->get('simple_sitemap.generator'),
  39. $container->get('simple_sitemap.form_helper'),
  40. $container->get('simple_sitemap.entity_helper')
  41. );
  42. }
  43. /**
  44. * {@inheritdoc}
  45. */
  46. public function getFormId() {
  47. return 'simple_sitemap_entities_form';
  48. }
  49. /**
  50. * {@inheritdoc}
  51. */
  52. public function buildForm(array $form, FormStateInterface $form_state) {
  53. $form['simple_sitemap_entities']['#prefix'] = $this->getDonationText();
  54. $form['simple_sitemap_entities']['entities'] = [
  55. '#title' => $this->t('Sitemap entities'),
  56. '#type' => 'fieldset',
  57. '#markup' => '<div class="description">' . $this->t('Simple XML sitemap settings will be added only to entity forms of entity types enabled here. For all entity types featuring bundles (e.g. <em>node</em>) sitemap settings have to be set on their bundle pages (e.g. <em>page</em>).') . '</div>',
  58. ];
  59. $form['#attached']['library'][] = 'simple_sitemap/sitemapEntities';
  60. $form['#attached']['drupalSettings']['simple_sitemap'] = ['all_entities' => [], 'atomic_entities' => []];
  61. $entity_type_labels = [];
  62. foreach ($this->entityHelper->getSupportedEntityTypes() as $entity_type_id => $entity_type) {
  63. $entity_type_labels[$entity_type_id] = $entity_type->getLabel() ? : $entity_type_id;
  64. }
  65. asort($entity_type_labels);
  66. $this->formHelper->processForm($form_state);
  67. $bundle_settings = $this->generator->getBundleSettings();
  68. foreach ($entity_type_labels as $entity_type_id => $entity_type_label) {
  69. ;
  70. $enabled_entity_type = $this->generator->entityTypeIsEnabled($entity_type_id);
  71. $atomic_entity_type = $this->entityHelper->entityTypeIsAtomic($entity_type_id);
  72. $css_entity_type_id = str_replace('_', '-', $entity_type_id);
  73. $form['simple_sitemap_entities']['entities'][$entity_type_id] = [
  74. '#type' => 'details',
  75. '#title' => $entity_type_label,
  76. '#open' => $enabled_entity_type,
  77. ];
  78. $form['simple_sitemap_entities']['entities'][$entity_type_id][$entity_type_id . '_enabled'] = [
  79. '#type' => 'checkbox',
  80. '#title' => $this->t('Enable @entity_type_label <em>(@entity_type_id)</em> support', ['@entity_type_label' => strtolower($entity_type_label), '@entity_type_id' => $entity_type_id]),
  81. '#description' => $atomic_entity_type
  82. ? $this->t('Sitemap settings for the entity type <em>@entity_type_label</em> can be set below and overridden on its entity pages.', ['@entity_type_label' => strtolower($entity_type_label)])
  83. : $this->t('Sitemap settings for the entity type <em>@entity_type_label</em> can be set on its bundle pages and overridden on its entity pages.', ['@entity_type_label' => strtolower($entity_type_label)]),
  84. '#default_value' => $enabled_entity_type,
  85. ];
  86. if ($form['simple_sitemap_entities']['entities'][$entity_type_id][$entity_type_id . '_enabled']['#default_value']) {
  87. $bundle_info = '';
  88. $indexed_bundles = isset($bundle_settings[$entity_type_id])
  89. ? implode(array_keys(array_filter($bundle_settings[$entity_type_id], function ($val) {return $val['index'];})), ', ')
  90. : '';
  91. if (!$atomic_entity_type) {
  92. $bundle_info .= '<div id="indexed-bundles-' . $css_entity_type_id . '">'
  93. . (!empty($indexed_bundles)
  94. ? $this->t("<em>@entity_type_label</em> bundles set to be indexed:", ['@entity_type_label' => ucfirst(strtolower($entity_type_label))]) . ' ' . '<em>' . $indexed_bundles . '</em>'
  95. : $this->t('No <em>@entity_type_label</em> bundles are set to be indexed yet.', ['@entity_type_label' => strtolower($entity_type_label)]))
  96. . '</div>';
  97. }
  98. if (!empty($indexed_bundles)) {
  99. $bundle_info .= '<div id="warning-' . $css_entity_type_id . '">'
  100. . ($atomic_entity_type
  101. ? $this->t("<strong>Warning:</strong> This entity type's sitemap settings including per-entity overrides will be deleted after hitting <em>Save</em>.")
  102. : $this->t("<strong>Warning:</strong> The sitemap settings for <em>@bundles</em> and any per-entity overrides will be deleted after hitting <em>Save</em>.",
  103. ['@bundles' => $indexed_bundles]))
  104. . '</div>';
  105. }
  106. $form['simple_sitemap_entities']['entities'][$entity_type_id][$entity_type_id . '_enabled']['#suffix'] = $bundle_info;
  107. }
  108. $form['#attached']['drupalSettings']['simple_sitemap']['all_entities'][] = $css_entity_type_id;
  109. if ($atomic_entity_type) {
  110. $this->formHelper->setEntityCategory('bundle')
  111. ->setEntityTypeId($entity_type_id)
  112. ->setBundleName($entity_type_id)
  113. ->displayEntitySettings($form['simple_sitemap_entities']['entities'][$entity_type_id][$entity_type_id . '_settings'], TRUE);
  114. $form['#attached']['drupalSettings']['simple_sitemap']['atomic_entities'][] = $css_entity_type_id;
  115. }
  116. }
  117. $this->formHelper->displayRegenerateNow($form['simple_sitemap_entities']['entities']);
  118. return parent::buildForm($form, $form_state);
  119. }
  120. /**
  121. * {@inheritdoc}
  122. */
  123. public function submitForm(array &$form, FormStateInterface $form_state) {
  124. $values = $form_state->getValues();
  125. foreach ($values as $field_name => $value) {
  126. if (substr($field_name, -strlen('_enabled')) === '_enabled') {
  127. $entity_type_id = substr($field_name, 0, -8);
  128. if ($value) {
  129. $this->generator->enableEntityType($entity_type_id);
  130. if ($this->entityHelper->entityTypeIsAtomic($entity_type_id)) {
  131. // Deleting bundle settings for old bundle.
  132. // See simple_sitemap.module::simple_sitemap_entity_form_submit().
  133. // todo: This will not be necessary if "multiple variants pro bundle" is implemented.
  134. if (isset($form['simple_sitemap_entities']['entities'][$entity_type_id][$entity_type_id . '_settings'][$entity_type_id . '_simple_sitemap_variant']['#default_value'])) {
  135. $old_variant = $form['simple_sitemap_entities']['entities'][$entity_type_id][$entity_type_id . '_settings'][$entity_type_id . '_simple_sitemap_variant']['#default_value'];
  136. if ($old_variant !== $values[$entity_type_id . '_simple_sitemap_variant']) {
  137. $this->generator->setVariants($old_variant)->removeBundleSettings($entity_type_id);
  138. }
  139. }
  140. $this->generator
  141. ->setVariants($values[$entity_type_id . '_simple_sitemap_variant'])
  142. ->setBundleSettings($entity_type_id, $entity_type_id, [
  143. 'index' => TRUE,
  144. 'priority' => $values[$entity_type_id . '_simple_sitemap_priority'],
  145. 'changefreq' => $values[$entity_type_id . '_simple_sitemap_changefreq'],
  146. 'include_images' => (bool) $values[$entity_type_id . '_simple_sitemap_include_images'],
  147. ]);
  148. }
  149. }
  150. else {
  151. $this->generator->disableEntityType($entity_type_id);
  152. }
  153. }
  154. }
  155. parent::submitForm($form, $form_state);
  156. // Regenerate sitemaps according to user setting.
  157. if ($form_state->getValue('simple_sitemap_regenerate_now')) {
  158. $this->generator->generateSitemap();
  159. }
  160. }
  161. }