Class Mage_Customer_Model_Session

Customer session model

Varien_Object

Mage_Customer_Model_Session

Package: Mage\Customer
Category: Mage
Copyright: Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)
License: Open Software License (OSL 3.0)
Author: Magento Core Team <core@magentocommerce.com>
Located at code/core/Mage/Customer/Model/Session.php

Methods summary
`public Mage_Customer_Model_Config_Share`	# `getCustomerConfigShare( )` Retrieve customer sharing configuration model Retrieve customer sharing configuration model Returns `Mage_Customer_Model_Config_Share`
`public`	# `__construct( )`
`public Mage_Customer_Model_Session`	# `setCustomer( Mage_Customer_Model_Customer $customer )` Set customer object and setting customer id in session Set customer object and setting customer id in session Parameters `$customer` `Mage_Customer_Model_Customer` $customer Returns `Mage_Customer_Model_Session`
`public Mage_Customer_Model_Customer`	# `getCustomer( )` Retrieve customer model object Retrieve customer model object Returns `Mage_Customer_Model_Customer`
`public Mage_Customer_Model_Session`	# `setCustomerId( integer\|null $id )` Set customer id Set customer id Parameters `$id` `integer\|null` $id Returns `Mage_Customer_Model_Session`
`public integer\|null`	# `getCustomerId( )` Retrieve customer id from current session Retrieve customer id from current session Returns `integer\|null`
`public Mage_Customer_Model_Session`	# `setCustomerGroupId( integer\|null $id )` Set customer group id Set customer group id Parameters `$id` `integer\|null` $id Returns `Mage_Customer_Model_Session`
`public integer`	# `getCustomerGroupId( )` Get customer group id If customer is not logged in system, 'not logged in' group id will be returned Get customer group id If customer is not logged in system, 'not logged in' group id will be returned Returns `integer`
`public boolean`	# `isLoggedIn( )` Checking customer login status Checking customer login status Returns `boolean`
`public boolean`	# `checkCustomerId( integer $customerId )` Check exists customer (light check) Check exists customer (light check) Parameters `$customerId` `integer` $customerId Returns `boolean`
`public boolean`	# `login( string $username, string $password )` Customer authorization Customer authorization Parameters `$username` `string` $username `$password` `string` $password Returns `boolean`
`public`	# `setCustomerAsLoggedIn( mixed $customer )`
`public boolean`	# `loginById( integer $customerId )` Authorization customer by identifier Authorization customer by identifier Parameters `$customerId` `integer` $customerId Returns `boolean`
`public Mage_Customer_Model_Session`	# `logout( )` Logout customer Logout customer Returns `Mage_Customer_Model_Session`
`public boolean`	# `authenticate( Mage_Core_Controller_Varien_Action $action, boolean $loginUrl = null )` Authenticate controller action by login customer Authenticate controller action by login customer Parameters `$action` `Mage_Core_Controller_Varien_Action` $action `$loginUrl` `boolean` $loginUrl Returns `boolean`
`protected Mage_Customer_Model_Session`	# `_setAuthUrl( string $key, string $url )` Set auth url Set auth url Parameters `$key` `string` $key `$url` `string` $url Returns `Mage_Customer_Model_Session`
`protected Mage_Customer_Model_Session`	# `_logout( )` Logout without dispatching event Logout without dispatching event Returns `Mage_Customer_Model_Session`
`public Mage_Customer_Model_Session`	# `setBeforeAuthUrl( string $url )` Set Before auth url Set Before auth url Parameters `$url` `string` $url Returns `Mage_Customer_Model_Session`
`public Mage_Customer_Model_Session`	# `setAfterAuthUrl( string $url )` Set After auth url Set After auth url Parameters `$url` `string` $url Returns `Mage_Customer_Model_Session`
`public Mage_Customer_Model_Session`	# `renewSession( )` Reset core session hosts after reseting session ID Reset core session hosts after reseting session ID Returns `Mage_Customer_Model_Session` Overrides `Mage_Core_Model_Session_Abstract::renewSession()`

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

Methods inherited from Mage_Core_Model_Session_Abstract_Varien
`_validate(), clear(), getCookie(), getData(), getSessionId(), getSessionName(), getValidatorData(), regenerateSessionId(), setSessionName(), start(), unsetAll(), validate()`

Constants inherited from Mage_Core_Model_Session_Abstract
`SESSION_ID_QUERY_PARAM, XML_NODE_SESSION_SAVE, XML_NODE_SESSION_SAVE_PATH, XML_NODE_USET_AGENT_SKIP, XML_PATH_COOKIE_DOMAIN, XML_PATH_COOKIE_LIFETIME, XML_PATH_COOKIE_PATH, XML_PATH_LOG_EXCEPTION_FILE, XML_PATH_USE_FRONTEND_SID, XML_PATH_USE_HTTP_VIA, XML_PATH_USE_REMOTE_ADDR, XML_PATH_USE_USER_AGENT, XML_PATH_USE_X_FORWARDED`

Constants inherited from Mage_Core_Model_Session_Abstract_Varien
`VALIDATOR_HTTP_USER_AGENT_KEY, VALIDATOR_HTTP_VIA_KEY, VALIDATOR_HTTP_X_FORVARDED_FOR_KEY, VALIDATOR_KEY, VALIDATOR_REMOTE_ADDR_KEY`

Properties summary
`protected Mage_Customer_Model_Customer`	`$_customer`		# Customer object Customer object
`protected boolean`	`$_isCustomerIdChecked`	`null`	# Flag with customer id validations result Flag with customer id validations result
`protected null\|integer`	`$_persistentCustomerGroupId`	`null`	# Persistent customer group id Persistent customer group id

Properties inherited from Mage_Core_Model_Session_Abstract
`$_encryptedSessionId, $_skipSessionIdFlag, $_urlHostCache`

Packages

Classes

Interfaces

Exceptions

Class Mage_Customer_Model_Session

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Returns

Overrides