Roundcube Webmail
Back to top  

rcube_session

Class to provide database supported session storage

package

Framework
subpackage

Core
author

Thomas Bruederli

author

Aleksander Machniak

Methods

Default constructor

__construct($db, $config)

Arguments

$db

$config

Wrapper for session_start()

start()

open

open($save_path, $session_name)

Arguments

$save_path

$session_name

close

close()

Delete session data for the given key

destroy($key)

Arguments

$key

Wrapper for session_write_close()

write_close()

Read session data from database

db_read($key) : string

Arguments

$key

Response

string

Session vars

Save session data.

db_write($key, $vars) : boolean

handler for session_read()

Arguments

$key

$vars

Response

boolean

True on success

Merge vars with old vars and apply unsets

_fixvars($vars, $oldvars)

Arguments

$vars

$oldvars

Handler for session_destroy()

db_destroy($key) : boolean

Arguments

$key

Response

boolean

True on success

Read session data from memcache

mc_read($key) : string

Arguments

$key

Response

string

Session vars

Save session data.

mc_write($key, $vars) : boolean

handler for session_read()

Arguments

$key

$vars

Response

boolean

True on success

Handler for session_destroy() with memcache backend

mc_destroy($key) : boolean

Arguments

$key

Response

boolean

True on success

Execute registered garbage collector routines

gc($maxlifetime)

Arguments

$maxlifetime

Register additional garbage collector functions

register_gc_handler($func)

Arguments

$func

Garbage collector handler to run on script shutdown

gc_shutdown()

Generate and set new session id

regenerate_id(boolean $destroy = true)

Arguments

$destroy

boolean

If enabled the current session will be destroyed

Append the given value to the certain node in the session data array

append($path, $key, $value)

Arguments

$path

$key

$value

Unset a session variable

remove($var = null) : boolean

Arguments

$var

Response

boolean

True on success

Kill this session

kill()

Re-read session data from storage backend

reload()

Returns a reference to the node in data array referenced by the given path.

get_node($path, &$data_arr)

e.g. ['compose','attachments'] will return $_SESSION['compose']['attachments']

Arguments

$path

$data_arr

Serialize session data

serialize($vars)

Arguments

$vars

Unserialize session data http://www.php.net/manual/en/function.session-decode.php#56106

unserialize($str)

Arguments

$str

Setter for session lifetime

set_lifetime($lifetime)

Arguments

$lifetime

Getter for remote IP saved with this session

get_ip()

Setter for cookie encryption secret

set_secret($secret)

Arguments

$secret

Enable/disable IP check

set_ip_check($check)

Arguments

$check

Setter for the cookie name used for session cookie

set_cookiename($cookiename)

Arguments

$cookiename

Check session authentication cookie

check_auth() : boolean

Response

boolean

True if valid, False if not

Set session authentication cookie

set_auth_cookie()

Create session cookie from session data

_mkcookie($timeslot)

Arguments

$timeslot

Writes debug information to the log

log($line)

Arguments

$line

Properties

db

db :

ip

ip :

start

start :

changed

changed :

time_diff

time_diff :

reloaded

reloaded :

appends

appends :

unsets

unsets :

gc_handlers

gc_handlers :

cookiename

cookiename :

vars

vars :

key

key :

now

now :

secret

secret :

ip_check

ip_check :

logging

logging :

storage

storage :

memcache

memcache :