function Cookie::applies

Same name and namespace in other branches
  1. 9 core/modules/user/src/Authentication/Provider/Cookie.php \Drupal\user\Authentication\Provider\Cookie::applies()
  2. 8.9.x core/modules/user/src/Authentication/Provider/Cookie.php \Drupal\user\Authentication\Provider\Cookie::applies()
  3. 11.x core/modules/user/src/Authentication/Provider/Cookie.php \Drupal\user\Authentication\Provider\Cookie::applies()

Checks whether suitable authentication credentials are on the request.

Parameters

\Symfony\Component\HttpFoundation\Request $request: The request object.

Return value

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

Overrides AuthenticationProviderInterface::applies

File

core/modules/user/src/Authentication/Provider/Cookie.php, line 68

Class

Cookie
Cookie based authentication provider.

Namespace

Drupal\user\Authentication\Provider

Code

public function applies(Request $request) {
  $applies = $this->sessionConfiguration
    ->hasSession($request);
  if (!$applies && $request->query
    ->has('check_logged_in')) {
    $domain = ltrim(ini_get('session.cookie_domain'), '.') ?: $request->getHttpHost();
    $this->messenger
      ->addMessage($this->t('To log in to this site, your browser must accept cookies from the domain %domain.', [
      '%domain' => $domain,
    ]), 'error');
  }
  return $applies;
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.