vendor/contao/core-bundle/src/Routing/ResponseContext/HtmlHeadBag/HtmlHeadBag.php line 17

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. /*
  6. * This file is part of Contao.
  7. *
  8. * (c) Leo Feyer
  9. *
  10. * @license LGPL-3.0-or-later
  11. */
  13. namespace Contao\CoreBundle\Routing\ResponseContext\HtmlHeadBag;
  15. use Symfony\Component\HttpFoundation\Request;
  17. final class HtmlHeadBag
  18. {
  19. private string $title = '';
  20. private string $metaDescription = '';
  21. private string $metaRobots = 'index,follow';
  22. private string $canonicalUri = '';
  23. private array $keepParamsForCanonical = [];
  25. public function getTitle(): string
  26. {
  27. return $this->title;
  28. }
  30. public function setTitle(string $title): self
  31. {
  32. $this->title = $title;
  34. return $this;
  35. }
  37. public function getMetaDescription(): string
  38. {
  39. return $this->metaDescription;
  40. }
  42. public function setMetaDescription(string $metaDescription): self
  43. {
  44. $this->metaDescription = $metaDescription;
  46. return $this;
  47. }
  49. public function getMetaRobots(): string
  50. {
  51. return $this->metaRobots;
  52. }
  54. public function setMetaRobots(string $metaRobots): self
  55. {
  56. $this->metaRobots = $metaRobots;
  58. return $this;
  59. }
  61. public function setKeepParamsForCanonical(array $keepParamsForCanonical): self
  62. {
  63. $this->keepParamsForCanonical = $keepParamsForCanonical;
  65. return $this;
  66. }
  68. public function getKeepParamsForCanonical(): array
  69. {
  70. return $this->keepParamsForCanonical;
  71. }
  73. public function addKeepParamsForCanonical(string $param): self
  74. {
  75. $this->keepParamsForCanonical[] = $param;
  77. return $this;
  78. }
  80. public function setCanonicalUri(string $canonicalUri): self
  81. {
  82. $this->canonicalUri = $canonicalUri;
  84. return $this;
  85. }
  87. public function getCanonicalUri(): string
  88. {
  89. return $this->canonicalUri;
  90. }
  92. public function getCanonicalUriForRequest(Request $request): string
  93. {
  94. if ($this->canonicalUri) {
  95. // Make sure the custom URI is normalized as well
  96. return Request::create($this->canonicalUri)->getUri();
  97. }
  99. $params = [];
  101. foreach ($request->query->all() as $originalParam => $value) {
  102. foreach ($this->getKeepParamsForCanonical() as $param) {
  103. $regex = sprintf('/^%s$/', str_replace('\*', '.*', preg_quote($param, '/')));
  105. if (preg_match($regex, $originalParam)) {
  106. $params[$originalParam] = $value;
  107. }
  108. }
  109. }
  111. $request = Request::create(
  112. $request->getSchemeAndHttpHost().$request->getBaseUrl().$request->getPathInfo(),
  113. $request->getMethod(),
  114. $params
  115. );
  117. return $request->getUri();
  118. }
  119. }