vendor/symfony/security-bundle/Templating/Helper/LogoutUrlHelper.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\SecurityBundle\Templating\Helper;
  14. @trigger_error('The '.LogoutUrlHelper::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\Security\Http\Logout\LogoutUrlGenerator;
  17. use Symfony\Component\Templating\Helper\Helper;
  19. /**
  20.  * LogoutUrlHelper provides generator functions for the logout URL.
  21.  *
  22.  * @author Jeremy Mikola <jmikola@gmail.com>
  23.  *
  24.  * @deprecated since version 4.3, to be removed in 5.0; use Twig instead.
  25.  */
  26. class LogoutUrlHelper extends Helper
  27. {
  28.     private $generator;
  30.     public function __construct(LogoutUrlGenerator $generator)
  31.     {
  32.         $this->generator = $generator;
  33.     }
  35.     /**
  36.      * Generates the absolute logout path for the firewall.
  37.      *
  38.      * @param string|null $key The firewall key or null to use the current firewall key
  39.      *
  40.      * @return string The logout path
  41.      */
  42.     public function getLogoutPath($key)
  43.     {
  44.         return $this->generator->getLogoutPath($key);
  45.     }
  47.     /**
  48.      * Generates the absolute logout URL for the firewall.
  49.      *
  50.      * @param string|null $key The firewall key or null to use the current firewall key
  51.      *
  52.      * @return string The logout URL
  53.      */
  54.     public function getLogoutUrl($key)
  55.     {
  56.         return $this->generator->getLogoutUrl($key);
  57.     }
  59.     /**
  60.      * {@inheritdoc}
  61.      */
  62.     public function getName()
  63.     {
  64.         return 'logout_url';
  65.     }
  66. }