vendor/pimcore/pimcore/lib/Templating/Helper/PimcoreUrl.php line 114

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\Http\RequestHelper;
  18. use Pimcore\Model\DataObject\Concrete;
  19. use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
  20. use Symfony\Component\Templating\Helper\Helper;
  22. class PimcoreUrl extends Helper
  23. {
  24.     /**
  25.      * @var UrlGeneratorInterface
  26.      */
  27.     protected $generator;
  29.     /**
  30.      * @var RequestHelper
  31.      */
  32.     protected $requestHelper;
  34.     /**
  35.      * @param UrlGeneratorInterface $generator
  36.      * @param RequestHelper $requestHelper
  37.      */
  38.     public function __construct(UrlGeneratorInterface $generator, RequestHelper $requestHelper)
  39.     {
  40.         $this->generator = $generator;
  41.         $this->requestHelper = $requestHelper;
  42.     }
  44.     /**
  45.      * @param array $urlOptions
  46.      * @param string|null $name
  47.      * @param bool $reset
  48.      * @param bool $encode
  49.      * @param bool $relative
  50.      *
  51.      * @return string
  52.      */
  53.     public function __invoke(array $urlOptions = [], $name = null, $reset = false, $encode = true, $relative = false)
  54.     {
  55.         // merge all parameters from request to parameters
  56.         if (!$reset && $this->requestHelper->hasMasterRequest()) {
  57.             $urlOptions = array_replace($this->requestHelper->getMasterRequest()->query->all(), $urlOptions);
  58.         }
  60.         return $this->generateUrl($name, $urlOptions, $relative ? UrlGeneratorInterface::RELATIVE_PATH : UrlGeneratorInterface::ABSOLUTE_PATH, $encode);
  61.     }
  63.     /**
  64.      * Generate URL with support to only pass parameters ZF1 style (defaults to current route).
  65.      *
  66.      * @param string|null $name
  67.      * @param array $parameters
  68.      * @param int $referenceType
  69.      * @param bool $encode
  70.      *
  71.      * @return string
  72.      */
  73.     protected function generateUrl($name = null, $parameters = [], $referenceType = UrlGeneratorInterface::ABSOLUTE_PATH, $encode = true)
  74.     {
  75.         if ($encode !== true) {
  76.             // encoding is default anyway, so we only set it when really necessary, to minimize the risk of
  77.             // side-effects when using parameters for that purpose (other routers may not be aware of param `encode`
  78.             $parameters['encode'] = $encode;
  79.         }
  81.         // if name is an array, treat it as parameters
  82.         if (is_array($name)) {
  83.             if (is_array($parameters)) {
  84.                 $parameters = array_merge($name, $parameters);
  85.             } else {
  86.                 $parameters = $name;
  87.             }
  89.             $name = null;
  90.         }
  92.         // get name from current route
  93.         if (null === $name) {
  94.             $name = $this->getCurrentRoute();
  95.         }
  97.         if (isset($parameters['object']) && $parameters['object'] instanceof Concrete) {
  98.             /** @var Concrete $object */
  99.             $object = $parameters['object'];
  100.             if ($linkGenerator = $object->getClass()->getLinkGenerator()) {
  101.                 unset($parameters['object']);
  102.                 $path = $linkGenerator->generate($object, [
  103.                     'route' => $name,
  104.                     'parameters' => $parameters,
  105.                     'context' => $this,
  106.                     'referenceType' => $referenceType,
  107.                 ]);
  109.                 return $path;
  110.             }
  111.         }
  113.         if ($name !== null) {
  114.             return $this->generator->generate($name, $parameters, $referenceType);
  115.         }
  117.         return '';
  118.     }
  120.     /**
  121.      * Tries to get the current route name from current or master request
  122.      *
  123.      * @return string|null
  124.      */
  125.     protected function getCurrentRoute()
  126.     {
  127.         $route = null;
  129.         if ($this->requestHelper->hasCurrentRequest()) {
  130.             $route = $this->requestHelper->getCurrentRequest()->attributes->get('_route');
  131.         }
  133.         if (!$route && $this->requestHelper->hasMasterRequest()) {
  134.             $route = $this->requestHelper->getMasterRequest()->attributes->get('_route');
  135.         }
  137.         return $route;
  138.     }
  140.     /**
  141.      * Returns the canonical name of this helper.
  142.      *
  143.      * @return string The canonical name
  144.      */
  145.     public function getName()
  146.     {
  147.         return 'pimcoreUrl';
  148.     }
  149. }