OXID eShop CE  4.8.10
 All Classes Files Functions Variables Pages
oxSession Class Reference
+ Inheritance diagram for oxSession:
+ Collaboration diagram for oxSession:

Public Member Functions

 getId ()
 setId ($sVal)
 setName ($sVal)
 getForcedName ()
 getName ()
 start ()
 getRequestChallengeToken ()
 getSessionChallengeToken ()
 checkSessionChallenge ()
 initNewSession ()
 regenerateSessionId ()
 freeze ()
 destroy ()
 hasVariable ($name)
 setVariable ($name, $value)
 getVariable ($name)
 deleteVariable ($name)
 sid ($blForceSid=false)
 hiddenSid ()
 getBasket ()
 setBasket ($oBasket)
 delBasket ()
 isNewSession ()
 setForceNewSession ()
 isSidNeeded ($sUrl=null)
 isActualSidInCookie ()
 processUrl ($sUrl)
 getRemoteAccessToken ($blGenerateNew=true)
 getBasketReservations ()
 isHeaderSent ()
 isSessionStarted ()
- Public Member Functions inherited from oxSuperCfg
 __call ($sMethod, $aArgs)
 __construct ()
 getConfig ()
 setConfig ($oConfig)
 getSession ()
 setSession ($oSession)
 getUser ()
 setUser ($oUser)
 isAdmin ()
 setAdminMode ($blAdmin)

Static Public Member Functions

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

Protected Member Functions

 _initNewSessionChallenge ()
 _sessionStart ()
 _getNewSessionId ($blUnset=true)
 _validateBasket (oxBasket $oBasket)
 _forceSessionStart ()
 _allowSessionStart ()
 _isSwappedClient ()
 _checkUserAgent ($sAgent, $sExistingAgent)
 _checkSid ()
 _checkCookies ($sCookieSid, $aSessCookieSetOnce)
 _setSessionId ($sSessId)
 _getBasketName ()
 _getCookieSid ()
 _getRequireSessionWithParams ()
 _isSessionRequiredAction ()
 _getSessionUseCookies ()
 _isValidRemoteAccessToken ()

Protected Attributes

 $_sName = 'sid'
 $_sForcedPrefix = 'force_'
 $_sId = null
 $_blNewSession = false
 $_blForceNewSession = false
 $_sErrorMsg = null
 $_oBasket = null
 $_oBasketReservations = null
 $_blStarted = false
 $_aRequireSessionWithParams
 $_blSidNeeded = null
 $_aPersistentParams = array("actshop", "lang", "currency", "language", "tpllanguage")

Static Protected Attributes

static $_blIsNewSession = false
static $_instance = null
static $_oUser = null
- Static Protected Attributes inherited from oxSuperCfg
static $_oConfig = null
static $_oSession = null
static $_oRights = null
static $_oActUser = null
static $_blIsAdmin = null

Detailed Description

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

Definition at line 10 of file oxsession.php.

Member Function Documentation

oxSession::_allowSessionStart ( )
protected

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

Returns
bool

Definition at line 885 of file oxsession.php.

oxSession::_checkCookies (   $sCookieSid,
  $aSessCookieSetOnce 
)
protected

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

Parameters
string$sCookieSidcoockie sid
array$aSessCookieSetOnceif session cookie is set
Returns
bool

Definition at line 1006 of file oxsession.php.

oxSession::_checkSid ( )
protected

Checking if this sid is old

Returns
bool

Definition at line 981 of file oxsession.php.

oxSession::_checkUserAgent (   $sAgent,
  $sExistingAgent 
)
protected

Checking user agent

Parameters
string$sAgentcurrent user agent
string$sExistingAgentexisting user agent
Returns
bool

Definition at line 957 of file oxsession.php.

oxSession::_forceSessionStart ( )
protected

Returns true if its not search engine and config option blForceSessionStart = 1/true or _GET parameter "su" (suggested user id) is set.

Returns
bool

Definition at line 875 of file oxsession.php.

oxSession::_getBasketName ( )
protected

Returns name of shopping basket.

Returns
string

Definition at line 1083 of file oxsession.php.

oxSession::_getCookieSid ( )
protected

Returns cookie sid value

Returns
string

Definition at line 1097 of file oxsession.php.

oxSession::_getNewSessionId (   $blUnset = true)
protected

Update the current session id with a newly generated one, deletes the old associated session file, frees all session variables.

Parameters
bool$blUnsetif true, calls session_unset [optional]
Returns
string

Definition at line 401 of file oxsession.php.

oxSession::_getRequireSessionWithParams ( )
protected

