interface SessionManagerInterface in Zircon Profile 8

Defines the session manager interface.

Hierarchy

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

File

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

Contains \Drupal\Core\Session\SessionManagerInterface.

Namespace

Drupal\Core\Session

interface SessionManagerInterface extends SessionStorageInterface {

  /**
   * Ends a specific user's session(s).
   *
   * @param int $uid
   *   User ID.
   */
  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
   */
  public function setWriteSafeHandler(WriteSafeSessionHandlerInterface $handler);

}

Members

Name	Modifiers	Type	Description	Overrides
SessionManagerInterface::delete	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	public	function	Sets the write safe session handler.	1
SessionStorageInterface::clear	public	function	Clear all session data in memory.	2
SessionStorageInterface::getBag	public	function	Gets a SessionBagInterface by name.	2
SessionStorageInterface::getId	public	function	Returns the session ID.	2
SessionStorageInterface::getMetadataBag	public	function		2
SessionStorageInterface::getName	public	function	Returns the session name.	2
SessionStorageInterface::isStarted	public	function	Checks if the session is started.	2
SessionStorageInterface::regenerate	public	function	Regenerates id that represents this storage.	2
SessionStorageInterface::registerBag	public	function	Registers a SessionBagInterface for use.	2
SessionStorageInterface::save	public	function	Force the session to be saved and closed.	2
SessionStorageInterface::setId	public	function	Sets the session ID.	2
SessionStorageInterface::setName	public	function	Sets the session name.	2
SessionStorageInterface::start	public	function	Starts the session.	2