W3cubDocs

/Symfony 2.7

Symfony\Bundle\SecurityBundle\Templating\Helper\LogoutUrlHelper

class LogoutUrlHelper extends Helper

LogoutUrlHelper provides generator functions for the logout URL.

Methods

setCharset(string $charset)

Sets the default charset.

 from Helper
string getCharset()

Gets the default charset.

 from Helper
__construct(ContainerInterface $container, UrlGeneratorInterface $router)

Constructor.
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 $key)

Generates the absolute logout path for the firewall.
string getLogoutUrl(string $key)

Generates the absolute logout URL for the firewall.
string getName()

Returns the canonical name of this helper.

Details

public setCharset(string $charset)

Sets the default charset.

Parameters

string $charset The charset

public string getCharset()

Gets the default charset.

Return Value

string The default charset

public __construct(ContainerInterface $container, UrlGeneratorInterface $router)

Constructor.

Parameters

ContainerInterface $container A ContainerInterface instance
UrlGeneratorInterface $router A Router instance

public 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

public string getLogoutPath(string $key)

Generates the absolute logout path for the firewall.

Parameters

string $key The firewall key

Return Value

string The logout path

public string getLogoutUrl(string $key)

Generates the absolute logout URL for the firewall.

Parameters

string $key The firewall key

Return Value

string The logout URL

public string getName()

Returns the canonical name of this helper.

Return Value

string The canonical name

© 2004–2016 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/2.7/Symfony/Bundle/SecurityBundle/Templating/Helper/LogoutUrlHelper.html