Docs for page session

Procedural File: session_api.php

Page Details

Session API for handling 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) 2002 - 2009 MantisBT Team - mantisbt-dev@lists.sourceforge.net
Copyright:	Copyright (C) 2000 - 2002 Kenzaburo Ito - kenito@300baud.org
Link:	http://www.mantisbt.org
Usedby:	form_api.php

Classes

Class	Description
MantisSession	Abstract interface for a MantisBT session handler.
MantisPHPSession	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'.

Functions

session_clean [line 237]

void session_clean(
)

Destroy the session entirely.

[ Top ]

session_get [line 181]

mixed session_get(
string $p_name, [mixed $p_default = null] 
)

Get arbitrary data from the session.

Parameters:

string	$p_name:	Session variable name
mixed	$p_default:	Default value

API Tags:

Return:

Session variable

[ Top ]

session_get_bool [line 206]

boolean session_get_bool(
string $p_name, [mixed $p_default = null] 
)

Get a boolean from the session.

Parameters:

string	$p_name:	Session variable name
mixed	$p_default:	Default value

API Tags:

Return:

Session variable

[ Top ]

session_get_int [line 194]

int session_get_int(
string $p_name, [mixed $p_default = null] 
)

Get an integer from the session.

Parameters:

string	$p_name:	Session variable name
mixed	$p_default:	Default value

API Tags:

Return:

Session variable

[ Top ]

session_get_string [line 218]

string session_get_string(
string $p_name, [mixed $p_default = null] 
)

Get a string from the session.

Parameters:

string	$p_name:	Session variable name
mixed	$p_default:	Default value

API Tags:

Return:

Session variable

[ Top ]

session_init [line 120]

void session_init(
[string $p_session_id = null] 
)

Initialize the appropriate session handler.

Parameters:

string

$p_session_id:

Session ID

[ Top ]

session_set [line 229]

void session_set(
string $p_name, mixed $p_value 
)

Set a session variable.

Parameters:

string	$p_name:	Session variable name
mixed	$p_value:	Variable value

[ Top ]

session_validate [line 150]

void session_validate(
object Session $p_session 
)

Validate the legitimacy of a session.

Checks may include last-known IP address, or more. Triggers an error when the session is invalid.

Parameters:

object Session

$p_session:

object

[ Top ]

Documentation generated on Sun, 05 Apr 2009 23:01:33 +0100 by phpDocumentor 1.4.1

	CoreAPI SessionAPI

[ class tree: CoreAPI ] [ index: CoreAPI ] [ all elements ]