Packageindex Classtrees Modulegroups Elementlist Report XML Files

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

dbtoken

dbtoken

Databased token manager.

 

public class dbtoken

Databased token manager.
Tokens are keys associated with a dbsession object and mixed data.

 

Public Method Summary

void

write(string $name, mixed $data)

Update existing token.
void

create(mixed $data, [ string $type ])

Create a token with data and return its name.
void

dbtoken( $db, $session)

Warning: documentation is missing.

Private Method Summary

void

set_timeout( $seconds)

Warning: documentation is missing.
void

get( $token)

Warning: documentation is missing.
void

clear_all()

Warning: documentation is missing.
void

close()

Warning: documentation is missing.
void

set_table( $table_name)

Warning: documentation is missing.
void

define_database( &$def)

Warning: documentation is missing.
void

_kill_old_tokens()

Warning: documentation is missing.
void

_write_token( $name, $data, $is_onetime)

Warning: documentation is missing.
void

_write_tokens()

Warning: documentation is missing.

Private Field Summary

unknown

$_db

unknown

$_session

unknown

$_tokens

integer

$_num_tokens

integer

$_id_token

unknown

$_uniqid

string

$_token_table

Private Constant Summary

TOKEN_DEFAULT >>0<< Default token time which is erased after timeout.
TOKEN_ONETIME >>1<< Token that can be used axactly once.
TOKEN_REUSE >>2<< Token that is always reused for the same content.

Public Method Details

write

public void write( string $name, mixed $data )

  Update existing token.

Parameter
string $name
Token name.
mixed $data
new content.
Returns void


create

public void create( mixed $data, [ string $type ] )

  Create a token with data and return its name.

Parameter
mixed $data
The data that is stored in the new token.
string $type = >>TOKEN_DEFAULT<<
Token type (see constants section).
Returns void


dbtoken

public void dbtoken( $db, $session )

 

Warning: documentation is missing.

Parameter
$db
Warning: documentation is missing.
$session
Warning: documentation is missing.
Returns void


Private Method Details

set_timeout

private void set_timeout( $seconds )

 

Warning: documentation is missing.

Parameter
$seconds
Warning: documentation is missing.
Returns void


get

private void get( $token )

 

Warning: documentation is missing.

Parameter
$token
Warning: documentation is missing.
Returns void


clear_all

private void clear_all( )

 

Warning: documentation is missing.

Returns void


close

private void close( )

 

Warning: documentation is missing.

Returns void


set_table

private void set_table( $table_name )

 

Warning: documentation is missing.

Parameter
$table_name
Warning: documentation is missing.
Returns void


define_database

private void define_database( &$def )

 

Warning: documentation is missing.

Parameter
&$def
Warning: documentation is missing.
Returns void


_kill_old_tokens

private void _kill_old_tokens( )

 

Warning: documentation is missing.

Returns void


_write_token

private void _write_token( $name, $data, $is_onetime )

 

Warning: documentation is missing.

Parameter
$name
Warning: documentation is missing.
$data
Warning: documentation is missing.
$is_onetime
Warning: documentation is missing.
Returns void


_write_tokens

private void _write_tokens( )

 

Warning: documentation is missing.

Returns void


Private Field Details

$_db

private unknown $_db

>><<



$_session

private unknown $_session

>><<



$_tokens

private unknown $_tokens

>><<



$_num_tokens

private integer $_num_tokens

>>900<<



$_id_token

private integer $_id_token

>><<



$_uniqid

private unknown $_uniqid

>><<



$_token_table

private string $_token_table

>>'tokens'<<



Private Constant Details

TOKEN_DEFAULT

define( TOKEN_DEFAULT, >>0<< )
Case: default: case sensitive

Default token time which is erased after timeout.


TOKEN_ONETIME

define( TOKEN_ONETIME, >>1<< )
Case: default: case sensitive

Token that can be used axactly once.


TOKEN_REUSE

define( TOKEN_REUSE, >>2<< )
Case: default: case sensitive

Token that is always reused for the same content.



Packageindex Classtrees Modulegroups Elementlist Report XML Files
PHPDoc 1.0beta