vendor/pimcore/pimcore/lib/Templating/Helper/Action.php line 92

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\Helper;
  17. use Pimcore\Model\Document\PageSnippet;
  18. use Pimcore\Targeting\Document\DocumentTargetingConfigurator;
  19. use Pimcore\Templating\Renderer\ActionRenderer;
  20. use Symfony\Component\Templating\Helper\Helper;
  22. class Action extends Helper
  23. {
  24.     /**
  25.      * @var ActionRenderer
  26.      */
  27.     protected $actionRenderer;
  29.     /**
  30.      * @var DocumentTargetingConfigurator
  31.      */
  32.     private $targetingConfigurator;
  34.     /**
  35.      * @var array
  36.      */
  37.     private $routingDefaults = [];
  39.     public function __construct(
  40.         ActionRenderer $actionRenderer,
  41.         DocumentTargetingConfigurator $targetingConfigurator
  42.     ) {
  43.         $this->actionRenderer = $actionRenderer;
  44.         $this->targetingConfigurator = $targetingConfigurator;
  45.     }
  47.     public function setRoutingDefaults(array $routingDefaults)
  48.     {
  49.         $this->routingDefaults = $routingDefaults;
  50.     }
  52.     /**
  53.      * @inheritDoc
  54.      */
  55.     public function getName()
  56.     {
  57.         return 'action';
  58.     }
  60.     /**
  61.      * @param string $action
  62.      * @param string $controller
  63.      * @param string|null $module
  64.      * @param array $attributes
  65.      * @param array $query
  66.      * @param array $options
  67.      *
  68.      * @return string
  69.      */
  70.     public function __invoke($action, $controller, $module = null, array $attributes = [], array $query = [], array $options = [])
  71.     {
  72.         $document = isset($attributes['document']) ? $attributes['document'] : null;
  73.         if ($document && $document instanceof PageSnippet) {
  74.             // apply best matching target group (if any)
  75.             $this->targetingConfigurator->configureTargetGroup($document);
  77.             $attributes = $this->actionRenderer->addDocumentAttributes($document, $attributes);
  78.         }
  80.         if (!$module) {
  81.             $module = $this->routingDefaults['bundle'];
  82.         }
  84.         $uri = $this->actionRenderer->createControllerReference(
  85.             $module,
  86.             $controller,
  87.             $action,
  88.             $attributes,
  89.             $query
  90.         );
  92.         return $this->actionRenderer->render($uri, $options);
  93.     }
  94. }