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

Open in your IDE?
  1. <?php
  2. /**
  3.  * Pimcore
  4.  *
  5.  * This source file is available under two different licenses:
  6.  * - GNU General Public License version 3 (GPLv3)
  7.  * - Pimcore Enterprise License (PEL)
  8.  * Full copyright and license information is available in
  9.  * LICENSE.md which is distributed with this source code.
  10.  *
  11.  * @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
  12.  * @license    http://www.pimcore.org/license     GPLv3 and PEL
  13.  */
  15. namespace Pimcore\Templating\Renderer;
  17. use Pimcore\Controller\Config\ConfigNormalizer;
  18. use Pimcore\Http\Request\Resolver\PimcoreContextResolver;
  19. use Pimcore\Model\Document;
  20. use Symfony\Bundle\FrameworkBundle\Templating\Helper\ActionsHelper;
  21. use Symfony\Cmf\Bundle\RoutingBundle\Routing\DynamicRouter;
  22. use Symfony\Component\HttpKernel\Controller\ControllerReference;
  24. class ActionRenderer
  25. {
  26.     /**
  27.      * @var ActionsHelper
  28.      */
  29.     protected $actionsHelper;
  31.     /**
  32.      * @var ConfigNormalizer
  33.      */
  34.     protected $configNormalizer;
  36.     /**
  37.      * @param ActionsHelper $actionsHelper
  38.      * @param ConfigNormalizer $configNormalizer
  39.      */
  40.     public function __construct(ActionsHelper $actionsHelper, ConfigNormalizer $configNormalizer)
  41.     {
  42.         $this->actionsHelper = $actionsHelper;
  43.         $this->configNormalizer = $configNormalizer;
  44.     }
  46.     /**
  47.      * Render an URI
  48.      *
  49.      * @param string $uri     A URI
  50.      * @param array  $options An array of options
  51.      *
  52.      * @return string
  53.      *
  54.      * @see ActionsHelper::render()
  55.      */
  56.     public function render($uri, array $options = [])
  57.     {
  58.         if ($uri instanceof Document\PageSnippet) {
  59.             $uri = $this->createDocumentReference($uri);
  60.         }
  62.         return $this->actionsHelper->render($uri, $options);
  63.     }
  65.     /**
  66.      * Create a controller reference
  67.      *
  68.      * @param string $bundle
  69.      * @param string $controller
  70.      * @param string $action
  71.      * @param array $attributes
  72.      * @param array $query
  73.      *
  74.      * @return ControllerReference
  75.      */
  76.     public function createControllerReference($bundle, $controller, $action, array $attributes = [], array $query = [])
  77.     {
  78.         $controller = $this->configNormalizer->formatControllerReference(
  79.             $bundle,
  80.             $controller,
  81.             $action
  82.         );
  84.         return $this->actionsHelper->controller($controller, $attributes, $query);
  85.     }
  87.     /**
  88.      * Create a document controller reference
  89.      *
  90.      * @param Document\PageSnippet $document
  91.      * @param array $attributes
  92.      * @param array $query
  93.      *
  94.      * @return ControllerReference
  95.      */
  96.     public function createDocumentReference(Document\PageSnippet $document, array $attributes = [], array $query = [])
  97.     {
  98.         $attributes = $this->addDocumentAttributes($document, $attributes);
  100.         return $this->createControllerReference(
  101.             $document->getModule(),
  102.             $document->getController(),
  103.             $document->getAction(),
  104.             $attributes,
  105.             $query
  106.         );
  107.     }
  109.     /**
  110.      * Add document params to params array
  111.      *
  112.      * @param Document\PageSnippet $document
  113.      * @param array $attributes
  114.      * @param string $context
  115.      *
  116.      * @return array
  117.      */
  118.     public function addDocumentAttributes(Document\PageSnippet $document, array $attributes = [], string $context = PimcoreContextResolver::CONTEXT_DEFAULT)
  119.     {
  120.         if (null !== $context) {
  121.             // document needs to be rendered with default context as the context guesser can't resolve the
  122.             // context from a fragment route
  123.             $attributes[PimcoreContextResolver::ATTRIBUTE_PIMCORE_CONTEXT] = $context;
  124.         }
  126.         // The CMF dynamic router sets the 2 attributes contentDocument and contentTemplate to set
  127.         // a route's document and template. Those attributes are later used by controller listeners to
  128.         // determine what to render. By injecting those attributes into the sub-request we can rely on
  129.         // the same rendering logic as in the routed request.
  130.         $attributes[DynamicRouter::CONTENT_KEY] = $document;
  132.         if ($document->getTemplate()) {
  133.             $template = $this->configNormalizer->normalizeTemplateName($document->getTemplate());
  134.             $attributes[DynamicRouter::CONTENT_TEMPLATE] = $template;
  135.         }
  137.         if ($language = $document->getProperty('language')) {
  138.             $attributes['_locale'] = $language;
  139.         }
  141.         return $attributes;
  142.     }
  143. }