Arbit - project tracking

Arbit - project tracking

API documentation :: Docs For Class arbitSessionBackend

Core::arbitSessionBackend

Class arbitSessionBackend

Arbit session backend Backend performing read and write operations to the session backend. responsible for initializing the session, if necessary. default PHP backend this means calling session_start() to send out the cookie.

Arbit session backend Backend performing read and write operations to the session backend. Also responsible for initializing the session, if necessary. For example for the default PHP backend this means calling session_start() to send out the cookie.

Implements interfaces:

  • ArrayAccess (internal interface)
Author(s):
Version:   $Revision: 1692 $
License:   GPL

Descendants

Child Class Description
arbitMemorySessionBackend Arbit memory session backend Session "backend" which keeps the data just in memory to replay it in the same request.
arbitHttpSessionBackend Arbit HTTP session backend Default HTTP session backend, using the PHP session_* functions to operate a statefull session over HTTP.

Method Summary

public abstract void initialize( )
Initializes the sessioInitializes the session
public void regenerateId( )
Regenerate ID Special function to regenerate optional user visible session IDs on certain circumstances like permission changes.
public abstract void writeClose( )
Close the session After a call to this method no more write operations are allowed to the session.

Methods

initialize

void initialize( )

Initializes the sessioInitializes the session

Initializes the sessioInitializes the session

Redefined in descendants as:
Method Description
arbitMemorySessionBackend::initialize() Initializes the sessioInitializes the session 
arbitHttpSessionBackend::initialize() Initializes the sessioInitializes the session 

regenerateId

void regenerateId( )

Regenerate ID Special function to regenerate optional user visible session IDs on certain circumstances like permission changes.

Regenerate ID Special function to regenerate optional user visible session IDs on certain circumstances like permission changes. Important for HTTP based sessions, default implementation just does nothing, because other backend most probably won't care.

writeClose

void writeClose( )

Close the session After a call to this method no more write operations are allowed to the session.

Close the session After a call to this method no more write operations are allowed to the session.

Redefined in descendants as:
Method Description
arbitMemorySessionBackend::writeClose() Close the session After a call to this method no more write operations are allowed to the session. 
arbitHttpSessionBackend::writeClose() Close the session After a call to this method no more write operations are allowed to the session. 
Documentation generated on Mon, 05 Apr 2010 14:01:36 +0200 by phpDocumentor 1.4.3