Class Mage_Customer_Model_Session

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

Customer session model

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

Varien_Object
   |
   --Mage_Core_Model_Session_Abstract_Varien
      |
      --Mage_Core_Model_Session_Abstract
         |
         --Mage_Customer_Model_Session
Variable Summary
Description | Vars (details) | Methods (details) Constants
Mage_Customer_Model_Customer $_customer
bool $_isCustomerIdChecked
Method Summary
Description | Constants Vars (details) | Methods (details)
Mage_Customer_Model_Session __construct ()
bool authenticate ( $action, [ $loginUrl = null])
bool checkCustomerId (int $customerId)
Mage_Customer_Model_Customer getCustomer ()
Mage_Customer_Model_Config_Share getCustomerConfigShare ()
int getCustomerGroupId ()
int getCustomerId ()
bool isLoggedIn ()
bool login (string $username, string $password)
bool loginById (int $customerId)
Mage_Customer_Model_Session logout ()
Mage_Customer_Model_Session setCustomer (Mage_Customer_Model_Customer $customer)
void setCustomerAsLoggedIn ( $customer)
Variables
Description | Vars (details) Constants | Methods (details)
Mage_Customer_Model_Customer $_customer (line 41)

Customer object

  • access: protected
bool $_isCustomerIdChecked = null (line 48)

Flag with customer id validations result

  • 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)
Constructor __construct (line 60)
  • access: public
Mage_Customer_Model_Session __construct ()
authenticate (line 233)

Authenticate controller action by login customer

  • access: public
bool authenticate ( $action, [ $loginUrl = null])
checkCustomerId (line 162)

Check exists customer (light check)

  • access: public
bool checkCustomerId (int $customerId)
  • int $customerId
getCustomer (line 102)

Retrieve costomer model object

  • access: public
Mage_Customer_Model_Customer getCustomer ()
getCustomerConfigShare (line 55)

Retrieve customer sharing configuration model

  • access: public
Mage_Customer_Model_Config_Share getCustomerConfigShare ()
getCustomerGroupId (line 137)

Get customer group id If customer is not logged in system not logged in group id will be returned

  • access: public
int getCustomerGroupId ()
getCustomerId (line 123)

Retrieve customer id from current session

  • return: || null
  • access: public
int getCustomerId ()
isLoggedIn (line 151)

Checking custommer loggin status

  • access: public
bool isLoggedIn ()
login (line 177)

Customer authorization

  • access: public
bool login (string $username, string $password)
  • string $username
  • string $password
loginById (line 202)

Authorization customer by identifier

  • access: public
bool loginById (int $customerId)
  • int $customerId
logout (line 217)

Logout customer

  • access: public
Mage_Customer_Model_Session logout ()
setCustomer (line 77)

Set customer object and setting customer id in session

  • access: public
Mage_Customer_Model_Session setCustomer (Mage_Customer_Model_Customer $customer)
setCustomerAsLoggedIn (line 189)
  • access: public
void setCustomerAsLoggedIn ( $customer)
  • $customer

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:17 +0200 by phpDocumentor 1.4.3