interface SessionProxy_Backend_Interface in Session Proxy 7

Drupal specific session handling additions.

Hierarchy

• interface \SessionProxy_Backend_Interface

File

lib/SessionProxy/Backend/Interface.php, line 6

interface SessionProxy_Backend_Interface {

  /**
   * Enable session writing explicitely.
   *
   * This is not fail-safe, if no storage is provided by a PHP extension you
   * cannot disable session writing.
   */
  public function writeDisable();

  /**
   * Disable session writing explicitely.
   */
  public function writeEnable();

  /**
   * Is session write enabled.
   *
   * @return bool
   */
  public function isWriteEnabled();

  /**
   * Does this instance handle HTTPS diverging session name.
   *
   * @return bool
   */
  public function handleHttps();

  /**
   * Start session.
   */
  public function start();

  /**
   * Is session started.
   *
   * @return bool
   */
  public function isStarted();

  /**
   * Called during shutdown hook time, this allows you to perform additional
   * operations outside of the core PHP session handling at the end of request.
   */
  public function commit();

  /**
   * Regenerate the current session.
   */
  public function regenerate();

  /**
   * Destroy session if any
   */
  public function destroy();

  /**
   * Destroy all session for given user identifier.
   *
   * This might be silent if storage is handled by a PHP extension or if the
   * storage backend does not implement conditional cleaning.
   *
   * @param int $uid
   */
  public function destroyAllForUser($uid);

  /**
   * Delete current session cookie
   */
  public function deleteCurrentSessionCookie();

}

Members

Name	Modifiers	Type	Description	Overrides
SessionProxy_Backend_Interface::commit	public	function	Called during shutdown hook time, this allows you to perform additional operations outside of the core PHP session handling at the end of request.	1
SessionProxy_Backend_Interface::deleteCurrentSessionCookie	public	function	Delete current session cookie	1
SessionProxy_Backend_Interface::destroy	public	function	Destroy session if any	1
SessionProxy_Backend_Interface::destroyAllForUser	public	function	Destroy all session for given user identifier.	1
SessionProxy_Backend_Interface::handleHttps	public	function	Does this instance handle HTTPS diverging session name.	1
SessionProxy_Backend_Interface::isStarted	public	function	Is session started.	1
SessionProxy_Backend_Interface::isWriteEnabled	public	function	Is session write enabled.	2
SessionProxy_Backend_Interface::regenerate	public	function	Regenerate the current session.	2
SessionProxy_Backend_Interface::start	public	function	Start session.	1
SessionProxy_Backend_Interface::writeDisable	public	function	Enable session writing explicitely.	2
SessionProxy_Backend_Interface::writeEnable	public	function	Disable session writing explicitely.	2