oxSession Class Reference

Inheritance diagram for oxSession:

Inheritance graph
[legend]
Collaboration diagram for oxSession:

Collaboration graph
[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 15 of file oxsession.php.


Public Member Functions

 getId ()
 setId ($sVal)
 setName ($sVal)
 getForcedName ()
 getName ()
 start ()
 initNewSession ()
 freeze ()
 destroy ()
 url ($url)
 sid ($blForceSid=false)
 hiddenSid ()
 getBasket ()
 setBasket ($oBasket)
 delBasket ()
 isNewSession ()
 isSidNeeded ($sUrl=null)
 processUrl ($sUrl)

Static Public Member Functions

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

Protected Member Functions

 _sessionStart ()
 _forceSessionStart ()
 _allowSessionStart ()
 _isSwappedClient ()
 _checkUserAgent ($sAgent, $sExistingAgent)
 _checkSid ()
 _checkCookies ($sCookieSid, $aSessCookieSetOnce)
 _setSessionId ($sSessId)
 _getBasketName ()
 _getCookieSid ()
 _isSessionRequiredAction ()

Protected Attributes

 $_sName = 'sid'
 $_sForcedPrefix = 'force_'
 $_sId = null
 $_blNewSession = false
 $_sErrorMsg = null
 $_oBasket = null
 $_aRequireCookiesInFncs
 $_blSidNeeded = null
 $_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

Reimplemented in oxOpenIdSession.

Definition at line 108 of file oxsession.php.

oxSession.getId (  ) 

Returns session ID

Returns:
string

Definition at line 126 of file oxsession.php.

oxSession.setId ( sVal  ) 

Sets session id

Parameters:
string $sVal id value
Returns:
null

Definition at line 138 of file oxsession.php.

oxSession.setName ( sVal  ) 

Sets session param name

Parameters:
string $sVal name value
Returns:
null

Definition at line 150 of file oxsession.php.

oxSession.getForcedName (  ) 

Returns forced session id param name

Returns:
string

Definition at line 160 of file oxsession.php.

oxSession.getName (  ) 

Returns session param name

Returns:
string

Definition at line 170 of file oxsession.php.

oxSession.start (  ) 

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

Returns:
null

Definition at line 180 of file oxsession.php.

oxSession._sessionStart (  )  [protected]

Initialize session data (calls php.session_start())

Returns:
null

Definition at line 234 of file oxsession.php.

oxSession.initNewSession (  ) 

Assigns new session ID, clean existing data except persistent.

Returns:
null

Definition at line 244 of file oxsession.php.

oxSession.freeze (  ) 

Ends the current session and store session data.

Returns:
null

Definition at line 270 of file oxsession.php.

oxSession.destroy (  ) 

Destroys all data registered to a session.

Returns:
null

Definition at line 283 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 297 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 321 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 344 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 370 of file oxsession.php.

oxSession.url ( url  ) 

Append URL with session information parameter.

Parameters:
string $url Current url
Returns:
string

Definition at line 394 of file oxsession.php.

oxSession.sid ( blForceSid = false  ) 

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.

Parameters:
bool $blForceSid forces sid getter, ignores cookie check (optional)
Returns:
string

Definition at line 446 of file oxsession.php.

oxSession.hiddenSid (  ) 

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

Returns:
string

Definition at line 475 of file oxsession.php.

oxSession.getBasket (  ) 

Returns basket session object.

Returns:
oxbasket

Definition at line 489 of file oxsession.php.

oxSession.setBasket ( oBasket  ) 

Sets basket session object.

Parameters:
object $oBasket basket object
Returns:
null

Definition at line 510 of file oxsession.php.

oxSession.delBasket (  ) 

Deletes basket session object.

Returns:
null

Definition at line 521 of file oxsession.php.

oxSession.isNewSession (  ) 

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

Returns:
bool

Definition at line 532 of file oxsession.php.

oxSession._forceSessionStart (  )  [protected]

Returns true if its not search engine and config option blForceSessionStart = 1/true

Returns:
bool

Definition at line 542 of file oxsession.php.

oxSession._allowSessionStart (  )  [protected]

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

Returns:
bool

Definition at line 552 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 583 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 643 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 692 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 716 of file oxsession.php.

oxSession._setSessionId ( sSessId  )  [protected]

Sests session id to $sSessId

Parameters:
string $sSessId sesion ID
Returns:
null

Definition at line 758 of file oxsession.php.

oxSession._getBasketName (  )  [protected]

Returns name of shopping basket.

Returns:
string

Definition at line 795 of file oxsession.php.

oxSession._getCookieSid (  )  [protected]

Returns cookie sid value

Returns:
string

Definition at line 810 of file oxsession.php.

oxSession._isSessionRequiredAction (  )  [protected]

Tests if current action requires session

Returns:
bool

Definition at line 820 of file oxsession.php.

oxSession.isSidNeeded ( sUrl = null  ) 

Checks if cookies are not available. Returns TRUE of sid needed

Parameters:
string $sUrl if passed domain does not match current - returns true (optional)
Returns:
bool

Definition at line 836 of file oxsession.php.

oxSession.processUrl ( sUrl  ) 

Appends url with session ID, but only if oxSession._isSidNeeded() returns true

Parameters:
string $sUrl url to append with sid
Returns:
string

Definition at line 875 of file oxsession.php.


Member Data Documentation

oxSession.$_sName = 'sid' [protected]

Definition at line 22 of file oxsession.php.

oxSession.$_sForcedPrefix = 'force_' [protected]

Definition at line 29 of file oxsession.php.

oxSession.$_sId = null [protected]

Definition at line 35 of file oxsession.php.

oxSession.$_blIsNewSession = false [static, protected]

Definition at line 42 of file oxsession.php.

oxSession.$_instance = null [static, protected]

Singleton instance keeper.

Reimplemented in oxOpenIdSession.

Definition at line 47 of file oxsession.php.

oxSession.$_oUser = null [static, protected]

Definition at line 53 of file oxsession.php.

oxSession.$_blNewSession = false [protected]

Definition at line 61 of file oxsession.php.

oxSession.$_sErrorMsg = null [protected]

Definition at line 68 of file oxsession.php.

oxSession.$_oBasket = null [protected]

Definition at line 75 of file oxsession.php.

oxSession.$_aRequireCookiesInFncs [protected]

Initial value:

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

Definition at line 82 of file oxsession.php.

oxSession.$_blSidNeeded = null [protected]

Definition at line 94 of file oxsession.php.

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

Definition at line 101 of file oxsession.php.


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

Generated on Mon Oct 26 20:11:30 2009 for OXID eShop CE by  doxygen 1.5.5