interface CookieHelperInterface in Persistent Login 8

Interface for Persistent Login Cookie Helper services.

Hierarchy

• interface \Drupal\persistent_login\CookieHelperInterface

2 files declare their use of CookieHelperInterface

PendingPersistentLogin.php in src/PageCache/RequestPolicy/PendingPersistentLogin.php

TokenHandler.php in src/EventSubscriber/TokenHandler.php

File

src/CookieHelperInterface.php, line 10

Namespace

Drupal\persistent_login

interface CookieHelperInterface {

  /**
   * Returns the name of the persistent login cookie.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The request.
   *
   * @return string
   *   The cookie name.
   */
  public function getCookieName(Request $request);

  /**
   * Returns the value of the persistent login cookie.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The request.
   *
   * @return string
   *   The cookie value.
   */
  public function getCookieValue(Request $request);

  /**
   * Checks if a request contains a persistent login cookie.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The request.
   *
   * @return bool
   *   TRUE if the request provides a persistent login cookie.
   */
  public function hasCookie(Request $request);

}

Members

Name	Modifiers	Type	Description	Overrides
CookieHelperInterface::getCookieName	public	function	Returns the name of the persistent login cookie.	1
CookieHelperInterface::getCookieValue	public	function	Returns the value of the persistent login cookie.	1
CookieHelperInterface::hasCookie	public	function	Checks if a request contains a persistent login cookie.	1