1. class
  2. Drupal
  3. \
  4. user
  5. \
  6. Authentication
  7. \
  8. Provider
  9. \
  10. Cookie

Cookie

class Cookie implements AuthenticationProviderInterface, EventSubscriberInterface (View source)

Cookie based authentication provider.

Traits

StringTranslationTrait

Wrapper methods for \Drupal\Core\StringTranslation\TranslationInterface.

Properties

protected TranslationInterface $stringTranslation

The string translation service.

 from  StringTranslationTrait
protected SessionConfigurationInterface $sessionConfiguration

The session configuration.
protected Connection $connection

The database connection.
protected MessengerInterface $messenger

The messenger.

Methods

TranslatableMarkup
t(string $string, array $args = [], array $options = [])

Translates a string to the current language or to a given language.

from  StringTranslationTrait
formatPlural($count, $singular, $plural, array $args = [], array $options = [])

Formats a string containing a count of items.

from  StringTranslationTrait
getNumberOfPlurals($langcode = NULL)

Returns the number of plurals supported by a given language.

from  StringTranslationTrait
TranslationInterface
getStringTranslation()

Gets the string translation service.

from  StringTranslationTrait
$this
setStringTranslation(TranslationInterface $translation)

Sets the string translation service to use.

from  StringTranslationTrait
__construct(SessionConfigurationInterface $session_configuration, Connection $connection, MessengerInterface $messenger = NULL)

Constructs a new cookie authentication provider.

bool
applies(Request $request)

Checks whether suitable authentication credentials are on the request.

AccountInterface|null
authenticate(Request $request)

Authenticates the user.

AccountInterface|null
getUserFromSession(SessionInterface $session)

Returns the UserSession object for the given session.

addCheckToUrl(ResponseEvent $event)

Adds a query parameter to check successful log in redirect URL.

static array
getSubscribedEvents()

Registers the methods in this class that should be listeners.

Details

in StringTranslationTrait at line 70
protected TranslatableMarkup t(string $string, array $args = [], array $options = [])

Translates a string to the current language or to a given language.

See \Drupal\Core\StringTranslation\TranslatableMarkup::__construct() for important security information and usage guidelines.

In order for strings to be localized, make them available in one of the ways supported by the

Parameters

string $string

A string containing the English text to translate.
array $args

(optional) An associative array of replacements to make after translation. Based on the first character of the key, the value is escaped and/or themed. See \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for details.
array $options

(optional) An associative array of additional options, with the following elements:

  • 'langcode' (defaults to the current language): A language code, to translate to a language other than what is used to display the page.
  • 'context' (defaults to the empty context): The context the source string belongs to. See the @link i18n Internationalization topic @endlink for more information about string contexts.

Return Value

TranslatableMarkup

An object that, when cast to a string, returns the translated string.

See also

FormattableMarkup::placeholderFormat
TranslatableMarkup::__construct

in StringTranslationTrait at line 79
protected formatPlural($count, $singular, $plural, array $args = [], array $options = [])

Formats a string containing a count of items.

Parameters

$count
$singular
$plural
array $args
array $options

See also

TranslationInterface::formatPlural

in StringTranslationTrait at line 88
protected getNumberOfPlurals($langcode = NULL)

Returns the number of plurals supported by a given language.

Parameters

$langcode

See also

PluralFormulaInterface::getNumberOfPlurals

in StringTranslationTrait at line 102
protected TranslationInterface getStringTranslation()

Gets the string translation service.

Return Value

TranslationInterface

The string translation service.

in StringTranslationTrait at line 118
$this setStringTranslation(TranslationInterface $translation)

Sets the string translation service to use.

Parameters

TranslationInterface $translation

The string translation service.

Return Value

$this

at line 58
__construct(SessionConfigurationInterface $session_configuration, Connection $connection, MessengerInterface $messenger = NULL)

Constructs a new cookie authentication provider.

Parameters

SessionConfigurationInterface $session_configuration

The session configuration.
Connection $connection

The database connection.
MessengerInterface $messenger

The messenger.

at line 71
bool applies(Request $request)

Checks whether suitable authentication credentials are on the request.

Parameters

Request $request

The request object.

Return Value

bool

TRUE if authentication credentials suitable for this provider are on the request, FALSE otherwise.

at line 83
AccountInterface|null authenticate(Request $request)

Authenticates the user.

Parameters

Request $request

The request object.

Return Value

AccountInterface|null

AccountInterface - in case of a successful authentication. NULL - in case where authentication failed.

at line 97
protected AccountInterface|null getUserFromSession(SessionInterface $session)

Returns the UserSession object for the given session.

Parameters

SessionInterface $session

The session.

Return Value

AccountInterface|null

The UserSession object for the current user, or NULL if this is an anonymous session.

at line 127
addCheckToUrl(ResponseEvent $event)

Adds a query parameter to check successful log in redirect URL.

Parameters

ResponseEvent $event

The Event to process.

at line 150
static array getSubscribedEvents()

Registers the methods in this class that should be listeners.

Return Value

array

An array of event listener definitions.