vendor/symfony/twig-bridge/Extension/LogoutUrlExtension.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\Security\Http\Logout\LogoutUrlGenerator;
  15. use Twig\Extension\AbstractExtension;
  16. use Twig\TwigFunction;
  18. /**
  19.  * LogoutUrlHelper provides generator functions for the logout URL to Twig.
  20.  *
  21.  * @author Jeremy Mikola <jmikola@gmail.com>
  22.  */
  23. final class LogoutUrlExtension extends AbstractExtension
  24. {
  25.     private LogoutUrlGenerator $generator;
  27.     public function __construct(LogoutUrlGenerator $generator)
  28.     {
  29.         $this->generator = $generator;
  30.     }
  32.     public function getFunctions(): array
  33.     {
  34.         return [
  35.             new TwigFunction('logout_url', $this->getLogoutUrl(...)),
  36.             new TwigFunction('logout_path', $this->getLogoutPath(...)),
  37.         ];
  38.     }
  40.     /**
  41.      * Generates the relative logout URL for the firewall.
  42.      *
  43.      * @param string|null $key The firewall key or null to use the current firewall key
  44.      */
  45.     public function getLogoutPath(string $key = null): string
  46.     {
  47.         return $this->generator->getLogoutPath($key);
  48.     }
  50.     /**
  51.      * Generates the absolute logout URL for the firewall.
  52.      *
  53.      * @param string|null $key The firewall key or null to use the current firewall key
  54.      */
  55.     public function getLogoutUrl(string $key = null): string
  56.     {
  57.         return $this->generator->getLogoutUrl($key);
  58.     }
  59. }