vendor/symfony/symfony/src/Symfony/Bundle/FrameworkBundle/Templating/Helper/RouterHelper.php line 14

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\Bundle\FrameworkBundle\Templating\Helper;
  14. @trigger_error('The '.RouterHelper::class.' class is deprecated since version 4.3 and will be removed in 5.0; use Twig instead.', \E_USER_DEPRECATED);
  16. use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
  17. use Symfony\Component\Templating\Helper\Helper;
  19. /**
  20.  * RouterHelper manages links between pages in a template context.
  21.  *
  22.  * @author Fabien Potencier <fabien@symfony.com>
  23.  *
  24.  * @deprecated since version 4.3, to be removed in 5.0; use Twig instead.
  25.  */
  26. class RouterHelper extends Helper
  27. {
  28.     protected $generator;
  30.     public function __construct(UrlGeneratorInterface $router)
  31.     {
  32.         $this->generator = $router;
  33.     }
  35.     /**
  36.      * Generates a URL reference (as an absolute or relative path) to the route with the given parameters.
  37.      *
  38.      * @param string $name       The name of the route
  39.      * @param mixed  $parameters An array of parameters
  40.      * @param bool   $relative   Whether to generate a relative or absolute path
  41.      *
  42.      * @return string The generated URL reference
  43.      *
  44.      * @see UrlGeneratorInterface
  45.      */
  46.     public function path($name, $parameters = [], $relative = false)
  47.     {
  48.         return $this->generator->generate($name, $parameters, $relative ? UrlGeneratorInterface::RELATIVE_PATH : UrlGeneratorInterface::ABSOLUTE_PATH);
  49.     }
  51.     /**
  52.      * Generates a URL reference (as an absolute URL or network path) to the route with the given parameters.
  53.      *
  54.      * @param string $name           The name of the route
  55.      * @param mixed  $parameters     An array of parameters
  56.      * @param bool   $schemeRelative Whether to omit the scheme in the generated URL reference
  57.      *
  58.      * @return string The generated URL reference
  59.      *
  60.      * @see UrlGeneratorInterface
  61.      */
  62.     public function url($name, $parameters = [], $schemeRelative = false)
  63.     {
  64.         return $this->generator->generate($name, $parameters, $schemeRelative ? UrlGeneratorInterface::NETWORK_PATH : UrlGeneratorInterface::ABSOLUTE_URL);
  65.     }
  67.     /**
  68.      * {@inheritdoc}
  69.      */
  70.     public function getName()
  71.     {
  72.         return 'router';
  73.     }
  74. }