Class Mage_Api_Model_Session

Description
Description | Vars (details) | Methods (details) Constants

Webservice api session

Located in /Api/Model/Session.php (line 34) 

Varien_Object
   |
   --Mage_Core_Model_Session_Abstract_Varien
      |
      --Mage_Core_Model_Session_Abstract
         |
         --Mage_Api_Model_Session
Variable Summary
Description | Vars (details) | Methods (details) Constants
mixed $sessionIds
mixed $_currentSessId
Method Summary
Description | Constants Vars (details) | Methods (details)
void clear ()
void getSessionId ()
void init ( $namespace, [ $sessionName = null])
bool isAllowed (string $resource, [string $privilege = null])
void isLoggedIn ([ $sessId = false])
boolean isSessionExpired ( $user)
void login ( $username,  $apiKey)
void refreshAcl ([ $user = null])
void revalidateCookie ()
void setSessionId ([ $sessId = null])
void start ([ $sessionName = null])
boolean _renewBySessId (string $sessId)
Variables
Description | Vars (details) Constants | Methods (details)
mixed $sessionIds = array() (line 36)
  • access: public
mixed $_currentSessId = null (line 37)
  • access: protected

Inherited Variables

Inherited from Mage_Core_Model_Session_Abstract

Mage_Core_Model_Session_Abstract::$_encryptedSessionId
 Mage_Core_Model_Session_Abstract::$_skipSessionIdFlag
 Mage_Core_Model_Session_Abstract::$_urlHostCache
Methods
Description | Vars (details) Constants Methods (details)
clear (line 73)
  • access: public
void clear ()
Redefinition of:
Mage_Core_Model_Session_Abstract_Varien::clear()
Alias for unsetAll
getSessionId (line 55)
  • access: public
void getSessionId ()
Redefinition of:
Mage_Core_Model_Session_Abstract_Varien::getSessionId()
Retrieve session Id
init (line 47)
  • access: public
void init ( $namespace, [ $sessionName = null])
  • $namespace
  • $sessionName
Redefinition of:
Mage_Core_Model_Session_Abstract::init()
Init session
isAllowed (line 136)

Check current user permission on resource and privilege

  • access: public
bool isAllowed (string $resource, [string $privilege = null])
  • string $resource
  • string $privilege
isLoggedIn (line 172)
  • access: public
void isLoggedIn ([ $sessId = false])
  • $sessId
isSessionExpired (line 162)

Check session expiration

  • access: public
boolean isSessionExpired ( $user)
  • $user
login (line 84)
  • access: public
void login ( $username,  $apiKey)
  • $username
  • $apiKey
refreshAcl (line 110)
  • access: public
void refreshAcl ([ $user = null])
  • $user
revalidateCookie (line 68)
  • access: public
void revalidateCookie ()
Redefinition of:
Mage_Core_Model_Session_Abstract_Varien::revalidateCookie()
Revalidate cookie
setSessionId (line 60)
  • access: public
void setSessionId ([ $sessId = null])
  • $sessId
Redefinition of:
Mage_Core_Model_Session_Abstract::setSessionId()
Specify session identifier
start (line 39)
  • access: public
void start ([ $sessionName = null])
  • $sessionName
Redefinition of:
Mage_Core_Model_Session_Abstract_Varien::start()
Conigure and start session
_renewBySessId (line 192)

Renew user by session ID if session not expired

  • access: protected
boolean _renewBySessId (string $sessId)
  • string $sessId

Inherited Methods

Inherited From Mage_Core_Model_Session_Abstract

Mage_Core_Model_Session_Abstract::addError()
Mage_Core_Model_Session_Abstract::addException()
Mage_Core_Model_Session_Abstract::addHost()
Mage_Core_Model_Session_Abstract::addMessage()
Mage_Core_Model_Session_Abstract::addMessages()
Mage_Core_Model_Session_Abstract::addNotice()
Mage_Core_Model_Session_Abstract::addSuccess()
Mage_Core_Model_Session_Abstract::addWarning()
Mage_Core_Model_Session_Abstract::getCookieDomain()
Mage_Core_Model_Session_Abstract::getCookieLifetime()
Mage_Core_Model_Session_Abstract::getCookiePath()
Mage_Core_Model_Session_Abstract::getEncryptedSessionId()
Mage_Core_Model_Session_Abstract::getMessages()
Mage_Core_Model_Session_Abstract::getSessionHosts()
Mage_Core_Model_Session_Abstract::getSessionIdForHost()
Mage_Core_Model_Session_Abstract::getSessionIdQueryParam()
Mage_Core_Model_Session_Abstract::getSessionSaveMethod()
Mage_Core_Model_Session_Abstract::getSessionSavePath()
Mage_Core_Model_Session_Abstract::getSkipSessionIdFlag()
Mage_Core_Model_Session_Abstract::getValidateHttpUserAgentSkip()
Mage_Core_Model_Session_Abstract::init()
Mage_Core_Model_Session_Abstract::isValidForHost()
Mage_Core_Model_Session_Abstract::setSessionId()
Mage_Core_Model_Session_Abstract::setSkipSessionIdFlag()
Mage_Core_Model_Session_Abstract::useSid()
Mage_Core_Model_Session_Abstract::useValidateHttpUserAgent()
Mage_Core_Model_Session_Abstract::useValidateHttpVia()
Mage_Core_Model_Session_Abstract::useValidateHttpXForwardedFor()
Mage_Core_Model_Session_Abstract::useValidateRemoteAddr()

