vendor/presta/sitemap-bundle/src/Sitemap/Url/UrlConcrete.php line 216

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\Url;
  14. use DateTimeInterface;
  15. use Presta\SitemapBundle\Sitemap\Utils;
  17. /**
  18. * First class citizen of sitemaps.
  19. *
  20. * https://developers.google.com/search/docs/guides/create-URLs
  21. */
  22. class UrlConcrete implements Url
  23. {
  24. public const CHANGEFREQ_ALWAYS = 'always';
  25. public const CHANGEFREQ_HOURLY = 'hourly';
  26. public const CHANGEFREQ_DAILY = 'daily';
  27. public const CHANGEFREQ_WEEKLY = 'weekly';
  28. public const CHANGEFREQ_MONTHLY = 'monthly';
  29. public const CHANGEFREQ_YEARLY = 'yearly';
  30. public const CHANGEFREQ_NEVER = 'never';
  32. /**
  33. * @var string
  34. */
  35. protected $loc;
  37. /**
  38. * @var DateTimeInterface|null
  39. */
  40. protected $lastmod;
  42. /**
  43. * @var string|null
  44. */
  45. protected $changefreq;
  47. /**
  48. * @var float|null
  49. */
  50. protected $priority;
  52. /**
  53. * Construct a new basic url
  54. *
  55. * @param string $loc Absolute url
  56. * @param DateTimeInterface|null $lastmod Last modification date
  57. * @param string|null $changefreq Change frequency
  58. * @param float|string|int|null $priority Priority
  59. */
  60. public function __construct(
  61. string $loc,
  62. DateTimeInterface $lastmod = null,
  63. string $changefreq = null,
  64. $priority = null
  65. ) {
  66. $this->setLoc($loc);
  67. $this->setLastmod($lastmod);
  68. $this->setChangefreq($changefreq);
  69. $this->setPriority($priority);
  70. }
  72. /**
  73. * @param string $loc
  74. *
  75. * @return UrlConcrete
  76. */
  77. public function setLoc(string $loc): self
  78. {
  79. $this->loc = $loc;
  81. return $this;
  82. }
  84. /**
  85. * @return string
  86. */
  87. public function getLoc(): string
  88. {
  89. return $this->loc;
  90. }
  92. /**
  93. * @param DateTimeInterface|null $lastmod
  94. *
  95. * @return UrlConcrete
  96. */
  97. public function setLastmod(?DateTimeInterface $lastmod): self
  98. {
  99. $this->lastmod = $lastmod;
  101. return $this;
  102. }
  104. /**
  105. * @return DateTimeInterface|null
  106. */
  107. public function getLastmod(): ?DateTimeInterface
  108. {
  109. return $this->lastmod;
  110. }
  112. /**
  113. * Define the change frequency of this entry
  114. *
  115. * @param string|null $changefreq Define the change frequency
  116. *
  117. * @return UrlConcrete
  118. */
  119. public function setChangefreq(string $changefreq = null): self
  120. {
  121. $frequencies = [
  122. self::CHANGEFREQ_ALWAYS,
  123. self::CHANGEFREQ_HOURLY,
  124. self::CHANGEFREQ_DAILY,
  125. self::CHANGEFREQ_WEEKLY,
  126. self::CHANGEFREQ_MONTHLY,
  127. self::CHANGEFREQ_YEARLY,
  128. self::CHANGEFREQ_NEVER,
  129. null,
  130. ];
  131. if (!in_array($changefreq, $frequencies)) {
  132. throw new \RuntimeException(
  133. sprintf(
  134. 'The value "%s" is not supported by the option changefreq.' .
  135. ' See http://www.sitemaps.org/protocol.html#xmlTagDefinitions',
  136. $changefreq
  137. )
  138. );
  139. }
  141. $this->changefreq = $changefreq;
  143. return $this;
  144. }
  146. /**
  147. * return the change frequency
  148. *
  149. * @return string|null
  150. */
  151. public function getChangefreq(): ?string
  152. {
  153. return $this->changefreq;
  154. }
  156. /**
  157. * Define the priority of this entry
  158. *
  159. * @param float|string|int|null $priority Define the priority
  160. *
  161. * @return UrlConcrete
  162. */
  163. public function setPriority($priority = null): self
  164. {
  165. if ($priority === null) {
  166. return $this;
  167. }
  169. if (is_string($priority) || is_int($priority)) {
  170. $priority = (float)$priority;
  171. }
  173. if (is_float($priority) && $priority >= 0 && $priority <= 1) {
  174. $this->priority = round($priority, 1);
  175. } else {
  176. throw new \RuntimeException(
  177. sprintf(
  178. 'The value "%s" is not supported by the option priority,' .
  179. ' it must be a numeric between 0.0 and 1.0.' .
  180. ' See http://www.sitemaps.org/protocol.html#xmlTagDefinitions',
  181. $priority
  182. )
  183. );
  184. }
  186. return $this;
  187. }
  189. /**
  190. * @return float|null
  191. */
  192. public function getPriority(): ?float
  193. {
  194. return $this->priority;
  195. }
  197. /**
  198. * @inheritdoc
  199. */
  200. public function toXml(): string
  201. {
  202. $xml = '<url><loc>' . Utils::encode($this->getLoc()) . '</loc>';
  204. $lastmod = $this->getLastmod();
  205. if ($lastmod) {
  206. $xml .= '<lastmod>' . $lastmod->format('c') . '</lastmod>';
  207. }
  209. $changefreq = $this->getChangefreq();
  210. if ($changefreq) {
  211. $xml .= '<changefreq>' . $changefreq . '</changefreq>';
  212. }
  214. $priority = $this->getPriority();
  215. if ($priority) {
  216. $xml .= '<priority>' . number_format($priority, 1) . '</priority>';
  217. }
  219. $xml .= '</url>';
  221. return $xml;
  222. }
  224. /**
  225. * @inheritdoc
  226. */
  227. public function getCustomNamespaces(): array
  228. {
  229. return []; // basic url has no namespace. see decorated urls
  230. }
  231. }