Arena  1.0
A content management system
 All Classes Files Functions Variables Pages
Local.Configuration.Site.Sessions Class Reference

Static Public Member Functions

def identifier
 The function used to generate session IDs (the MD5 hash value of the number of seconds since the epoch added to a random fractional variant). More...
 

Static Public Attributes

string category = "sessions"
 The name of the database table used to store session information (only change this if you know what you are doing!)
 
int visitorLength = 24
 The length of time, in seconds, alotted to anonymous visitor sessions before they expire.
 
int userLength = 15
 The length of time, in seconds, alotted to authenticated user sessions before they expire (which will require the user to log in again)
 
 userRenew = True
 Whether or not user sessions are renewed by activity (this means that, as long as the user is active on the site within the above time frame, they will not have to log in again)
 
int cleanup = 25
 The odds of running garbage collection on the sessions table. More...
 
 inCookie = True
 Whether or not to store the session ID in a cookie or assume that it will be passed as a parameter on the request line.
 
string cookieName = "sid"
 The name of the cookie or request parameter used to store the session ID.
 

Member Function Documentation

def Local.Configuration.Site.Sessions.identifier ( )
static

The function used to generate session IDs (the MD5 hash value of the number of seconds since the epoch added to a random fractional variant).

The function returned by this function should ensure a unique session ID; it will be assigned to ASession.identifier, and will become the function used to generate new session IDs when they are required.

Member Data Documentation

int Local.Configuration.Site.Sessions.cleanup = 25
static

The odds of running garbage collection on the sessions table.

A value of 100 (the default) means that, on average, every hundredth session will begin with a purge of expired session records from the table. Since this value is fed to a random number generator, these odds are only approximate.


The documentation for this class was generated from the following file: