Docs For Class rcube

rcube_session

Description

Class to provide database supported session storage

author: Thomas Bruederli <roundcube@gmail.com>
author: Aleksander Machniak <alec@alec.pl>

Located in /rcube_session.php (line 31)

Method Summary

rcube_session __construct ( $db, $config)

boolean check_auth ()

void cleanup ()

void close ()

boolean db_destroy (string $key)

boolean db_gc (string $maxlifetime)

string db_read (string $key)

boolean db_write (string $key, string $vars)

void destroy (string $key)

void gc ()

void get_ip ()

void get_keep_alive ()

void kill ()

void log ( $line)

boolean mc_destroy (string $key)

string mc_read (string $key)

boolean mc_write (string $key, string $vars)

void open ( $save_path, $session_name)

void regenerate_id ([boolean $destroy = true])

void register_gc_handler (mixed $func_name)

boolean remove ([string $var = null])

void set_auth_cookie ()

void set_cookiename ( $cookiename)

void set_ip_check ( $check)

void set_keep_alive ( $keep_alive)

void set_lifetime ( $lifetime)

void set_secret ( $secret)

void _mkcookie (int $timeslot)

Methods

Constructor __construct (line 53)

Default constructor

access: public

rcube_session __construct ( $db, $config)

$db
$config

check_auth (line 572)

Check session authentication cookie

return: True if valid, False if not

boolean check_auth ()

cleanup (line 330)

Cleanup session data before saving

access: public

void cleanup ()

close (line 103)

access: public

void close ()

db_destroy (line 225)

Handler for session_destroy()

return: True on success
access: public

boolean db_destroy (string $key)

string $key: Session ID

db_gc (line 241)

Garbage collecting function

return: True on success
access: public

boolean db_gc (string $maxlifetime)

string $maxlifetime: Session lifetime in seconds

db_read (line 126)

Read session data from database

return: Session vars
access: public

string db_read (string $key)

string $key: Session ID

db_write (line 154)

Save session data.

handler for session_read()

return: True on success
access: public

boolean db_write (string $key, string $vars)

string $key: Session ID
string $vars: Serialized session vars

destroy (line 114)

Delete session data for the given key

access: public

void destroy (string $key)

string $key: Session ID

gc (line 320)

Execute registered garbage collector routines

access: public

void gc ()

get_ip (line 535)

Getter for remote IP saved with this session

access: public

void get_ip ()

get_keep_alive (line 527)

Getter for keep_alive interval

access: public

void get_keep_alive ()

kill (line 388)

Kill this session

access: public

void kill ()

log (line 620)

void log ( $line)

$line

mc_destroy (line 311)

Handler for session_destroy() with memcache backend

return: True on success
access: public

boolean mc_destroy (string $key)

string $key: Session ID

mc_read (line 260)

Read session data from memcache

return: Session vars
access: public

string mc_read (string $key)

string $key: Session ID

mc_write (line 284)

Save session data.

handler for session_read()

return: True on success
access: public

boolean mc_write (string $key, string $vars)

string $key: Session ID
string $vars: Serialized session vars

open (line 97)

access: public

void open ( $save_path, $session_name)

$save_path
$session_name

regenerate_id (line 357)

Generate and set new session id

access: public

void regenerate_id ([boolean $destroy = true])

boolean $destroy: If enabled the current session will be destroyed

register_gc_handler (line 345)

access: public

void register_gc_handler (mixed $func_name)

mixed $func_name: Callback function

remove (line 374)

Unset a session variable

return: True on success
access: public

boolean remove ([string $var = null])

string $var: Varibale name

set_auth_cookie (line 598)

Set session authentication cookie

void set_auth_cookie ()

set_cookiename (line 560)

Setter for the cookie name used for session cookie

void set_cookiename ( $cookiename)

$cookiename

set_ip_check (line 552)

Enable/disable IP check

void set_ip_check ( $check)

$check

set_keep_alive (line 516)

Setter for keep_alive interval

access: public

void set_keep_alive ( $keep_alive)

$keep_alive

set_lifetime (line 503)

Setter for session lifetime

access: public

void set_lifetime ( $lifetime)

$lifetime

set_secret (line 543)

Setter for cookie encryption secret

void set_secret ( $secret)

$secret

_mkcookie (line 611)

Create session cookie from session data

void _mkcookie (int $timeslot)

int $timeslot: Time slot to use

Documentation generated on Tue, 04 Oct 2011 22:55:25 +0200 by phpDocumentor 1.4.3