vendor/presta/sitemap-bundle/src/Service/AbstractGenerator.php line 172

Open in your IDE?
  1. <?php
  3. /*
  4. * This file is part of the PrestaSitemapBundle package.
  5. *
  6. * (c) PrestaConcept <https://prestaconcept.net>
  7. *
  8. * For the full copyright and license information, please view the LICENSE
  9. * file that was distributed with this source code.
  10. */
  12. namespace Presta\SitemapBundle\Service;
  14. use Presta\SitemapBundle\Event\SitemapPopulateEvent;
  15. use Presta\SitemapBundle\Sitemap\Sitemapindex;
  16. use Presta\SitemapBundle\Sitemap\Url\Url;
  17. use Presta\SitemapBundle\Sitemap\Url\UrlConcrete;
  18. use Presta\SitemapBundle\Sitemap\Url\UrlDecorator;
  19. use Presta\SitemapBundle\Sitemap\Urlset;
  20. use Symfony\Component\EventDispatcher\EventDispatcherInterface;
  21. use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
  23. /**
  24. * Base class for all sitemap generators.
  25. *
  26. * @phpstan-type Defaults array{
  27. * lastmod: string|null,
  28. * changefreq: string|null,
  29. * priority: float|string|int|null
  30. * }
  31. */
  32. abstract class AbstractGenerator implements UrlContainerInterface
  33. {
  34. /**
  35. * @var EventDispatcherInterface
  36. */
  37. protected $dispatcher;
  39. /**
  40. * @var Sitemapindex|null
  41. */
  42. protected $root;
  44. /**
  45. * @var Urlset[]
  46. */
  47. protected $urlsets = [];
  49. /**
  50. * The maximum number of item generated in a sitemap
  51. * @var int
  52. */
  53. protected $itemsBySet;
  55. /**
  56. * @var UrlGeneratorInterface|null
  57. */
  58. protected $urlGenerator;
  60. /**
  61. * @var Defaults
  62. */
  63. private $defaults;
  65. /**
  66. * @param EventDispatcherInterface $dispatcher
  67. * @param int|null $itemsBySet
  68. * @param UrlGeneratorInterface|null $urlGenerator
  69. */
  70. public function __construct(
  71. EventDispatcherInterface $dispatcher,
  72. int $itemsBySet = null,
  73. UrlGeneratorInterface $urlGenerator = null
  74. ) {
  75. if (!$urlGenerator) {
  76. @trigger_error(
  77. 'Not injecting the $urlGenerator is deprecated and will be required in 4.0.',
  78. \E_USER_DEPRECATED
  79. );
  80. }
  82. $this->dispatcher = $dispatcher;
  83. // We add one to LIMIT_ITEMS because it was used as an index, not a quantity
  84. $this->itemsBySet = ($itemsBySet === null) ? Sitemapindex::LIMIT_ITEMS + 1 : $itemsBySet;
  85. $this->urlGenerator = $urlGenerator;
  87. $this->defaults = [
  88. 'priority' => 1,
  89. 'changefreq' => UrlConcrete::CHANGEFREQ_DAILY,
  90. 'lastmod' => 'now',
  91. ];
  92. }
  94. /**
  95. * @param Defaults $defaults
  96. */
  97. public function setDefaults(array $defaults): void
  98. {
  99. $this->defaults = $defaults;
  100. }
  102. /**
  103. * @inheritdoc
  104. */
  105. public function addUrl(Url $url, string $section): void
  106. {
  107. $urlset = $this->getUrlset($section);
  109. // Compare the number of items in the urlset against the maximum
  110. // allowed and check the maximum of 50k sitemap in sitemapindex
  111. $i = 0;
  112. while ((count($urlset) >= $this->itemsBySet || $urlset->isFull()) && $i <= Sitemapindex::LIMIT_ITEMS) {
  113. $urlset = $this->getUrlset($section . '_' . $i);
  114. $i++;
  115. }
  117. if (count($urlset) >= $this->itemsBySet || $urlset->isFull()) {
  118. throw new \RuntimeException('The limit of sitemapindex has been exceeded');
  119. }
  121. $concreteUrl = $this->getUrlConcrete($url);
  122. if ($concreteUrl instanceof UrlConcrete) {
  123. if (null === $concreteUrl->getLastmod() && null !== $this->defaults['lastmod']) {
  124. $concreteUrl->setLastmod(new \DateTimeImmutable($this->defaults['lastmod']));
  125. }
  126. if (null === $concreteUrl->getChangefreq()) {
  127. $concreteUrl->setChangefreq($this->defaults['changefreq']);
  128. }
  129. if (null === $concreteUrl->getPriority()) {
  130. $concreteUrl->setPriority($this->defaults['priority']);
  131. }
  132. }
  134. $urlset->addUrl($url);
  135. }
  137. /**
  138. * get or create urlset
  139. *
  140. * @param string $name
  141. *
  142. * @return Urlset
  143. */
  144. public function getUrlset(string $name): Urlset
  145. {
  146. if (!isset($this->urlsets[$name])) {
  147. $this->urlsets[$name] = $this->newUrlset($name);
  148. }
  150. return $this->urlsets[$name];
  151. }
  153. /**
  154. * Factory method for create Urlsets
  155. *
  156. * @param string $name
  157. * @param \DateTimeInterface|null $lastmod
  158. *
  159. * @return Urlset
  160. */
  161. abstract protected function newUrlset(string $name, \DateTimeInterface $lastmod = null): Urlset;
  163. /**
  164. * Dispatches SitemapPopulate Event - the listeners should use it to add their URLs to the sitemap
  165. *
  166. * @param string|null $section
  167. */
  168. protected function populate(string $section = null): void
  169. {
  170. $event = new SitemapPopulateEvent($this, $section, $this->urlGenerator);
  172. $this->dispatcher->dispatch($event, SitemapPopulateEvent::ON_SITEMAP_POPULATE);
  173. }
  175. /**
  176. * @return Sitemapindex
  177. */
  178. protected function getRoot(): Sitemapindex
  179. {
  180. if (null === $this->root) {
  181. $this->root = new Sitemapindex();
  183. foreach ($this->urlsets as $urlset) {
  184. $this->root->addSitemap($urlset);
  185. }
  186. }
  188. return $this->root;
  189. }
  191. /**
  192. * @param Url $url
  193. *
  194. * @return Url|null
  195. */
  196. private function getUrlConcrete(Url $url): ?Url
  197. {
  198. if ($url instanceof UrlConcrete) {
  199. return $url;
  200. }
  202. if ($url instanceof UrlDecorator) {
  203. return $this->getUrlConcrete($url->getUrlDecorated());
  204. }
  206. return null;
  207. }
  208. }