1. class
  2. Symfony
  3. Component
  4. Security
  5. Http
  6. Logout
  7. LogoutUrlGenerator

LogoutUrlGenerator

class LogoutUrlGenerator

Provides generator functions for the logout URL.

Methods

__construct(RequestStack $requestStack = null, UrlGeneratorInterface $router = null, TokenStorageInterface $tokenStorage = null)

No description

registerListener(string $key, string $logoutPath, string $csrfTokenId, string $csrfParameter, CsrfTokenManagerInterface $csrfTokenManager = null)

Registers a firewall's LogoutListener, allowing its URL to be generated.

string
getLogoutPath(string|null $key = null)

Generates the absolute logout path for the firewall.

string
getLogoutUrl(string|null $key = null)

Generates the absolute logout URL for the firewall.

Details

at line line 32
__construct(RequestStack $requestStack = null, UrlGeneratorInterface $router = null, TokenStorageInterface $tokenStorage = null)

Parameters

RequestStack $requestStack
UrlGeneratorInterface $router
TokenStorageInterface $tokenStorage

at line line 48
registerListener(string $key, string $logoutPath, string $csrfTokenId, string $csrfParameter, CsrfTokenManagerInterface $csrfTokenManager = null)

Registers a firewall's LogoutListener, allowing its URL to be generated.

Parameters

string $key The firewall key
string $logoutPath The path that starts the logout process
string $csrfTokenId The ID of the CSRF token
string $csrfParameter The CSRF token parameter name
CsrfTokenManagerInterface $csrfTokenManager A CsrfTokenManagerInterface instance

at line line 60
string getLogoutPath(string|null $key = null)

Generates the absolute logout path for the firewall.

Parameters

string|null $key The firewall key or null to use the current firewall key

Return Value

string The logout path

at line line 72
string getLogoutUrl(string|null $key = null)

Generates the absolute logout URL for the firewall.

Parameters

string|null $key The firewall key or null to use the current firewall key

Return Value

string The logout URL