vendor/contao/core-bundle/src/Routing/Page/PageRoute.php line 41

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\Page;
  15. use Contao\CoreBundle\ContaoCoreBundle;
  16. use Contao\CoreBundle\Util\LocaleUtil;
  17. use Contao\PageModel;
  18. use Symfony\Cmf\Component\Routing\RouteObjectInterface;
  19. use Symfony\Component\Routing\Route;
  21. class PageRoute extends Route implements RouteObjectInterface
  22. {
  23. public const PAGE_BASED_ROUTE_NAME = 'page_routing_object';
  25. private PageModel $pageModel;
  26. private ?string $urlPrefix;
  27. private ?string $urlSuffix;
  29. /**
  30. * The referenced content object (can be anything).
  31. *
  32. * @var mixed
  33. */
  34. private $content;
  36. /**
  37. * @param string|array<string> $methods
  38. */
  39. public function __construct(PageModel $pageModel, string $path = '', array $defaults = [], array $requirements = [], array $options = [], $methods = [])
  40. {
  41. $pageModel->loadDetails();
  43. $defaults = array_merge(
  44. [
  45. '_controller' => 'Contao\FrontendIndex::renderPage',
  46. '_scope' => ContaoCoreBundle::SCOPE_FRONTEND,
  47. '_locale' => LocaleUtil::formatAsLocale($pageModel->rootLanguage ?? ''),
  48. '_format' => 'html',
  49. '_canonical_route' => 'tl_page.'.$pageModel->id,
  50. ],
  51. $defaults
  52. );
  54. // Always use the given page model in the defaults
  55. $defaults['pageModel'] = $pageModel;
  57. if (!isset($options['utf8'])) {
  58. $options['utf8'] = true;
  59. }
  61. if (!isset($options['compiler_class'])) {
  62. $options['compiler_class'] = PageRouteCompiler::class;
  63. }
  65. if ('' === $path) {
  66. $path = '/'.($pageModel->alias ?: $pageModel->id);
  67. } elseif (0 !== strncmp($path, '/', 1)) {
  68. $path = '/'.($pageModel->alias ?: $pageModel->id).'/'.$path;
  69. }
  71. parent::__construct(
  72. $path,
  73. $defaults,
  74. $requirements,
  75. $options,
  76. $pageModel->domain,
  77. $pageModel->rootUseSSL ? 'https' : 'http',
  78. $methods
  79. );
  81. $this->pageModel = $pageModel;
  82. $this->urlPrefix = $pageModel->urlPrefix;
  83. $this->urlSuffix = $pageModel->urlSuffix;
  84. }
  86. public function getPageModel(): PageModel
  87. {
  88. return $this->pageModel;
  89. }
  91. public function getPath(): string
  92. {
  93. $path = parent::getPath();
  95. if ('' !== $this->getUrlPrefix()) {
  96. $path = '/'.$this->getUrlPrefix().$path;
  97. }
  99. return $path.$this->getUrlSuffix();
  100. }
  102. public function getOriginalPath(): string
  103. {
  104. return parent::getPath();
  105. }
  107. public function getUrlPrefix(): string
  108. {
  109. return $this->urlPrefix;
  110. }
  112. public function setUrlPrefix(string $urlPrefix): self
  113. {
  114. $this->urlPrefix = $urlPrefix;
  116. return $this;
  117. }
  119. public function getUrlSuffix(): string
  120. {
  121. return $this->urlSuffix;
  122. }
  124. public function setUrlSuffix(string $urlSuffix): self
  125. {
  126. $this->urlSuffix = $urlSuffix;
  128. return $this;
  129. }
  131. /**
  132. * Sets the object this URL points to.
  133. *
  134. * @param mixed $content
  135. */
  136. public function setContent($content): self
  137. {
  138. $this->content = $content;
  140. return $this;
  141. }
  143. public function getContent()
  144. {
  145. return $this->content;
  146. }
  148. public function getRouteKey(): string
  149. {
  150. return 'tl_page.'.$this->pageModel->id;
  151. }
  152. }