www.aleph1.co.uk Git - yaffs-website/blob - web/core/lib/Drupal/Core/Session/SessionConfigurationInterface.php

   1 <?php
   2
   3 namespace Drupal\Core\Session;
   4
   5 use Symfony\Component\HttpFoundation\Request;
   6
   7 /**
   8  * Defines an interface for session configuration generators.
   9  */
  10 interface SessionConfigurationInterface {
  11
  12   /**
  13    * Determines whether a session identifier is on the request.
  14    *
  15    * This method detects whether a session was started during one of the
  16    * previous requests from the same user agent. Session identifiers are
  17    * normally passed along using cookies and hence a typical implementation
  18    * checks whether the session cookie is on the request.
  19    *
  20    * @param \Symfony\Component\HttpFoundation\Request $request
  21    *   The request.
  22    *
  23    * @return bool
  24    *   TRUE if there is a session identifier on the request.
  25    */
  26   public function hasSession(Request $request);
  27
  28   /**
  29    * Returns a list of options suitable for passing to the session storage.
  30    *
  31    * @see \Symfony\Component\HttpFoundation\Session\Storage\NativeSessionStorage::__construct()
  32    *
  33    * @param \Symfony\Component\HttpFoundation\Request $request
  34    *   The request.
  35    *
  36    * @return array
  37    *   An associative array of session ini settings.
  38    */
  39   public function getOptions(Request $request);
  40
  41 }