Packageindex Classtrees Modulegroups Elementlist Report XML Files

File: /home/mitarbeiter/sven/public_html/tmp/devcon_php_base/dbi/dbsession.class
dev/con php base - Database interfaces

DBSESSION

DBSESSION

Databased session management.

 

public class DBSESSION

Databased session management.

 

Public Method Summary

void

&DBSESSION(object dbctrl &$db, [ integer $time_to_live ])

Set up a session manager.
void

define_tables()

Define the SQL tables used for session storage.
void

force_key()

Create a new session if none already exists.
void

lock()

Lock current session forever.
void

destroy()

Destroy current session.
string

key()

Get current session key.
int

id()

Get internal numeric session id.
void

set(string $entry, mixed $data)

Store data in a session entry.
void

clear(string $entry)

Unset a session entry.
void

get(string $entry)

Get a session entry.
void

set_timeout(integer $seconds)

Set timeout for this manager.
void

set_table(string $table)

Set name of sql table where sesuibs are stored.

Private Method Summary

void

_clear()

Initialize this manager.
void

_write()

Write out session data to database.
void

read_id( $key)

Warning: documentation is missing.

Private Field Summary

unknown

$_db

unknown

$_key

unknown

$_id

integer

$_ttl

unknown

$_data

string

$_table

Private Constant Summary

__DBI_DBSESSION >>true<< Warning: documentation is missing.

Public Method Details

&DBSESSION

public void &DBSESSION( object dbctrl &$db, [ integer $time_to_live ] )

  Set up a session manager.

Parameter
object dbctrl &$db
integer $time_to_live = >>36000<<
Number of seconds a session must be unused
before it expires.
Returns void


define_tables

public void define_tables( )

  Define the SQL tables used for session storage.

Returns void


force_key

public void force_key( )

  Create a new session if none already exists.

Returns void


lock

public void lock( )

  Lock current session forever.
A locked session can't be used nor destroyed anymore.

Returns void


destroy

public void destroy( )

  Destroy current session.
The session is removed from the database forever.

Returns void


key

public string key( )

  Get current session key.

Returns string

Session key of random alphanumeric and numeric chars.


id

public int id( )

  Get internal numeric session id.
The numeric session id should not be used in public!

Returns int

Numeric session id.


set

public void set( string $entry, mixed $data )

  Store data in a session entry.

Parameter
string $entry
Name of the entry to set.
mixed $data
Data to store.
Returns void


clear

public void clear( string $entry )

  Unset a session entry.

Parameter
string $entry
Name of the entry to set.
Returns void


get

public void get( string $entry )

  Get a session entry.

Parameter
string $entry
Name of the entry to set.
Returns void


set_timeout

public void set_timeout( integer $seconds )

  Set timeout for this manager.

Parameter
integer $seconds
Number of seconds a session must be unused before
it expires.
Returns void


set_table

public void set_table( string $table )

  Set name of sql table where sesuibs are stored.

Parameter
string $table
Table name.
Returns void


Private Method Details

_clear

private void _clear( )

  Initialize this manager.

Returns void


_write

private void _write( )

  Write out session data to database.

Returns void


read_id

private void read_id( $key )

 

Warning: documentation is missing.

Parameter
$key
Warning: documentation is missing.
Returns void


Private Field Details

$_db

private unknown $_db

>><<



$_key

private unknown $_key

>><<



$_id

private unknown $_id

>><<



$_ttl

private integer $_ttl

>>3600<<



$_data

private unknown $_data

>><<



$_table

private string $_table

>>'sessions'<<



Private Constant Details

__DBI_DBSESSION

define( __DBI_DBSESSION, >>true<< )
Case: default: case sensitive




Packageindex Classtrees Modulegroups Elementlist Report XML Files
PHPDoc 1.0beta