LogoutUrlGenerator
in package
Provides generator functions for the logout URL.
Tags
Table of Contents
Properties
- $currentFirewallContext : string|null
- $currentFirewallName : string|null
- $listeners : array<string|int, mixed>
- $requestStack : mixed
- $router : mixed
- $tokenStorage : mixed
Methods
- __construct() : mixed
- getLogoutPath() : string
- Generates the absolute logout path for the firewall.
- getLogoutUrl() : string
- Generates the absolute logout URL for the firewall.
- registerListener() : mixed
- Registers a firewall's LogoutListener, allowing its URL to be generated.
- setCurrentFirewall() : mixed
- generateLogoutUrl() : string
- Generates the logout URL for the firewall.
- getListener() : array<string|int, mixed>
Properties
$currentFirewallContext
private
string|null
$currentFirewallContext
= null
$currentFirewallName
private
string|null
$currentFirewallName
= null
$listeners
private
array<string|int, mixed>
$listeners
= []
$requestStack
private
mixed
$requestStack
$router
private
mixed
$router
$tokenStorage
private
mixed
$tokenStorage
Methods
__construct()
public
__construct([RequestStack $requestStack = null ][, UrlGeneratorInterface $router = null ][, TokenStorageInterface $tokenStorage = null ]) : mixed
Parameters
- $requestStack : RequestStack = null
- $router : UrlGeneratorInterface = null
- $tokenStorage : TokenStorageInterface = null
getLogoutPath()
Generates the absolute logout path for the firewall.
public
getLogoutPath([string $key = null ]) : string
Parameters
- $key : string = null
Return values
stringgetLogoutUrl()
Generates the absolute logout URL for the firewall.
public
getLogoutUrl([string $key = null ]) : string
Parameters
- $key : string = null
Return values
stringregisterListener()
Registers a firewall's LogoutListener, allowing its URL to be generated.
public
registerListener(string $key, string $logoutPath, string|null $csrfTokenId, string|null $csrfParameter[, CsrfTokenManagerInterface $csrfTokenManager = null ][, string|null $context = null ]) : mixed
Parameters
- $key : string
-
The firewall key
- $logoutPath : string
-
The path that starts the logout process
- $csrfTokenId : string|null
-
The ID of the CSRF token
- $csrfParameter : string|null
-
The CSRF token parameter name
- $csrfTokenManager : CsrfTokenManagerInterface = null
- $context : string|null = null
-
The listener context
setCurrentFirewall()
public
setCurrentFirewall(string|null $key[, string $context = null ]) : mixed
Parameters
- $key : string|null
- $context : string = null
generateLogoutUrl()
Generates the logout URL for the firewall.
private
generateLogoutUrl(string|null $key, int $referenceType) : string
Parameters
- $key : string|null
- $referenceType : int
Return values
stringgetListener()
private
getListener(string|null $key) : array<string|int, mixed>
Parameters
- $key : string|null