vendor/symfony/symfony/src/Symfony/Bundle/FrameworkBundle/Templating/Helper/RequestHelper.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 '.RequestHelper::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\HttpFoundation\RequestStack;
  17. use Symfony\Component\Templating\Helper\Helper;
  19. /**
  20.  * RequestHelper provides access to the current request parameters.
  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 RequestHelper extends Helper
  27. {
  28.     protected $requestStack;
  30.     public function __construct(RequestStack $requestStack)
  31.     {
  32.         $this->requestStack = $requestStack;
  33.     }
  35.     /**
  36.      * Returns a parameter from the current request object.
  37.      *
  38.      * @param string $key     The name of the parameter
  39.      * @param string $default A default value
  40.      *
  41.      * @return mixed
  42.      *
  43.      * @see Request::get()
  44.      */
  45.     public function getParameter($key, $default = null)
  46.     {
  47.         return $this->getRequest()->get($key, $default);
  48.     }
  50.     /**
  51.      * Returns the locale.
  52.      *
  53.      * @return string
  54.      */
  55.     public function getLocale()
  56.     {
  57.         return $this->getRequest()->getLocale();
  58.     }
  60.     private function getRequest()
  61.     {
  62.         if (!$this->requestStack->getCurrentRequest()) {
  63.             throw new \LogicException('A Request must be available.');
  64.         }
  66.         return $this->requestStack->getCurrentRequest();
  67.     }
  69.     /**
  70.      * {@inheritdoc}
  71.      */
  72.     public function getName()
  73.     {
  74.         return 'request';
  75.     }
  76. }