returns configuration array with info which parameters require session start

Returns
array

Definition at line 1108 of file oxsession.php.

oxSession::_getSessionUseCookies ( )
protected

return cookies usage for sid possibilities

Returns
bool

Definition at line 1151 of file oxsession.php.

oxSession::_initNewSessionChallenge ( )
protected

initialize new session challenge token

Returns
null

Definition at line 300 of file oxsession.php.

oxSession::_isSessionRequiredAction ( )
protected

Tests if current action requires session

Returns
bool

Definition at line 1128 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 919 of file oxsession.php.

oxSession::_isValidRemoteAccessToken ( )
protected

Checks if token supplied over 'rtoken' parameter match remote accecss session token.

Returns
bool

Definition at line 1161 of file oxsession.php.

oxSession::_sessionStart ( )
protected

Initialize session data (calls php::session_start())

Returns
null

Definition at line 310 of file oxsession.php.

oxSession::_setSessionId (   $sSessId)
protected

Sests session id to $sSessId

Parameters
string$sSessIdsesion ID
Returns
null

Definition at line 1052 of file oxsession.php.

oxSession::_validateBasket ( oxBasket  $oBasket)
protected

Validate loaded from session basket content. Check for language change.

Parameters
oxBasket$oBasketBasket object loaded from session.
Returns
null

Definition at line 688 of file oxsession.php.

oxSession::checkSessionChallenge ( )

check for CSRF, returns true, if request (get/post) token maches session saved var false, if CSRF is possible

Returns
bool

Definition at line 289 of file oxsession.php.

oxSession::delBasket ( )

Deletes basket session object.

Returns
null

Definition at line 721 of file oxsession.php.

static oxSession::deleteVar (   $name)
static

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

Parameters
string$nameName of parameter to destroy
Deprecated:
since v5.0.0 (2012-08-27); Use public deleteVariable()
Returns
null

Definition at line 570 of file oxsession.php.

oxSession::deleteVariable (   $name)

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

Parameters
string$nameName of parameter to destroy
Returns
null

Definition at line 582 of file oxsession.php.

oxSession::destroy ( )

Destroys all data registered to a session.

Returns
null

Definition at line 437 of file oxsession.php.

oxSession::freeze ( )

Ends the current session and store session data.

Returns
null

Definition at line 424 of file oxsession.php.

oxSession::getBasket ( )

Returns basket session object.

Returns
oxbasket

Definition at line 656 of file oxsession.php.

oxSession::getBasketReservations ( )

return basket reservations handler object

Returns
oxBasketReservation

Definition at line 1176 of file oxsession.php.

oxSession::getForcedName ( )

Returns forced session id param name

Returns
string

Definition at line 181 of file oxsession.php.

oxSession::getId ( )

Returns session ID

Returns
string

Definition at line 147 of file oxsession.php.

static oxSession::getInstance ( )
static

get oxSession object instance (create if needed)

Deprecated:
since v5.0 (2012-08-10); Use oxRegistry::getSession() instead.
Returns
oxSession

Definition at line 137 of file oxsession.php.

oxSession::getName ( )

Returns session param name

Returns
string

Definition at line 191 of file oxsession.php.

oxSession::getRemoteAccessToken (   $blGenerateNew = true)

Returns remote access key. With this key (called over "remotekey" URL parameter) and session id (sid parameter) you can access session from another client. The key is generated once per session after the first request.

Parameters
bool$blGenerateNewShould new token be generated
Returns
string

Definition at line 857 of file oxsession.php.

oxSession::getRequestChallengeToken ( )

retrieve session challenge token from request

Returns
string

Definition at line 263 of file oxsession.php.

oxSession::getSessionChallengeToken ( )

retrieve session challenge token from session

Returns
string

Definition at line 273 of file oxsession.php.

static oxSession::getVar (   $name)
static

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

Parameters
string$nameName of parameter
Deprecated:
since v5.0.0 (2012-08-27); Use public getVariable()
Returns
mixed

Definition at line 530 of file oxsession.php.

oxSession::getVariable (   $name)

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

Parameters
string$nameName of parameter
Returns
mixed

Definition at line 542 of file oxsession.php.

static oxSession::hasVar (   $name)
static

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

Parameters
string$nameName to check
Deprecated:
since v5.0.0 (2012-08-27); Use public hasVariable()
Returns
bool

Definition at line 453 of file oxsession.php.

oxSession::hasVariable (   $name)

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

Parameters
string$nameName to check
Returns
bool

Definition at line 465 of file oxsession.php.

oxSession::hiddenSid ( )

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

Returns
string

