AfsUserSessionManager Class Reference

Manages user and session identifiers. More...

Public Member Functions
	__construct ($user_id_cookie='AfsUserId', $session_id_cookie='AfsSessionId')
	Constructs new instance of the manager.
	get_user_id ()
	Retrieves user id from cookies.
	get_session_id ()
	Retrieves session id from cookies.
	set_user_id ($value)
	Defines user id cookie.
	set_session_id ($value)
	Defines session id cookie.
	set_session_timeout ($seconds)
	Defines session timeout (seconds)

Detailed Description

Manages user and session identifiers.

These identifiers are stored in cookies which are sent to the client and read from client queries.

Default cookie names are used but they can be overloaded while instanciating this class.
User identifier never expires whereas session identifier expires after 30 minutes (default). Session identifier timeout can be modified by calling AfsUserSessionManager::set_session_timeout method.

Constructor & Destructor Documentation

__construct	(		$user_id_cookie = 'AfsUserId',
			$session_id_cookie = 'AfsSessionId'
	)

Constructs new instance of the manager.

Parameters

$user_id_cookie	[in] name of the userId cookie (default='AfsUserId').
$session_id_cookie	[in] name of the sessionId cookie (default='AfsSessionId').

Member Function Documentation

get_session_id

(

)

Retrieves session id from cookies.

Returns

cookie corresponding to session identifier or null if unset.

get_user_id

(

)

Retrieves user id from cookies.

Returns

cookie corresponding to user identifier or null if unset.

set_session_id

(

$value

)

Defines session id cookie.

This method should be called before any output is sent to the client.

Parameters

$value

[in] value to assign to session identifier cookie.

set_session_timeout

(

$seconds

)

Defines session timeout (seconds)

Parameters

$seconds

[in] session timeout in seconds since last access.

set_user_id

(

$value

)

Defines user id cookie.

This method should be called before any output is sent to the client.

Parameters

$value

[in] value to assign to user identifier cookie.