vendor/sulu/sulu/src/Sulu/Bundle/WebsiteBundle/Controller/WebsiteController.php line 163

Open in your IDE?
  1. <?php
  3. /*
  4. * This file is part of Sulu.
  5. *
  6. * (c) Sulu GmbH
  7. *
  8. * This source file is subject to the MIT license that is bundled
  9. * with this source code in the file LICENSE.
  10. */
  12. namespace Sulu\Bundle\WebsiteBundle\Controller;
  14. use Sulu\Bundle\HttpCacheBundle\CacheLifetime\CacheLifetimeEnhancerInterface;
  15. use Sulu\Bundle\PreviewBundle\Preview\Preview;
  16. use Sulu\Bundle\WebsiteBundle\Resolver\ParameterResolverInterface;
  17. use Sulu\Component\Content\Compat\StructureInterface;
  18. use Sulu\Component\Webspace\Analyzer\RequestAnalyzerInterface;
  19. use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
  20. use Symfony\Component\HttpFoundation\Request;
  21. use Symfony\Component\HttpFoundation\Response;
  22. use Symfony\Component\HttpKernel\Exception\NotAcceptableHttpException;
  24. /**
  25. * Basic class to render Website from phpcr content.
  26. */
  27. abstract class WebsiteController extends AbstractController
  28. {
  29. /**
  30. * Returns a rendered structure.
  31. *
  32. * @param StructureInterface $structure The structure, which has been loaded for rendering
  33. * @param array $attributes Additional attributes, which will be passed to twig
  34. * @param bool $preview Defines if the site is rendered in preview mode
  35. * @param bool $partial Defines if only the content block of the template should be rendered
  36. *
  37. * @return Response
  38. */
  39. protected function renderStructure(
  40. StructureInterface $structure,
  41. $attributes = [],
  42. $preview = false,
  43. $partial = false
  44. ) {
  45. /** @var Request $request */
  46. $request = $this->getRequest();
  48. // extract format twig file
  49. if (!$preview) {
  50. $requestFormat = $request->getRequestFormat();
  51. } else {
  52. $requestFormat = 'html';
  53. }
  55. $viewTemplate = $structure->getView() . '.' . $requestFormat . '.twig';
  57. if (!$this->get('twig')->getLoader()->exists($viewTemplate)) {
  58. throw new NotAcceptableHttpException(\sprintf('Page does not exist in "%s" format.', $requestFormat));
  59. }
  61. // get attributes to render template
  62. $data = $this->getAttributes($attributes, $structure, $preview);
  64. // if partial render only content block else full page
  65. if ($partial) {
  66. $content = $this->renderBlock(
  67. $viewTemplate,
  68. 'content',
  69. $data
  70. );
  71. } elseif ($preview) {
  72. $content = $this->renderPreview(
  73. $viewTemplate,
  74. $data
  75. );
  76. } else {
  77. $content = $this->renderView(
  78. $viewTemplate,
  79. $data
  80. );
  81. }
  83. $response = new Response($content);
  85. // we need to set the content type ourselves here
  86. // else symfony will use the accept header of the client and the page could be cached with false content-type
  87. // see following symfony issue: https://github.com/symfony/symfony/issues/35694
  88. $mimeType = $request->getMimeType($requestFormat);
  90. if ($mimeType) {
  91. $response->headers->set('Content-Type', $mimeType);
  92. }
  94. if (!$preview && $this->getCacheTimeLifeEnhancer()) {
  95. $this->getCacheTimeLifeEnhancer()->enhance($response, $structure);
  96. }
  98. return $response;
  99. }
  101. /**
  102. * Generates attributes.
  103. *
  104. * @param mixed[] $attributes
  105. * @param bool $preview
  106. *
  107. * @return mixed[]
  108. */
  109. protected function getAttributes($attributes, ?StructureInterface $structure = null, $preview = false)
  110. {
  111. return $this->get('sulu_website.resolver.parameter')->resolve(
  112. $attributes,
  113. $this->get('sulu_core.webspace.request_analyzer'),
  114. $structure,
  115. $preview
  116. );
  117. }
  119. /**
  120. * Returns rendered part of template specified by block.
  121. */
  122. protected function renderBlock($template, $block, $attributes = [])
  123. {
  124. $twig = $this->get('twig');
  125. $attributes = $twig->mergeGlobals($attributes);
  127. $template = $twig->load($template);
  129. $level = \ob_get_level();
  130. \ob_start();
  132. try {
  133. $rendered = $template->renderBlock($block, $attributes);
  134. \ob_end_clean();
  136. return $rendered;
  137. } catch (\Exception $e) {
  138. while (\ob_get_level() > $level) {
  139. \ob_end_clean();
  140. }
  142. throw $e;
  143. }
  144. }
  146. protected function renderPreview(string $view, array $parameters = []): string
  147. {
  148. $parameters['previewParentTemplate'] = $view;
  149. $parameters['previewContentReplacer'] = Preview::CONTENT_REPLACER;
  151. return parent::renderView('@SuluWebsite/Preview/preview.html.twig', $parameters);
  152. }
  154. /**
  155. * Returns the current request from the request stack.
  156. *
  157. * @return Request
  158. *
  159. * @deprecated will be remove with 2.0
  160. */
  161. public function getRequest()
  162. {
  163. return $this->get('request_stack')->getCurrentRequest();
  164. }
  166. protected function getCacheTimeLifeEnhancer(): ?CacheLifetimeEnhancerInterface
  167. {
  168. if (!$this->has('sulu_http_cache.cache_lifetime.enhancer')) {
  169. return null;
  170. }
  172. /** @var CacheLifetimeEnhancerInterface $cacheLifetimeEnhancer */
  173. $cacheLifetimeEnhancer = $this->get('sulu_http_cache.cache_lifetime.enhancer');
  175. return $cacheLifetimeEnhancer;
  176. }
  178. public static function getSubscribedServices()
  179. {
  180. $subscribedServices = parent::getSubscribedServices();
  181. $subscribedServices['sulu_website.resolver.parameter'] = ParameterResolverInterface::class;
  182. $subscribedServices['sulu_core.webspace.request_analyzer'] = RequestAnalyzerInterface::class;
  183. $subscribedServices['sulu_http_cache.cache_lifetime.enhancer'] = '?' . CacheLifetimeEnhancerInterface::class;
  185. return $subscribedServices;
  186. }
  187. }