Session Class Reference

Inheritance diagram for Session:

Collaboration diagram for Session:

Public Member Functions
	register ($things)
	is_registered ($name)
	unregister ($things)
	get_id ($id="")
	put_id ()
	delete ()
	url ($url)
	purl ($url)
	self_url ()
	pself_url ()
	hidden_session ()
	add_query ($qarray)
	padd_query ($qarray)
	serialize ($prefix, $str)
	get_lock ()
	release_lock ()
	freeze ()
	thaw ()
	reimport_get_vars ()
	reimport_post_vars ()
	reimport_cookie_vars ()
	reimport_any_vars ($arrayname)
	set_container ()
	set_tokenname ()
	release_token ()
	put_headers ()
	gc ()
	start ($sid="")
	Session ()
	start ()
	name ($name= '')
	register ($var_names)
	is_registered ($var_name)
	unregister ($var_names)
	put_id ()
	delete ()
	set_tokenname ()
	put_headers ()
	open ()
	close ()
	del ()
	freeze ($id=NULL, $sess_data=NULL)
	thaw ()
	gc ()
	set_container ()
	url ($url)
	self_url ()
	pself_url ()
	regenerate_session_id ($keep_session_vars=array())

Data Fields
	$classname = "Session"
	$magic = ""
	$mode = "cookie"
	$fallback_mode
	$lifetime = 0
	$cookie_domain = ""
	$cookie_path = "/"
	$gc_time = 1440
	$gc_probability = 1
	$auto_init = ""
	$secure_auto_init = 1
	$allowcache = "no"
	$allowcache_expire = 1440
	$that_class = ""
	$name = ""
	$id = ""
	$that
	$pt = array()
	$in = false
	$cookiename
	$trans_id_enabled = true
	$module = 'user'
	$save_path

Member Function Documentation

add_query

(

$qarray

)

close

(

)

Close callback

del

(

)

Delete callback

Here is the call graph for this function:

delete

(

)

Reimplemented in User.

delete

(

)

Delete the current session destroying all registered data.

Note that it does more but the PHP 4 session_destroy it also throws away a cookie is there's one.

Returns

boolean session_destroy return value public

Reimplemented in User.

Here is the call graph for this function:

freeze

(

)

Reimplemented in Seminar_User, and User.

Here is the call graph for this function:

freeze	(		$id = NULL,
			$sess_data = NULL
	)

Here is the call graph for this function:

gc

(

)

Reimplemented in Seminar_Session.

Here is the call graph for this function:

Here is the caller graph for this function:

gc

(

)

gc callback.

Destroy all session data older than $this->gc_time

Reimplemented in Seminar_Session.

Here is the call graph for this function:

get_id

(

$id = ""

)

Reimplemented in User, and User.

Here is the caller graph for this function:

get_lock

(

)

Here is the caller graph for this function:

hidden_session

(

)

is_registered

(

$name

)

Reimplemented in User.

is_registered

(

$var_name

)

see if a variable is registered in the current session

Parameters

$var_name

a string with the variable name

Returns

false if variable not registered true on success. public

Reimplemented in User.

name

(

$name = ''

)

Sets or returns the name of the current session

Parameters

string

If given, sets the session name

Returns

string session_name() return value public

Here is the caller graph for this function:

open

(

)

Open callback

abstract

padd_query

(

$qarray

)

pself_url

(

)

pself_url

(

)

Here is the call graph for this function:

purl

(

$url

)

put_headers

(

)

?

put_headers

(

)

Here is the caller graph for this function:

put_id

(

)

Reimplemented in User.

Here is the caller graph for this function:

put_id

(

)

Delete the cookie holding the session id.

RFC: is this really needed? can we prune this function? the only reason to keep it is if one wants to also unset the cookie when session_destroy()ing,which PHP doesn't seem to do (looking @ the session.c:940) uw: yes we should keep it to remain the same interface, but deprec.

public $_COOKIE

Reimplemented in User.

Here is the call graph for this function:

regenerate_session_id

(

$keep_session_vars = array()

)

Here is the call graph for this function:

register

(

$things

)

Reimplemented in User.

register

(

$var_names

)

Register the variable(s) that should become persistent.

Parameters

mixed

String with the name of one or more variables seperated by comma or a list of variables names: "foo"/"foo,bar,baz"/{"foo","bar","baz"} public

Reimplemented in User.

reimport_any_vars

(

$arrayname

)

Here is the caller graph for this function:

reimport_cookie_vars

(

)

Here is the call graph for this function:

reimport_get_vars

(

)

Here is the call graph for this function:

reimport_post_vars

(

)

Here is the call graph for this function:

release_lock

(

)

Here is the caller graph for this function:

release_token

(

)

Here is the call graph for this function:

Here is the caller graph for this function:

self_url

(

)

Here is the caller graph for this function:

self_url

(

)

serialize	(		$prefix,
			$str
	)

Here is the caller graph for this function:

Session

(

)

Sets the session name before the session starts.

Make sure that all derived classes call the constructor

See Also

name()

Here is the call graph for this function:

Here is the caller graph for this function:

set_container

(

)

Here is the caller graph for this function:

set_container

(

)

?

set_tokenname

(

)

?

Here is the call graph for this function:

set_tokenname

(

)

Here is the call graph for this function:

Here is the caller graph for this function:

start

(

)

Start a new session or recovers from an existing session

Returns

boolean session_start() return value public

Here is the call graph for this function:

Here is the caller graph for this function:

start

(

$sid = ""

)

Reimplemented in Seminar_User, User, and User.

Here is the call graph for this function:

thaw

(

)

Reimplemented in User.

Here is the call graph for this function:

Here is the caller graph for this function:

thaw

(

)

Read callback.

Reimplemented in User.

Here is the call graph for this function:

unregister

(

$things

)

Reimplemented in User.

unregister

(

$var_names

)

Recall the session registration for named variable(s)

Parameters

mixed

String with the name of one or more variables seperated by comma or a list of variables names: "foo"/"foo,bar,baz"/{"foo","bar","baz"} public

Reimplemented in User.

url

(

$url

)

url

(

$url

)

Field Documentation

$allowcache = "no"

$allowcache_expire = 1440

$auto_init = ""

$classname = "Session"

Session name

$cookie_domain = ""

$cookie_path = "/"

$cookiename

$fallback_mode

$gc_probability = 1

$gc_time = 1440

$id = ""

$in = false

$lifetime = 0

$magic = ""

$mode = "cookie"

$module = 'user'

$name = ""

$pt = array()

$save_path

$secure_auto_init = 1

$that

$that_class = ""

Name of data storage container

var string

$trans_id_enabled = true

---

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

• lib/phplib/session.inc
• lib/phplib/session4_custom.inc