Inherited From Mage_Core_Model_Session_Abstract_Varien

Mage_Core_Model_Session_Abstract_Varien::clear()
Mage_Core_Model_Session_Abstract_Varien::getCookie()
Mage_Core_Model_Session_Abstract_Varien::getData()
Mage_Core_Model_Session_Abstract_Varien::getSessionId()
Mage_Core_Model_Session_Abstract_Varien::getSessionName()
Mage_Core_Model_Session_Abstract_Varien::getSessionSaveMethod()
Mage_Core_Model_Session_Abstract_Varien::getSessionSavePath()
Mage_Core_Model_Session_Abstract_Varien::getValidateHttpUserAgentSkip()
Mage_Core_Model_Session_Abstract_Varien::getValidatorData()
Mage_Core_Model_Session_Abstract_Varien::init()
Mage_Core_Model_Session_Abstract_Varien::revalidateCookie()
Mage_Core_Model_Session_Abstract_Varien::setSessionId()
Mage_Core_Model_Session_Abstract_Varien::setSessionName()
Mage_Core_Model_Session_Abstract_Varien::start()
Mage_Core_Model_Session_Abstract_Varien::unsetAll()
Mage_Core_Model_Session_Abstract_Varien::useValidateHttpUserAgent()
Mage_Core_Model_Session_Abstract_Varien::useValidateHttpVia()
Mage_Core_Model_Session_Abstract_Varien::useValidateHttpXForwardedFor()
Mage_Core_Model_Session_Abstract_Varien::useValidateRemoteAddr()
Mage_Core_Model_Session_Abstract_Varien::validate()
Mage_Core_Model_Session_Abstract_Varien::_validate()
Class Constants
Description | Constants (details) Vars (details) | Methods (details)

Inherited Constants

Inherited from Mage_Core_Model_Session_Abstract

Mage_Core_Model_Session_Abstract::SESSION_ID_QUERY_PARAM
 Mage_Core_Model_Session_Abstract::XML_NODE_SESSION_SAVE
 Mage_Core_Model_Session_Abstract::XML_NODE_SESSION_SAVE_PATH
 Mage_Core_Model_Session_Abstract::XML_NODE_USET_AGENT_SKIP
 Mage_Core_Model_Session_Abstract::XML_PATH_COOKIE_DOMAIN
 Mage_Core_Model_Session_Abstract::XML_PATH_COOKIE_LIFETIME
 Mage_Core_Model_Session_Abstract::XML_PATH_COOKIE_PATH
 Mage_Core_Model_Session_Abstract::XML_PATH_LOG_EXCEPTION_FILE
 Mage_Core_Model_Session_Abstract::XML_PATH_USE_FRONTEND_SID
 Mage_Core_Model_Session_Abstract::XML_PATH_USE_HTTP_VIA
 Mage_Core_Model_Session_Abstract::XML_PATH_USE_REMOTE_ADDR
 Mage_Core_Model_Session_Abstract::XML_PATH_USE_USER_AGENT
 Mage_Core_Model_Session_Abstract::XML_PATH_USE_X_FORWARDED

Inherited from Mage_Core_Model_Session_Abstract_Varien

Mage_Core_Model_Session_Abstract_Varien::VALIDATOR_HTTP_USER_AGENT_KEY
 Mage_Core_Model_Session_Abstract_Varien::VALIDATOR_HTTP_VIA_KEY
 Mage_Core_Model_Session_Abstract_Varien::VALIDATOR_HTTP_X_FORVARDED_FOR_KEY
 Mage_Core_Model_Session_Abstract_Varien::VALIDATOR_KEY
 Mage_Core_Model_Session_Abstract_Varien::VALIDATOR_REMOTE_ADDR_KEY

Documentation generated on Fri, 11 Feb 2011 17:12:18 +0200 by phpDocumentor 1.4.3