vendor/pimcore/pimcore/lib/Twig/Extension/Templating/PimcoreUrl.php line 65

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\Twig\Extension\Templating;
  18. use Pimcore\Bundle\EcommerceFrameworkBundle\Model\LinkGeneratorAwareInterface;
  19. use Pimcore\Http\RequestHelper;
  20. use Pimcore\Model\DataObject\Concrete;
  21. use Pimcore\Twig\Extension\Templating\Traits\HelperCharsetTrait;
  22. use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
  23. use Twig\Extension\RuntimeExtensionInterface;
  25. class PimcoreUrl implements RuntimeExtensionInterface
  26. {
  27.     use HelperCharsetTrait;
  29.     /**
  30.      * @var UrlGeneratorInterface
  31.      */
  32.     protected $generator;
  34.     /**
  35.      * @var RequestHelper
  36.      */
  37.     protected $requestHelper;
  39.     /**
  40.      * @param UrlGeneratorInterface $generator
  41.      * @param RequestHelper $requestHelper
  42.      */
  43.     public function __construct(UrlGeneratorInterface $generator, RequestHelper $requestHelper)
  44.     {
  45.         $this->generator = $generator;
  46.         $this->requestHelper = $requestHelper;
  47.     }
  49.     /**
  50.      * @param array $urlOptions
  51.      * @param string|null $name
  52.      * @param bool $reset
  53.      * @param bool $encode
  54.      * @param bool $relative
  55.      *
  56.      * @return string
  57.      */
  58.     public function __invoke(array $urlOptions = [], $name = null, $reset = false, $encode = true, $relative = false)
  59.     {
  60.         // merge all parameters from request to parameters
  61.         if (!$reset && $this->requestHelper->hasMainRequest()) {
  62.             $urlOptions = array_replace($this->requestHelper->getMainRequest()->query->all(), $urlOptions);
  63.         }
  65.         return $this->generateUrl($name, $urlOptions, $relative ? UrlGeneratorInterface::RELATIVE_PATH : UrlGeneratorInterface::ABSOLUTE_PATH, $encode);
  66.     }
  68.     /**
  69.      * Generate URL with support to only pass parameters ZF1 style (defaults to current route).
  70.      *
  71.      * @param string|array|null $name
  72.      * @param array|null $parameters
  73.      * @param int $referenceType
  74.      * @param bool $encode
  75.      *
  76.      * @return string
  77.      */
  78.     protected function generateUrl($name = null, $parameters = [], $referenceType = UrlGeneratorInterface::ABSOLUTE_PATH, $encode = true)
  79.     {
  80.         if ($encode !== true) {
  81.             // encoding is default anyway, so we only set it when really necessary, to minimize the risk of
  82.             // side-effects when using parameters for that purpose (other routers may not be aware of param `encode`
  83.             $parameters['encode'] = $encode;
  84.         }
  86.         // if name is an array, treat it as parameters
  87.         if (is_array($name)) {
  88.             if (is_array($parameters)) {
  89.                 $parameters = array_merge($name, $parameters);
  90.             } else {
  91.                 $parameters = $name;
  92.             }
  94.             $name = null;
  95.         }
  97.         // get name from current route
  98.         if (null === $name) {
  99.             $name = $this->getCurrentRoute();
  100.         }
  102.         $object = $parameters['object'] ?? null;
  103.         $linkGenerator = null;
  105.         if ($object instanceof LinkGeneratorAwareInterface) { //e.g. Mockup
  106.             $linkGenerator = $object->getLinkGenerator();
  107.         } elseif ($object instanceof Concrete) {
  108.             $linkGenerator = $object->getClass()->getLinkGenerator();
  109.         }
  111.         if ($linkGenerator) {
  112.             if (array_key_exists('object', $parameters)) {
  113.                 unset($parameters['object']);
  114.             }
  115.             $path = $linkGenerator->generate($object, [
  116.                 'route' => $name,
  117.                 'parameters' => $parameters,
  118.                 'context' => $this,
  119.                 'referenceType' => $referenceType,
  120.             ]);
  122.             return $path;
  123.         }
  125.         if ($name !== null) {
  126.             return $this->generator->generate($name, $parameters, $referenceType);
  127.         }
  129.         return '';
  130.     }
  132.     /**
  133.      * Tries to get the current route name from current or main request
  134.      *
  135.      * @return string|null
  136.      */
  137.     protected function getCurrentRoute()
  138.     {
  139.         $route = null;
  141.         if ($this->requestHelper->hasCurrentRequest()) {
  142.             $route = $this->requestHelper->getCurrentRequest()->attributes->get('_route');
  143.         }
  145.         if (!$route && $this->requestHelper->hasMainRequest()) {
  146.             $route = $this->requestHelper->getMainRequest()->attributes->get('_route');
  147.         }
  149.         return $route;
  150.     }
  151. }