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

  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 class RoutingExtension extends AbstractExtension
  27. {
  28.     private UrlGeneratorInterface $generator;
  30.     public function __construct(UrlGeneratorInterface $generator)
  31.     {
  32.         $this->generator = $generator;
  33.     }
  35.     public function getFunctions(): array
  36.     {
  37.         return [
  38.             new TwigFunction('url', $this->getUrl(...), ['is_safe_callback' => $this->isUrlGenerationSafe(...)]),
  39.             new TwigFunction('path', $this->getPath(...), ['is_safe_callback' => $this->isUrlGenerationSafe(...)]),
  40.         ];
  41.     }
  43.     public function getPath(string $name, array $parameters = [], bool $relative = false): string
  44.     {
  45.         return $this->generator->generate($name, $parameters, $relative ? UrlGeneratorInterface::RELATIVE_PATH : UrlGeneratorInterface::ABSOLUTE_PATH);
  46.     }
  48.     public function getUrl(string $name, array $parameters = [], bool $schemeRelative = false): string
  49.     {
  50.         return $this->generator->generate($name, $parameters, $schemeRelative ? UrlGeneratorInterface::NETWORK_PATH : UrlGeneratorInterface::ABSOLUTE_URL);
  51.     }
  53.     /**
  54.      * Determines at compile time whether the generated URL will be safe and thus
  55.      * saving the unneeded automatic escaping for performance reasons.
  56.      *
  57.      * The URL generation process percent encodes non-alphanumeric characters. So there is no risk
  58.      * that malicious/invalid characters are part of the URL. The only character within a URL that
  59.      * must be escaped in html is the ampersand ("&") which separates query params. So we cannot mark
  60.      * the URL generation as always safe, but only when we are sure there won't be multiple query
  61.      * params. This is the case when there are none or only one constant parameter given.
  62.      * E.g. we know beforehand this will be safe:
  63.      * - path('route')
  64.      * - path('route', {'param': 'value'})
  65.      * But the following may not:
  66.      * - path('route', var)
  67.      * - path('route', {'param': ['val1', 'val2'] }) // a sub-array
  68.      * - path('route', {'param1': 'value1', 'param2': 'value2'})
  69.      * If param1 and param2 reference placeholder in the route, it would still be safe. But we don't know.
  70.      *
  71.      * @param Node $argsNode The arguments of the path/url function
  72.      *
  73.      * @return array An array with the contexts the URL is safe
  74.      */
  75.     public function isUrlGenerationSafe(Node $argsNode): array
  76.     {
  77.         // support named arguments
  78.         $paramsNode = $argsNode->hasNode('parameters') ? $argsNode->getNode('parameters') : (
  79.             $argsNode->hasNode(1) ? $argsNode->getNode(1) : null
  80.         );
  82.         if (null === $paramsNode || $paramsNode instanceof ArrayExpression && \count($paramsNode) <= 2 &&
  83.             (!$paramsNode->hasNode(1) || $paramsNode->getNode(1) instanceof ConstantExpression)
  84.         ) {
  85.             return ['html'];
  86.         }
  88.         return [];
  89.     }
  90. }