Docs For Class HTTP

[line 104]
Class for managing HTTP sessions

Provides access to session-state values as well as session-level settings and lifetime management methods. Based on the standart PHP session handling mechanism it provides for you more advanced features such as database container, idle and expire timeouts, etc.

Example 1:

 // Setting some options and detecting of a new session

 HTTP_Session::setCookieless(false);
 HTTP_Session::start('MySessionID');
 HTTP_Session::set('variable', 'Tet string');
 if (HTTP_Session::isNew()) {
     echo('new session was created with the current request');
     $visitors++; // Increase visitors count
 }
 
 //HTTP_Session::regenerateId();

Example 2:

 // Using database container

 HTTP_Session::setContainer('DB');
 HTTP_Session::start();

Example 3:

 // Setting timeouts

 HTTP_Session::start();
 HTTP_Session::setExpire(time() + 60 * 60); // expires in one hour
 HTTP_Session::setIdle(time()+ 10 * 60);    // idles in ten minutes
 if (HTTP_Session::isExpired()) {
     // expired
     echo('Your session is expired!');
     HTTP_Session::destroy();
 }
 if (HTTP_Session::isIdle()) {
     // idle
     echo('You've been idle for too long!');
     HTTP_Session::destroy();
 }
 HTTP_Session::updateIdle();

Author: Torsten Roehr <torsten.roehr@gmx.de>
Author: David Costa <gurugeek@php.net>
Author: Michael Metz <pear.metz@speedpartner.de>
Author: Stefan Neufeind <pear.neufeind@speedpartner.de>
Version: Release: @package_version@
Copyright: 1997-2005 The PHP Group
Link: http://pear.php.net/package/HTTP_Session
Since: Class available since Release 0.4.0
License: PHP License 3.0

clear [line 275]

void clear(
)

Free all session variables

Todo: TODO Save expire and idle timestamps?
Access: public

[ Top ]

destroy [line 208]

void destroy(
)

Frees all session variables and destroys all data registered to a session

This method resets the $_SESSION variable and destroys all of the data associated with the current session in its storage (file or DB). It forces new session to be started after this method is called. It does not unset the session cookie.

See: session_destroy()
See: session_unset()
Access: public

[ Top ]

get [line 560]

mixed get(
string
$name, [mixed
$default = null])

Returns session variable

Return: Value of a variable
Access: public

Parameters:

string	`$name`	—	Name of a variable
mixed	`$default`	—	Default value of a variable if not set

[ Top ]

getLocal [line 655]

mixed &getLocal(
string
$name, [mixed
$default = null])

Returns local variable of a script

Two scripts can have local variables with the same names

Return: Value of a local variable
Access: public

Parameters:

string	`$name`	—	Name of a variable
mixed	`$default`	—	Default value of a variable if not set

[ Top ]

getRef [line 578]

mixed &getRef(
string
$name)

Returns session variable by reference

Return: Value of a variable
Access: public

Parameters:

string $name — Name of a variable

[ Top ]

id [line 331]

string id(
[string
$id = null])

Sets new ID of a session

Return: Previous ID of a session
See: session_id()
Access: public

Parameters:

string $id — New ID of a session

[ Top ]

isExpired [line 413]

bool isExpired(
)

Check if session is expired

Access: public

[ Top ]

isIdle [line 430]

bool isIdle(
)

Check if session is idle

Access: public

[ Top ]

isNew [line 489]

bool isNew(
)

Gets a value indicating whether the session was created with the current request

You MUST call this method only after you have started the session with the HTTP_Session::start() method.

Return: True if the session was created with the current request, false otherwise
Access: public

[ Top ]

is_set [line 638]

bool is_set(
string
$name)

Checks if a session variable is set

Access: public

Parameters:

string $name — Variable name

[ Top ]

localName [line 704]

string localName(
[string
$name = null])

Sets new local name

Return: Previous local name
Access: public

Parameters:

string $name — New local name

[ Top ]

name [line 316]

string name(
[string
$name = null])

Sets new name of a session

Return: Previous name of a session
See: session_name()
Access: public

Parameters:

string $name — New name of a session

[ Top ]

pause [line 187]

void pause(
)

Writes session data and ends session

Session data is usually stored after your script terminated without the need to call HTTP_Session::stop(), but as session data is locked to prevent concurrent writes only one script may operate on a session at any time. When using framesets together with sessions you will experience the frames loading one by one due to this locking. You can reduce the time needed to load all the frames by ending the session as soon as all changes to session variables are done.

See: session_write_close()
Access: public

[ Top ]

regenerateId [line 230]

bool regenerateId(
[bool
$deleteOldSessionData = false])

Calls session_regenerate_id() if available

Access: public

Parameters:

bool $deleteOldSessionData — Whether to delete data of old session

[ Top ]

register [line 512]

bool register(
string
$name)

See: session_register()
Deprecated: Use set()/setRef() instead
Access: public

Parameters:

string $name — Name of a global variable

[ Top ]

registered [line 545]

bool registered(
string
$name)

Checks if a session variable is registered

Deprecated: Use is_set() instead
Access: public

Parameters:

string $name — Variable name

[ Top ]

replicate [line 262]

bool replicate(
string
$targetTable, [string
$id = null])

This function copies session data of specified id to specified table

Access: public

Parameters:

string	`$targetTable`	—	Table to replicate data to
string	`$id`	—	ID of the session

[ Top ]

sessionValidThru [line 395]

integer sessionValidThru(
)

Returns the time up to the session is valid

Return: Time when the session idles
Access: public

[ Top ]

set [line 599]

mixed set(
string
$name, mixed
$value)

Sets session variable

Return: Old value of a variable
Access: public

Parameters:

string	`$name`	—	Name of a variable
mixed	`$value`	—	Value of a variable

[ Top ]

setContainer [line 123]

void setContainer(
string
$container, [array
$container_options = null])

Sets user-defined session storage functions

Sets the user-defined session storage functions which are used for storing and retrieving data associated with a session. This is most useful when a storage method other than those supplied by PHP sessions is preferred. i.e. Storing the session data in a local database.

See: session_set_save_handler()
Access: public

Parameters:

string	`$container`	—	Container name
array	`$container_options`	—	Container options

[ Top ]

setExpire [line 346]

void setExpire(
integer
$time, [bool
$add = false])

Sets the maximum expire time

Access: public

Parameters:

integer	`$time`	—	Time in seconds
bool	`$add`	—	Add time to current expire time or not

[ Top ]

setGcMaxLifetime [line 767]

bool setGcMaxLifetime(
[bool
$gcMaxLifetime = null])

If optional parameter is specified it determines the number of seconds after which session data will be seen as 'garbage' and cleaned up

It returns the previous value of this property

Return: The previous value of the property
Access: public

Parameters:

bool $gcMaxLifetime — If specified it will replace the previous value of this property

[ Top ]

setGcProbability [line 790]

bool setGcProbability(
[bool
$gcProbability = null])

If optional parameter is specified it determines the probability that the gc (garbage collection) routine is started and session data is cleaned up

It returns the previous value of this property

Return: The previous value of the property
Access: public

Parameters:

bool $gcProbability — If specified it will replace the previous value of this property

[ Top ]

setIdle [line 376]

void setIdle(
int
$time, [bool
$add = false])

Sets the maximum idle time

Sets the time-out period allowed between requests before the session-state provider terminates the session.

Access: public

Parameters:

int	`$time`	—	Time in seconds
bool	`$add`	—	Add time to current maximum idle time or not

[ Top ]

setLocal [line 678]

mixed setLocal(
string
$name, mixed
$value)

Sets local variable of a script.

Two scripts can have local variables with the same names.

Return: Old value of a local variable
Access: public

Parameters:

string	`$name`	—	Name of a local variable
mixed	`$value`	—	Value of a local variable

[ Top ]

setRef [line 620]

mixed setRef(
string
$name, 
&$value, mixed
$value)

Sets session variable by reference

Return: Old value of a variable
Access: public

Parameters:

string	`$name`	—	Name of a variable
mixed	`$value`	—	Value of a variable
	`&$value`	—

[ Top ]

start [line 153]

void start(
[string
$name = 'SessionID'], [string
$id = null])

Initializes session data

Creates a session (or resumes the current one based on the session id being passed via a GET variable or a cookie). You can provide your own name and/or id for a session.

See: session_start()
See: session_id()
See: session_name()
Access: public

Parameters:

string	`$name`	—	string Name of a session, default is 'SessionID'
string	`$id`	—	string Id of a session which will be used only when the session is new

[ Top ]

unregister [line 529]

bool unregister(
string
$name)

Unregister a variable from the current session

See: session_unregister()
Deprecated: Use get()/getRef() instead
Access: public

Parameters:

string $name — Name of a global variable

[ Top ]

updateIdle [line 448]

void updateIdle(
)

Updates the idletime

Access: public

[ Top ]

useCookies [line 468]

bool useCookies(
[bool
$useCookies = null])

If optional parameter is specified it indicates whether the module will use cookies to store the session id on the client side

It returns the previous value of this property

Return: The previous value of the property
Access: public

Parameters:

bool $useCookies — If specified it will replace the previous value of this property

[ Top ]

useTransSID [line 745]

bool useTransSID(
[bool
$useTransSID = null])

If optional parameter is specified it indicates whether the session id will automatically be appended to all links

It returns the previous value of this property

Return: The previous value of the property
Access: public

Parameters:

bool $useTransSID — If specified it will replace the previous value of this property

[ Top ]

Class: HTTP_Session

Class Overview

Author(s):

Version:

Copyright:

Methods

Inherited Variables

Inherited Methods

Class Details

Method Detail

clear [line 275]

destroy [line 208]

get [line 560]

Parameters:

getLocal [line 655]

Parameters:

getRef [line 578]

Parameters:

id [line 331]

Parameters:

isExpired [line 413]

isIdle [line 430]

isNew [line 489]

is_set [line 638]

Parameters:

localName [line 704]

Parameters:

name [line 316]

Parameters:

pause [line 187]

regenerateId [line 230]

Parameters:

register [line 512]

Parameters:

registered [line 545]

Parameters:

replicate [line 262]

Parameters:

sessionValidThru [line 395]

set [line 599]

Parameters:

setContainer [line 123]

Parameters:

setExpire [line 346]

Parameters:

setGcMaxLifetime [line 767]

Parameters:

setGcProbability [line 790]

Parameters:

setIdle [line 376]

Parameters:

setLocal [line 678]

Parameters:

setRef [line 620]

Parameters:

start [line 153]

Parameters:

unregister [line 529]

Parameters:

updateIdle [line 448]

useCookies [line 468]

Parameters:

useTransSID [line 745]

Parameters: