oxSession Class Reference

Inheritance diagram for oxSession:
[legend]
Collaboration diagram for oxSession:
[legend]

List of all members.


Detailed Description

Session manager. Performs session managing function, such as variables deletion, initialisation and other session functions.

Definition at line 14 of file oxsession.php.


Public Member Functions

 getId ()
 setId ($sVal)
 setName ($sVal)
 getName ()
 start ()
 initNewSession ()
 freeze ()
 destroy ()
 url ($url)
 sid ()
 hiddenSid ()
 getBasket ()
 setBasket ($oBasket)
 delBasket ()
 isNewSession ()

Static Public Member Functions

static getInstance ()
static hasVar ($name)
static setVar ($name, $value)
static getVar ($name)
static deleteVar ($name)

Protected Member Functions

 _allowSessionStart ()
 _checkMandatoryCookieSupport ($sClass, $sFunction)
 _isSwappedClient ()
 _checkUserAgent ($sAgent, $sExistingAgent)
 _checkSid ()
 _checkCookies ($sCookieSid, $aSessCookieSetOnce)
 _setSessionId ($sSessId)
 _getBasketName ()
 _getCookieSid ()

Protected Attributes

 $_sName = 'sid'
 $_sId = null
 $_blNewSession = false
 $_sErrorMsg = null
 $_aRequireCookiesInFncs
 $_aPersistentParams = array("actshop", "lang", "currency", "language", "tpllanguage")

Static Protected Attributes

static $_blIsNewSession = false
static $_instance = null
static $_oUser = null

Member Function Documentation

static oxSession.getInstance (  )  [static]

get oxSession object instance (create if needed)

Returns:
oxSession

Definition at line 83 of file oxsession.php.

oxSession.getId (  ) 

Returns session ID

Returns:
string

Definition at line 101 of file oxsession.php.

oxSession.setId ( sVal  ) 

Sets session id

Parameters:
string $sVal id value
Returns:
null

Definition at line 113 of file oxsession.php.

oxSession.setName ( sVal  ) 

Sets session param name

Parameters:
string $sVal name value
Returns:
null

Definition at line 125 of file oxsession.php.

oxSession.getName (  ) 

Returns session param name

Returns:
string

Definition at line 135 of file oxsession.php.

oxSession.start (  ) 

Starts shop session, generates unique session ID, extracts user IP.

Exceptions:
oxSystemComponentException,oxCookieException 
Returns:
null

Definition at line 147 of file oxsession.php.

oxSession.initNewSession (  ) 

Assigns new session ID, clean existing data except persistent.

Returns:
null

Definition at line 212 of file oxsession.php.

oxSession.freeze (  ) 

Ends the current session and store session data.

Returns:
null

Definition at line 238 of file oxsession.php.

oxSession.destroy (  ) 

Destroys all data registered to a session.

Returns:
null

Definition at line 251 of file oxsession.php.

static oxSession.hasVar ( name  )  [static]

Checks if variable is set in session. Returns true on success.

Parameters:
string $name Name to check
Returns:
bool

Definition at line 265 of file oxsession.php.

static oxSession.setVar ( name,
value 
) [static]

Sets parameter and its value to global session mixedvar array.

Parameters:
string $name Name of parameter to store
mixed $value Value of parameter
Returns:
null

Definition at line 289 of file oxsession.php.

static oxSession.getVar ( name  )  [static]

IF available returns value of parameter, stored in session array.

Parameters:
string $name Name of parameter
Returns:
mixed

Definition at line 312 of file oxsession.php.

static oxSession.deleteVar ( name  )  [static]

Destroys a single element (passed to method) of an session array.

Parameters:
string $name Name of parameter to destroy
Returns:
null

Definition at line 338 of file oxsession.php.

oxSession.url ( url  ) 

Append URL with session information parameter.

Parameters:
string $url Current url
Returns:
string

Definition at line 362 of file oxsession.php.

oxSession.sid (  ) 

Returns string prefix to URL with session ID parameter. In some cases (if client is robot, such as Google) adds parameter shp, to identify, witch shop is currently running.

Returns:
string

Definition at line 413 of file oxsession.php.

oxSession.hiddenSid (  ) 

Forms input ("hidden" type) to pass session ID after submitting forms.

Returns:
string

Definition at line 445 of file oxsession.php.

oxSession.getBasket (  ) 

Returns basket session object.

Returns:
oxbasket

Definition at line 459 of file oxsession.php.

oxSession.setBasket ( oBasket  ) 

Sets basket session object.

Parameters:
object $oBasket basket object
Returns:
null

Definition at line 480 of file oxsession.php.

oxSession.delBasket (  ) 

Deletes basket session object.

Returns:
null

Definition at line 491 of file oxsession.php.

oxSession.isNewSession (  ) 

Indicates if setting of session id is executed in this script.

Returns:
bool

Definition at line 502 of file oxsession.php.

oxSession._allowSessionStart (  )  [protected]

Checks if we can start new session. Returns bool success status

Returns:
bool

Definition at line 512 of file oxsession.php.

oxSession._checkMandatoryCookieSupport ( sClass,
sFunction 
) [protected]

Checks for mandatory cookie support. Return true if the check is succseful. False means some problem occured - user has no cookies, but they are required.

Parameters:
string $sClass class name
string $sFunction function name
Returns:
null

Definition at line 538 of file oxsession.php.

oxSession._isSwappedClient (  )  [protected]

Saves various visitor parameters and compares with current data. Returns true if any change is detected. Using this method we can detect different visitor with same session id.

Returns:
bool

Definition at line 566 of file oxsession.php.

oxSession._checkUserAgent ( sAgent,
sExistingAgent 
) [protected]

Checking user agent

Parameters:
string $sAgent current user agent
string $sExistingAgent existing user agent
Returns:
bool

Definition at line 625 of file oxsession.php.

oxSession._checkSid (  )  [protected]

Checking by timeout ( 60 minutes inactive, then kick him ) Global session Timeout in oxconfig.StartupDatabase is set to 1 hour

Returns:
bool Checking if this sid is old

bool

Definition at line 674 of file oxsession.php.

oxSession._checkCookies ( sCookieSid,
aSessCookieSetOnce 
) [protected]

Check for existing cookie. Cookie info is dropped from time to time.

Parameters:
string $sCookieSid coockie sid
array $aSessCookieSetOnce if session cookie is set
Returns:
bool

Definition at line 698 of file oxsession.php.

oxSession._setSessionId ( sSessId  )  [protected]

Sests session id to $sSessId

Parameters:
string $sSessId sesion ID
Returns:
null

Definition at line 740 of file oxsession.php.

oxSession._getBasketName (  )  [protected]

Returns name of shopping basket.

Returns:
string

Definition at line 771 of file oxsession.php.

oxSession._getCookieSid (  )  [protected]

Returns cookie sid value

Returns:
string

Definition at line 786 of file oxsession.php.


Member Data Documentation

oxSession.$_sName = 'sid' [protected]

Definition at line 21 of file oxsession.php.

oxSession.$_sId = null [protected]

Definition at line 27 of file oxsession.php.

oxSession.$_blIsNewSession = false [static, protected]

Definition at line 34 of file oxsession.php.

oxSession.$_instance = null [static, protected]

Singleton instance keeper.

Definition at line 39 of file oxsession.php.

oxSession.$_oUser = null [static, protected]

Definition at line 45 of file oxsession.php.

oxSession.$_blNewSession = false [protected]

Definition at line 53 of file oxsession.php.

oxSession.$_sErrorMsg = null [protected]

Definition at line 60 of file oxsession.php.

oxSession.$_aRequireCookiesInFncs [protected]

Initial value:

 array( 'register' => null,
                                                'account' => null,
                                                             'tobasket',
                                                             'login_noredirect'
                                                )

Definition at line 67 of file oxsession.php.

oxSession.$_aPersistentParams = array("actshop", "lang", "currency", "language", "tpllanguage") [protected]

Session params to be kept even after session timeout

Definition at line 76 of file oxsession.php.


The documentation for this class was generated from the following file:

Generated on Thu Dec 4 12:05:32 2008 for OXID eShop CE by  doxygen 1.5.5