vendor/pimcore/pimcore/lib/Document/Renderer/DocumentRenderer.php line 145

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. /**
  6.  * Pimcore
  7.  *
  8.  * This source file is available under two different licenses:
  9.  * - GNU General Public License version 3 (GPLv3)
  10.  * - Pimcore Commercial License (PCL)
  11.  * Full copyright and license information is available in
  12.  * LICENSE.md which is distributed with this source code.
  13.  *
  14.  *  @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
  15.  *  @license    http://www.pimcore.org/license     GPLv3 and PCL
  16.  */
  18. namespace Pimcore\Document\Renderer;
  20. use Pimcore\Event\DocumentEvents;
  21. use Pimcore\Event\Model\DocumentEvent;
  22. use Pimcore\Http\RequestHelper;
  23. use Pimcore\Localization\LocaleService;
  24. use Pimcore\Model\Document;
  25. use Pimcore\Routing\Dynamic\DocumentRouteHandler;
  26. use Pimcore\Targeting\Document\DocumentTargetingConfigurator;
  27. use Pimcore\Templating\Renderer\ActionRenderer;
  28. use Pimcore\Twig\Extension\Templating\Placeholder\ContainerService;
  29. use Symfony\Component\HttpKernel\Fragment\FragmentRendererInterface;
  30. use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
  32. class DocumentRenderer implements DocumentRendererInterface
  33. {
  34.     /**
  35.      * @var RequestHelper
  36.      */
  37.     private $requestHelper;
  39.     /**
  40.      * @var ActionRenderer
  41.      */
  42.     private $actionRenderer;
  44.     /**
  45.      * @var FragmentRendererInterface
  46.      */
  47.     private $fragmentRenderer;
  49.     /**
  50.      * @var DocumentRouteHandler
  51.      */
  52.     private $documentRouteHandler;
  54.     /**
  55.      * @var DocumentTargetingConfigurator
  56.      */
  57.     private $targetingConfigurator;
  59.     /**
  60.      * @var EventDispatcherInterface
  61.      */
  62.     private $eventDispatcher;
  64.     /**
  65.      * @var LocaleService
  66.      */
  67.     private $localeService;
  69.     /**
  70.      * @param RequestHelper $requestHelper
  71.      * @param ActionRenderer $actionRenderer
  72.      * @param FragmentRendererInterface $fragmentRenderer
  73.      * @param DocumentRouteHandler $documentRouteHandler
  74.      * @param DocumentTargetingConfigurator $targetingConfigurator
  75.      * @param EventDispatcherInterface $eventDispatcher
  76.      * @param LocaleService $localeService
  77.      */
  78.     public function __construct(
  79.         RequestHelper $requestHelper,
  80.         ActionRenderer $actionRenderer,
  81.         FragmentRendererInterface $fragmentRenderer,
  82.         DocumentRouteHandler $documentRouteHandler,
  83.         DocumentTargetingConfigurator $targetingConfigurator,
  84.         EventDispatcherInterface $eventDispatcher,
  85.         LocaleService $localeService
  86.     ) {
  87.         $this->requestHelper = $requestHelper;
  88.         $this->actionRenderer = $actionRenderer;
  89.         $this->fragmentRenderer = $fragmentRenderer;
  90.         $this->documentRouteHandler = $documentRouteHandler;
  91.         $this->targetingConfigurator = $targetingConfigurator;
  92.         $this->eventDispatcher = $eventDispatcher;
  93.         $this->localeService = $localeService;
  94.     }
  96.     /**
  97.      * @required
  98.      *
  99.      * @param ContainerService $containerService
  100.      */
  101.     public function setContainerService(ContainerService $containerService)
  102.     {
  103.         // we have to ensure that the ContainerService was initialized at the time this service is created
  104.         // this is necessary, since the ContainerService registers a listener for DocumentEvents::RENDERER_PRE_RENDER
  105.         // which wouldn't be called if the ContainerService would be lazy initialized when the first
  106.         // placeholder service/templating helper is used during the rendering process
  107.     }
  109.     /**
  110.      * {@inheritdoc}
  111.      */
  112.     public function render(Document\PageSnippet $document, array $attributes = [], array $query = [], array $options = []): string
  113.     {
  114.         $this->eventDispatcher->dispatch(
  115.             new DocumentEvent($document, $attributes),
  116.             DocumentEvents::RENDERER_PRE_RENDER
  117.         );
  119.         // apply best matching target group (if any)
  120.         $this->targetingConfigurator->configureTargetGroup($document);
  122.         // add document route to request if no route is set
  123.         // this is needed for logic relying on the current route (e.g. pimcoreUrl helper)
  124.         if (!isset($attributes['_route'])) {
  125.             $route = $this->documentRouteHandler->buildRouteForDocument($document);
  126.             if (null !== $route) {
  127.                 $attributes['_route'] = $route->getRouteKey();
  128.             }
  129.         }
  131.         try {
  132.             $request = $this->requestHelper->getCurrentRequest();
  133.         } catch (\Exception $e) {
  134.             $request = $this->requestHelper->createRequestWithContext();
  135.         }
  137.         $documentLocale = $document->getProperty('language');
  138.         $tempLocale = $this->localeService->getLocale();
  139.         if ($documentLocale) {
  140.             $this->localeService->setLocale($documentLocale);
  141.             $request->setLocale($documentLocale);
  142.         }
  144.         $uri = $this->actionRenderer->createDocumentReference($document, $attributes, $query);
  145.         $response = $this->fragmentRenderer->render($uri, $request, $options);
  147.         $this->localeService->setLocale($tempLocale);
  149.         $this->eventDispatcher->dispatch(
  150.             new DocumentEvent($document, $attributes),
  151.             DocumentEvents::RENDERER_POST_RENDER
  152.         );
  154.         return $response->getContent();
  155.     }
  156. }