W3cubDocs

/Symfony 2.8

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|LogoutUrlGenerator $generator, UrlGeneratorInterface $router = null, TokenStorageInterface $tokenStorage = null)

Constructor.
string getLogoutPath(string|null $key)

Generates the absolute logout path for the firewall.
string getLogoutUrl(string|null $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|LogoutUrlGenerator $generator, UrlGeneratorInterface $router = null, TokenStorageInterface $tokenStorage = null)

Constructor.

Parameters

ContainerInterface|LogoutUrlGenerator $generator A ContainerInterface or LogoutUrlGenerator instance
UrlGeneratorInterface $router The router service
TokenStorageInterface $tokenStorage The token storage service

public string getLogoutPath(string|null $key)

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

public string getLogoutUrl(string|null $key)

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

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.8/Symfony/Bundle/SecurityBundle/Templating/Helper/LogoutUrlHelper.html