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\Request;
  17. use Symfony\Component\HttpFoundation\RequestStack;
  18. use Symfony\Component\Templating\Helper\Helper;
  20. /**
  21.  * RequestHelper provides access to the current request parameters.
  22.  *
  23.  * @author Fabien Potencier <fabien@symfony.com>
  24.  *
  25.  * @deprecated since version 4.3, to be removed in 5.0; use Twig instead.
  26.  */
  27. class RequestHelper extends Helper
  28. {
  29.     protected $requestStack;
  31.     public function __construct(RequestStack $requestStack)
  32.     {
  33.         $this->requestStack = $requestStack;
  34.     }
  36.     /**
  37.      * Returns a parameter from the current request object.
  38.      *
  39.      * @param string $key     The name of the parameter
  40.      * @param string $default A default value
  41.      *
  42.      * @return mixed
  43.      *
  44.      * @see Request::get()
  45.      */
  46.     public function getParameter($key, $default = null)
  47.     {
  48.         return $this->getRequest()->get($key, $default);
  49.     }
  51.     /**
  52.      * Returns the locale.
  53.      *
  54.      * @return string
  55.      */
  56.     public function getLocale()
  57.     {
  58.         return $this->getRequest()->getLocale();
  59.     }
  61.     private function getRequest(): Request
  62.     {
  63.         if (!$this->requestStack->getCurrentRequest()) {
  64.             throw new \LogicException('A Request must be available.');
  65.         }
  67.         return $this->requestStack->getCurrentRequest();
  68.     }
  70.     /**
  71.      * {@inheritdoc}
  72.      */
  73.     public function getName()
  74.     {
  75.         return 'request';
  76.     }
  77. }