vendor/presta/sitemap-bundle/src/Sitemap/Urlset.php line 135

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\Sitemap;
  14. use DateTimeInterface;
  15. use Presta\SitemapBundle\Sitemap\Url\Url;
  17. /**
  18. * Url set containing urls.
  19. *
  20. * https://www.sitemaps.org/protocol.html
  21. * https://developers.google.com/search/docs/advanced/sitemaps/large-sitemaps
  22. */
  23. class Urlset extends XmlConstraint
  24. {
  25. public const TAG = 'sitemap';
  27. /**
  28. * @var string
  29. */
  30. protected $loc;
  32. /**
  33. * @var DateTimeInterface
  34. */
  35. protected $lastmod;
  37. /**
  38. * @var string
  39. */
  40. protected $urlsXml = '';
  42. /**
  43. * @var array<string, string>
  44. */
  45. protected $customNamespaces = [];
  47. /**
  48. * @param string $loc
  49. * @param DateTimeInterface|null $lastmod
  50. */
  51. public function __construct(string $loc, DateTimeInterface $lastmod = null)
  52. {
  53. $this->loc = $loc;
  54. $this->lastmod = $lastmod ?? new \DateTimeImmutable();
  55. }
  57. /**
  58. * @return string
  59. */
  60. public function getLoc(): string
  61. {
  62. return $this->loc;
  63. }
  65. /**
  66. * @return DateTimeInterface
  67. */
  68. public function getLastmod(): DateTimeInterface
  69. {
  70. return $this->lastmod;
  71. }
  73. /**
  74. * add url to pool and check limits
  75. *
  76. * @param Url $url
  77. *
  78. * @throws \RuntimeException
  79. */
  80. public function addUrl(Url $url): void
  81. {
  82. if ($this->isFull()) {
  83. throw new \RuntimeException('The urlset limit has been exceeded');
  84. }
  86. $urlXml = $url->toXml();
  87. $this->appendXML($urlXml);
  89. //add unknown custom namespaces
  90. $this->customNamespaces = array_merge($this->customNamespaces, $url->getCustomNamespaces());
  92. //---------------------
  93. //Check limits
  94. if ($this->countItems++ >= self::LIMIT_ITEMS) {
  95. $this->limitItemsReached = true;
  96. }
  98. $urlLength = strlen($urlXml);
  99. $this->countBytes += $urlLength;
  101. if ($this->countBytes + $urlLength + strlen($this->getStructureXml()) > self::LIMIT_BYTES) {
  102. //we suppose the next url is almost the same length and cannot be added
  103. //plus we keep 500kB (@see self::LIMIT_BYTES)
  104. //... beware of numerous images set in url
  105. $this->limitBytesReached = true;
  106. }
  107. //---------------------
  108. }
  110. /**
  111. * Appends URL's XML to internal string buffer
  112. *
  113. * @param string $urlXml
  114. */
  115. protected function appendXML(string $urlXml): void
  116. {
  117. $this->urlsXml .= $urlXml;
  118. }
  120. /**
  121. * get the xml structure of the current urlset
  122. *
  123. * @return string
  124. */
  125. protected function getStructureXml(): string
  126. {
  127. $struct = '<?xml version="1.0" encoding="UTF-8"?>';
  128. $struct .= '<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" NAMESPACES>URLS</urlset>';
  130. $namespaces = '';
  131. foreach ($this->customNamespaces as $key => $location) {
  132. $namespaces .= ' xmlns:' . $key . '="' . $location . '"';
  133. }
  135. $struct = str_replace('NAMESPACES', $namespaces, $struct);
  137. return $struct;
  138. }
  140. /**
  141. * @inheritdoc
  142. */
  143. public function toXml(): string
  144. {
  145. return str_replace('URLS', $this->urlsXml, $this->getStructureXml());
  146. }
  147. }