OXID eShop CE  6.1.5
OxidEsales\EshopCommunity\Setup\Session Class Reference
+ Inheritance diagram for OxidEsales\EshopCommunity\Setup\Session:
+ Collaboration diagram for OxidEsales\EshopCommunity\Setup\Session:

Public Member Functions

 __construct ()
 
 getSid ()
 
 setSid ($sSid)
 
 setIsNewSession ($value)
 
 getIsNewSession ()
 
 getSessionParam ($sParamName)
 
 setSessionParam ($sParamName, $sParamValue)
 
- Public Member Functions inherited from OxidEsales\EshopCommunity\Setup\Core
 getInstance ($sInstanceName)
 
 __call ($sMethod, $aArgs)
 

Protected Member Functions

 _startSession ()
 
 _validateSession ()
 
 _getNewSessionID ()
 
 _initSessionData ()
 
_getSessionData ()
 
- Protected Member Functions inherited from OxidEsales\EshopCommunity\Setup\Core
 getClass ($sInstanceName)
 
 getSetupInstance ()
 
 getLanguageInstance ()
 
 getUtilitiesInstance ()
 
 getSessionInstance ()
 
 getDatabaseInstance ()
 
 userDecidedOverwriteDB ()
 
 userDecidedIgnoreDBWarning ()
 

Protected Attributes

 $_aSessionData = null
 
 $_sSid = null
 
 $_sSessionName = 'setup_sid'
 
 $_blNewSession = false
 

Additional Inherited Members

- Static Protected Attributes inherited from OxidEsales\EshopCommunity\Setup\Core
static $_aInstances = []
 

Detailed Description

Setup session manager class

Constructor & Destructor Documentation

◆ __construct()

OxidEsales\EshopCommunity\Setup\Session::__construct ( )

Initialize session class

Member Function Documentation

◆ _getNewSessionID()

OxidEsales\EshopCommunity\Setup\Session::_getNewSessionID ( )
protected

Generate new unique session ID

Returns
string

◆ _getSessionData()

& OxidEsales\EshopCommunity\Setup\Session::_getSessionData ( )
protected

Return session object reference.

Returns
array

◆ _initSessionData()

OxidEsales\EshopCommunity\Setup\Session::_initSessionData ( )
protected

Initializes setup session data array

◆ _startSession()

OxidEsales\EshopCommunity\Setup\Session::_startSession ( )
protected

Start session

◆ _validateSession()

OxidEsales\EshopCommunity\Setup\Session::_validateSession ( )
protected

Validate if session is started by setup script, if not, generate new session.

Returns
string Session ID

◆ getIsNewSession()

OxidEsales\EshopCommunity\Setup\Session::getIsNewSession ( )
Returns
bool

◆ getSessionParam()

OxidEsales\EshopCommunity\Setup\Session::getSessionParam (   $sParamName)

Returns session parameter value

Parameters
string$sParamNameparameter name
Returns
mixed

◆ getSid()

OxidEsales\EshopCommunity\Setup\Session::getSid ( )

Returns session id, which is used in forms and urls (actually this id keeps all session data)

Returns
string

◆ setIsNewSession()

OxidEsales\EshopCommunity\Setup\Session::setIsNewSession (   $value)
Parameters
bool$value

◆ setSessionParam()

OxidEsales\EshopCommunity\Setup\Session::setSessionParam (   $sParamName,
  $sParamValue 
)

Sets session parameter value

Parameters
string$sParamNameparameter name
mixed$sParamValueparameter value

◆ setSid()

OxidEsales\EshopCommunity\Setup\Session::setSid (   $sSid)

Sets current session ID

Parameters
string$sSidsession ID

Member Data Documentation

◆ $_aSessionData

OxidEsales\EshopCommunity\Setup\Session::$_aSessionData = null
protected

◆ $_blNewSession

OxidEsales\EshopCommunity\Setup\Session::$_blNewSession = false
protected

◆ $_sSessionName

OxidEsales\EshopCommunity\Setup\Session::$_sSessionName = 'setup_sid'
protected

◆ $_sSid

OxidEsales\EshopCommunity\Setup\Session::$_sSid = null
protected

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