Documentation

RememberMeBadge
in package
implements BadgeInterface

Adds support for remember me to this authenticator.

The presence of this badge doesn't create the remember-me cookie. The actual cookie is only created if this badge is enabled. By default, this is done by the CheckRememberMeConditionsListener if all conditions are met.

Tags
author

Wouter de Jong wouter@wouterj.nl

final

Table of Contents

Interfaces

BadgeInterface
Passport badges allow to add more information to a passport (e.g. a CSRF token).

Properties

$enabled  : bool

Methods

disable()  : $this
Disables remember-me cookie creation.
enable()  : $this
Enables remember-me cookie creation.
isEnabled()  : bool
isResolved()  : bool
Checks if this badge is resolved by the security system.

Properties

Methods

disable()

Disables remember-me cookie creation.

public disable() : $this

The default is disabled, this can be called to suppress creation after it was enabled.

Return values
$this

enable()

Enables remember-me cookie creation.

public enable() : $this

In most cases, CheckRememberMeConditionsListener enables this automatically if always_remember_me is true or the remember_me_parameter exists in the request.

Return values
$this

isResolved()

Checks if this badge is resolved by the security system.

public isResolved() : bool

After authentication, all badges must return true in this method in order for the authentication to succeed.

Return values
bool

        
On this page

Search results