vendor/pimcore/pimcore/lib/Templating/Renderer/ActionRenderer.php line 58

Open in your IDE?
  1. <?php
  3. /**
  4.  * Pimcore
  5.  *
  6.  * This source file is available under two different licenses:
  7.  * - GNU General Public License version 3 (GPLv3)
  8.  * - Pimcore Commercial License (PCL)
  9.  * Full copyright and license information is available in
  10.  * LICENSE.md which is distributed with this source code.
  11.  *
  12.  *  @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
  13.  *  @license    http://www.pimcore.org/license     GPLv3 and PCL
  14.  */
  16. namespace Pimcore\Templating\Renderer;
  18. use Pimcore\Http\Request\Resolver\PimcoreContextResolver;
  19. use Pimcore\Model\Document;
  20. use Symfony\Bridge\Twig\Extension\HttpKernelRuntime;
  21. use Symfony\Cmf\Bundle\RoutingBundle\Routing\DynamicRouter;
  22. use Symfony\Component\HttpKernel\Controller\ControllerReference;
  24. /**
  25.  * @internal
  26.  */
  27. class ActionRenderer
  28. {
  29.     /**
  30.      * @var HttpKernelRuntime
  31.      */
  32.     protected $httpKernelRuntime;
  34.     /**
  35.      * @param HttpKernelRuntime $httpKernelRuntime
  36.      */
  37.     public function __construct(HttpKernelRuntime $httpKernelRuntime)
  38.     {
  39.         $this->httpKernelRuntime = $httpKernelRuntime;
  40.     }
  42.     /**
  43.      * Render an URI
  44.      *
  45.      * @param mixed $uri     A URI
  46.      * @param array  $options An array of options
  47.      *
  48.      * @return string
  49.      *
  50.      * @see HttpKernelRuntime::renderFragment()
  51.      */
  52.     public function render($uri, array $options = [])
  53.     {
  54.         if ($uri instanceof Document\PageSnippet) {
  55.             $uri = $this->createDocumentReference($uri, $options);
  56.         }
  58.         return $this->httpKernelRuntime->renderFragment($uri, $options);
  59.     }
  61.     /**
  62.      * Create a document controller reference
  63.      *
  64.      * @param Document\PageSnippet $document
  65.      * @param array $attributes
  66.      * @param array $query
  67.      *
  68.      * @return ControllerReference
  69.      */
  70.     public function createDocumentReference(Document\PageSnippet $document, array $attributes = [], array $query = [])
  71.     {
  72.         $attributes = $this->addDocumentAttributes($document, $attributes);
  74.         return new ControllerReference($document->getController(), $attributes, $query);
  75.     }
  77.     /**
  78.      * Add document params to params array
  79.      *
  80.      * @param Document\PageSnippet $document
  81.      * @param array $attributes
  82.      * @param string $context
  83.      *
  84.      * @return array
  85.      */
  86.     public function addDocumentAttributes(Document\PageSnippet $document, array $attributes = [], string $context = PimcoreContextResolver::CONTEXT_DEFAULT)
  87.     {
  88.         if (null !== $context) {
  89.             // document needs to be rendered with default context as the context guesser can't resolve the
  90.             // context from a fragment route
  91.             $attributes[PimcoreContextResolver::ATTRIBUTE_PIMCORE_CONTEXT] = $context;
  92.         }
  94.         // The CMF dynamic router sets the 2 attributes contentDocument and contentTemplate to set
  95.         // a route's document and template. Those attributes are later used by controller listeners to
  96.         // determine what to render. By injecting those attributes into the sub-request we can rely on
  97.         // the same rendering logic as in the routed request.
  98.         $attributes[DynamicRouter::CONTENT_KEY] = $document;
  100.         if ($document->getTemplate()) {
  101.             $attributes[DynamicRouter::CONTENT_TEMPLATE] = $document->getTemplate();
  102.         }
  104.         if ($language = $document->getProperty('language')) {
  105.             $attributes['_locale'] = $language;
  106.         }
  108.         return $attributes;
  109.     }
  110. }