[ Index ]

PHP Cross Reference of MantisBT

title

Body

[close]

/core/ -> session_api.php (summary)

Session API Handles user/browser sessions in an extendable manner. New session handlers can be added and configured without affecting how the API is used. Calls to session_*() are appropriately directed at the session handler class as chosen in config_inc.php.

Copyright: Copyright (C) 2000 - 2002 Kenzaburo Ito - kenito@300baud.org
Copyright: Copyright (C) 2002 - 2011 MantisBT Team - mantisbt-dev@lists.sourceforge.net
File Size: 329 lines (8 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

MantisPHPSession:: (14 methods):
  __construct()
  get()
  set()
  delete()
  destroy()
  session_init()
  session_validate()
  session_get()
  session_get_int()
  session_get_bool()
  session_get_string()
  session_set()
  session_delete()
  session_clean()


Class: MantisPHPSession  - X-Ref

Implementation of the abstract MantisBT session interface using
standard PHP sessions stored on the server's filesystem according
to PHP's session.* settings in 'php.ini'.

__construct( $p_session_id=null )   X-Ref
Constructor


get( $p_name, $p_default=null )   X-Ref
get session data

param: string $p_name
param: mixed $p_default

set( $p_name, $p_value )   X-Ref
set session data

param: string $p_name
param: mixed $p_value

delete( $p_name )   X-Ref
delete session data

param: string $p_name

destroy()   X-Ref
destroy session


session_init( $p_session_id=null )   X-Ref
Initialize the appropriate session handler.

param: string Session ID

session_validate( $p_session )   X-Ref
Validate the legitimacy of a session.
Checks may include last-known IP address, or more.
Triggers an error when the session is invalid.

param: object Session object

session_get( $p_name, $p_default = null )   X-Ref
Get arbitrary data from the session.

param: string Session variable name
param: mixed Default value
return: mixed Session variable

session_get_int( $p_name, $p_default = null )   X-Ref
Get an integer from the session.

param: string Session variable name
param: mixed Default value
return: int Session variable

session_get_bool( $p_name, $p_default = null )   X-Ref
Get a boolean from the session.

param: string Session variable name
param: mixed Default value
return: boolean Session variable

session_get_string( $p_name, $p_default = null )   X-Ref
Get a string from the session.

param: string Session variable name
param: mixed Default value
return: string Session variable

session_set( $p_name, $p_value )   X-Ref
Set a session variable.

param: string Session variable name
param: mixed Variable value

session_delete( $p_name )   X-Ref
Delete a session variable.

param: string Session variable name

session_clean()   X-Ref
Destroy the session entirely.




Generated: Thu Jul 28 15:48:31 2011 Cross-referenced by PHPXref 0.7