interface SessionConfigurationInterface in Drupal 9

Defines an interface for session configuration generators.

Hierarchy

• interface \Drupal\Core\Session\SessionConfigurationInterface

8 files declare their use of SessionConfigurationInterface

BigPipeStrategy.php in core/modules/big_pipe/src/Render/Placeholder/BigPipeStrategy.php

BigPipeStrategyTest.php in core/modules/big_pipe/tests/src/Unit/Render/Placeholder/BigPipeStrategyTest.php

Cookie.php in core/modules/user/src/Authentication/Provider/Cookie.php

CsrfRequestHeaderAccessCheck.php in core/lib/Drupal/Core/Access/CsrfRequestHeaderAccessCheck.php

DefaultRequestPolicy.php in core/lib/Drupal/Core/PageCache/DefaultRequestPolicy.php

... See full list

File

core/lib/Drupal/Core/Session/SessionConfigurationInterface.php, line 10

Namespace

Drupal\Core\Session

interface SessionConfigurationInterface {

  /**
   * Determines whether a session identifier is on the request.
   *
   * This method detects whether a session was started during one of the
   * previous requests from the same user agent. Session identifiers are
   * normally passed along using cookies and hence a typical implementation
   * checks whether the session cookie is on the request.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The request.
   *
   * @return bool
   *   TRUE if there is a session identifier on the request.
   */
  public function hasSession(Request $request);

  /**
   * Returns a list of options suitable for passing to the session storage.
   *
   * @see \Symfony\Component\HttpFoundation\Session\Storage\NativeSessionStorage::__construct()
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The request.
   *
   * @return array
   *   An associative array of session ini settings.
   */
  public function getOptions(Request $request);

}

Members

Name	Modifiers	Type	Description	Overrides
SessionConfigurationInterface::getOptions	public	function	Returns a list of options suitable for passing to the session storage.	1
SessionConfigurationInterface::hasSession	public	function	Determines whether a session identifier is on the request.	1