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'.

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.

Tags:

copyright:	Copyright (C) 2000 - 2002 Kenzaburo Ito - kenito@300baud.org
copyright:	Copyright (C) 2002 - 2010 MantisBT Team - mantisbt-dev@lists.sourceforge.net
link:	http://www.mantisbt.org
usedby:	form_api.php
uses:	gpc_api.php

Includes:

require_once('gpc_api.php') [line 36]
requires gpc_api

MantisPHPSession $g_session [line 42]

Default value:

null

[ Top ]

session_clean [line 307]

void session_clean(
)

Destroy the session entirely.

[ Top ]

session_delete [line 299]

void session_delete(
string $p_name)

Delete a session variable.

Parameters

string

$p_name

Session variable name

[ Top ]

session_get [line 242]

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

Get arbitrary data from the session.

Tags:

return:

Session variable

Parameters

string	$p_name	Session variable name
mixed	$p_default	Default value

[ Top ]

session_get_bool [line 267]

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

Get a boolean from the session.

Tags:

return:

Session variable

Parameters

string	$p_name	Session variable name
mixed	$p_default	Default value

[ Top ]

session_get_int [line 255]

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

Get an integer from the session.

Tags:

return:

Session variable

Parameters

string	$p_name	Session variable name
mixed	$p_default	Default value

[ Top ]

session_get_string [line 279]

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

Get a string from the session.

Tags:

return:

Session variable

Parameters

string	$p_name	Session variable name
mixed	$p_default	Default value

[ Top ]

session_init [line 181]

void session_init(
[string $p_session_id = null])

Initialize the appropriate session handler.

Parameters

string

$p_session_id

Session ID

[ Top ]

session_set [line 290]

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 211]

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, 12 Dec 2010 23:50:49 +0900 by phpDocumentor 1.4.3