1. class
  2. Symfony
  3. Bundle
  4. SecurityBundle
  5. Templating
  6. Helper
  7. LogoutUrlHelper

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

in Helper at line line 31
setCharset(string $charset)

Sets the default charset.

Parameters

string $charset The charset

in Helper at line line 41
string getCharset()

Gets the default charset.

Return Value

string The default charset

at line line 32
__construct(LogoutUrlGenerator $generator)

Constructor.

Parameters

LogoutUrlGenerator $generator A LogoutUrlGenerator instance

at line line 44
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

at line line 56
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

at line line 64
string getName()

Returns the canonical name of this helper.

Return Value

string The canonical name