Definition at line 639 of file oxsession.php.

oxSession::initNewSession ( )

Assigns new session ID, clean existing data except persistent.

Returns
null

Definition at line 346 of file oxsession.php.

oxSession::isActualSidInCookie ( )

Checks if current session id is the same as in originally received cookie. This method is intended to indicate if new session cookie is to be sent as header from this script execution.

Returns
bool

Definition at line 808 of file oxsession.php.

oxSession::isHeaderSent ( )

Checks if headers were already outputed

Returns
bool

Definition at line 1189 of file oxsession.php.

oxSession::isNewSession ( )

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

Returns
bool

Definition at line 732 of file oxsession.php.

oxSession::isSessionStarted ( )

Returns true if session was started

Returns
bool

Definition at line 1199 of file oxsession.php.

oxSession::isSidNeeded (   $sUrl = null)

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

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

Definition at line 755 of file oxsession.php.

oxSession::processUrl (   $sUrl)

Appends url with session ID, but only if oxSession::_isSidNeeded() returns true Direct usage of this method to retrieve end url result is discouraged - instead see oxUtilsUrl::processUrl

Parameters
string$sUrlurl to append with sid
See Also
oxUtilsUrl::processUrl
Returns
string

Definition at line 825 of file oxsession.php.

oxSession::regenerateSessionId ( )

Regenerates session id

Returns
null

Definition at line 379 of file oxsession.php.

oxSession::setBasket (   $oBasket)

Sets basket session object.

Parameters
object$oBasketbasket object
Returns
null

Definition at line 710 of file oxsession.php.

oxSession::setForceNewSession ( )

Forces starting session and skips checking if session is allowed to start when calling oxSession::start();

Returns
bool

Definition at line 743 of file oxsession.php.

oxSession::setId (   $sVal)

Sets session id

Parameters
string$sValid value
Returns
null

Definition at line 159 of file oxsession.php.

oxSession::setName (   $sVal)

Sets session param name

Parameters
string$sValname value
Returns
null

Definition at line 171 of file oxsession.php.

static oxSession::setVar (   $name,
  $value 
)
static

Sets parameter and its value to global session mixedvar array.

Parameters
string$nameName of parameter to store
mixed$valueValue of parameter
Deprecated:
since v5.0.0 (2012-08-27); Use public setVariable()
Returns
null

Definition at line 491 of file oxsession.php.

oxSession::setVariable (   $name,
  $value 
)

Sets parameter and its value to global session mixedvar array.

Parameters
string$nameName of parameter to store
mixed$valueValue of parameter
Returns
null

Definition at line 505 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$blForceSidforces sid getter, ignores cookie check (optional)
Returns
string

Definition at line 608 of file oxsession.php.

oxSession::start ( )

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

Returns
null

Definition at line 201 of file oxsession.php.

Member Data Documentation

oxSession::$_aPersistentParams = array("actshop", "lang", "currency", "language", "tpllanguage")
protected

Definition at line 128 of file oxsession.php.

oxSession::$_aRequireSessionWithParams
protected
Initial value:
array(
'cl' => array (
'register' => true,
'account' => true,
),
'fnc' => array (
'tobasket' => true,
'login_noredirect' => true,
'tocomparelist' => true,
),
'_artperpage' => true,
'ldtype' => true,
'listorderby' => true,
)

Definition at line 101 of file oxsession.php.

oxSession::$_blForceNewSession = false
protected

Definition at line 63 of file oxsession.php.

oxSession::$_blIsNewSession = false
staticprotected

Definition at line 37 of file oxsession.php.

oxSession::$_blNewSession = false
protected

Definition at line 56 of file oxsession.php.

oxSession::$_blSidNeeded = null
protected

Definition at line 121 of file oxsession.php.

oxSession::$_blStarted = false
protected

Definition at line 91 of file oxsession.php.

oxSession::$_instance = null
staticprotected

Singleton instance keeper.

Definition at line 42 of file oxsession.php.

oxSession::$_oBasket = null
protected

Definition at line 77 of file oxsession.php.

oxSession::$_oBasketReservations = null
protected

Definition at line 84 of file oxsession.php.

oxSession::$_oUser = null
staticprotected

Definition at line 48 of file oxsession.php.

oxSession::$_sErrorMsg = null
protected

Definition at line 70 of file oxsession.php.

oxSession::$_sForcedPrefix = 'force_'
protected

Definition at line 24 of file oxsession.php.

oxSession::$_sId = null
protected

Definition at line 30 of file oxsession.php.

oxSession::$_sName = 'sid'
protected

Definition at line 17 of file oxsession.php.


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