interface SessionManagerInterface

Same name and namespace in other branches
  1. 11.x core/lib/Drupal/Core/Session/SessionManagerInterface.php \Drupal\Core\Session\SessionManagerInterface
  2. 10 core/lib/Drupal/Core/Session/SessionManagerInterface.php \Drupal\Core\Session\SessionManagerInterface
  3. 9 core/lib/Drupal/Core/Session/SessionManagerInterface.php \Drupal\Core\Session\SessionManagerInterface
  4. 8.9.x core/lib/Drupal/Core/Session/SessionManagerInterface.php \Drupal\Core\Session\SessionManagerInterface

Defines the session manager interface.

Hierarchy

  • interface \Drupal\Core\Session\SessionManagerInterface extends \Symfony\Component\HttpFoundation\Session\Storage\SessionStorageInterface

Expanded class hierarchy of SessionManagerInterface

All classes that implement SessionManagerInterface

File

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

Namespace

Drupal\Core\Session
View source
interface SessionManagerInterface extends SessionStorageInterface {
  
  /**
   * Ends a specific user's session(s).
   *
   * @param int $uid
   *   User ID.
   *
   * @deprecated in drupal:11.4.0 and is removed from drupal:12.0.0. Use
   * Drupal\user\UserSessionRepositoryInterface::deleteAll() instead.
   * @see https://www.drupal.org/node/3570851
   */
  public function delete($uid);
  
  /**
   * Destroys the current session and removes session cookies.
   */
  public function destroy();
  
  /**
   * Sets the write safe session handler.
   *
   * @todo This should be removed once all database queries are removed from
   *   the session manager class.
   *
   * @var \Drupal\Core\Session\WriteSafeSessionHandlerInterface
   *
   * @deprecated in drupal:11.4.0 and is removed from drupal:12.0.0. There is no
   * replacement.
   * @see https://www.drupal.org/node/3570851
   */
  public function setWriteSafeHandler(WriteSafeSessionHandlerInterface $handler);

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overrides
SessionManagerInterface::delete Deprecated public function Ends a specific user's session(s). 1
SessionManagerInterface::destroy public function Destroys the current session and removes session cookies. 1
SessionManagerInterface::setWriteSafeHandler Deprecated public function Sets the write safe session handler. 1

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