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(LogoutUrlGenerator $generator) 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

setCharset(string $charset)

Sets the default charset.

Parameters

string

$charset

The charset

string getCharset()

Gets the default charset.

Return Value

string

The default charset

__construct(LogoutUrlGenerator $generator)

Constructor.

Parameters

LogoutUrlGenerator

$generator

A LogoutUrlGenerator instance

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

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

string getName()

Returns the canonical name of this helper.

Return Value

string

The canonical name

Links:

http://api.symfony.com/master/Symfony/Bundle/SecurityBundle/Templating/Helper/LogoutUrlHelper.html

doc_Symfony

2025-01-10 15:47:30

Comments