vendor/symfony/twig-bridge/Extension/RoutingExtension.php line 69

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Bridge\Twig\Extension;
  14. use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
  15. use Twig\Extension\AbstractExtension;
  16. use Twig\Node\Expression\ArrayExpression;
  17. use Twig\Node\Expression\ConstantExpression;
  18. use Twig\Node\Node;
  19. use Twig\TwigFunction;
  21. /**
  22.  * Provides integration of the Routing component with Twig.
  23.  *
  24.  * @author Fabien Potencier <fabien@symfony.com>
  25.  *
  26.  * @final since Symfony 4.4
  27.  */
  28. class RoutingExtension extends AbstractExtension
  29. {
  30.     private $generator;
  32.     public function __construct(UrlGeneratorInterface $generator)
  33.     {
  34.         $this->generator = $generator;
  35.     }
  37.     /**
  38.      * {@inheritdoc}
  39.      *
  40.      * @return TwigFunction[]
  41.      */
  42.     public function getFunctions()
  43.     {
  44.         return [
  45.             new TwigFunction('url', [$this, 'getUrl'], ['is_safe_callback' => [$this, 'isUrlGenerationSafe']]),
  46.             new TwigFunction('path', [$this, 'getPath'], ['is_safe_callback' => [$this, 'isUrlGenerationSafe']]),
  47.         ];
  48.     }
  50.     /**
  51.      * @param string $name
  52.      * @param array  $parameters
  53.      * @param bool   $relative
  54.      *
  55.      * @return string
  56.      */
  57.     public function getPath($name, $parameters = [], $relative = false)
  58.     {
  59.         return $this->generator->generate($name, $parameters, $relative ? UrlGeneratorInterface::RELATIVE_PATH : UrlGeneratorInterface::ABSOLUTE_PATH);
  60.     }
  62.     /**
  63.      * @param string $name
  64.      * @param array  $parameters
  65.      * @param bool   $schemeRelative
  66.      *
  67.      * @return string
  68.      */
  69.     public function getUrl($name, $parameters = [], $schemeRelative = false)
  70.     {
  71.         return $this->generator->generate($name, $parameters, $schemeRelative ? UrlGeneratorInterface::NETWORK_PATH : UrlGeneratorInterface::ABSOLUTE_URL);
  72.     }
  74.     /**
  75.      * Determines at compile time whether the generated URL will be safe and thus
  76.      * saving the unneeded automatic escaping for performance reasons.
  77.      *
  78.      * The URL generation process percent encodes non-alphanumeric characters. So there is no risk
  79.      * that malicious/invalid characters are part of the URL. The only character within an URL that
  80.      * must be escaped in html is the ampersand ("&") which separates query params. So we cannot mark
  81.      * the URL generation as always safe, but only when we are sure there won't be multiple query
  82.      * params. This is the case when there are none or only one constant parameter given.
  83.      * E.g. we know beforehand this will be safe:
  84.      * - path('route')
  85.      * - path('route', {'param': 'value'})
  86.      * But the following may not:
  87.      * - path('route', var)
  88.      * - path('route', {'param': ['val1', 'val2'] }) // a sub-array
  89.      * - path('route', {'param1': 'value1', 'param2': 'value2'})
  90.      * If param1 and param2 reference placeholder in the route, it would still be safe. But we don't know.
  91.      *
  92.      * @param Node $argsNode The arguments of the path/url function
  93.      *
  94.      * @return array An array with the contexts the URL is safe
  95.      *
  96.      * @final
  97.      */
  98.     public function isUrlGenerationSafe(Node $argsNode): array
  99.     {
  100.         // support named arguments
  101.         $paramsNode = $argsNode->hasNode('parameters') ? $argsNode->getNode('parameters') : (
  102.             $argsNode->hasNode(1) ? $argsNode->getNode(1) : null
  103.         );
  105.         if (null === $paramsNode || $paramsNode instanceof ArrayExpression && \count($paramsNode) <= 2 &&
  106.             (!$paramsNode->hasNode(1) || $paramsNode->getNode(1) instanceof ConstantExpression)
  107.         ) {
  108.             return ['html'];
  109.         }
  111.         return [];
  112.     }
  114.     /**
  115.      * {@inheritdoc}
  116.      */
  117.     public function getName()
  118.     {
  119.         return 'routing';
  120.     }
  121. }