Docs For Class Mage_Core_Model_Session

Description

Core Session Abstract model

author: Magento Core Team <[email protected]>
copyright: Copyright (c) 2010 Magento Inc. (http://www.magentocommerce.com)

Located in /Core/Model/Session/Abstract.php (line 35)

Varien_Object
   |
   --Mage_Core_Model_Session_Abstract_Varien
      |
      --Mage_Core_Model_Session_Abstract

Direct descendents

Class	Description
Mage_Paypal_Model_Session	Paypal transaction session namespace
Mage_Adminhtml_Model_Session_Quote	Adminhtml quote session
Mage_Adminhtml_Model_Session	Auth session model
Mage_PaypalUk_Model_Session	PaypalUk transaction session namespace
Mage_Connect_Model_Session	Auth session model
Mage_CatalogSearch_Model_Session	Magento
Mage_Catalog_Model_Session	Catalog session model
Mage_Admin_Model_Session	Auth session model
Mage_Api_Model_Session	Webservice api session
Mage_Customer_Model_Session	Customer session model
Mage_Tag_Model_Session	Tag session model
Mage_Newsletter_Model_Session	Newsletter session model
Mage_Wishlist_Model_Session	Wishlist session model
Mage_Checkout_Model_Session	Magento
Mage_Review_Model_Session	Review session model
Mage_Centinel_Model_Session	Payment centinel session model
Mage_Reports_Model_Session	Reports Session Model
Mage_Rss_Model_Session	Auth session model
Mage_Core_Model_Session	Core session model
Mage_Authorizenet_Model_Directpost_Session	Authorize.net DirectPost session model.
Mage_Install_Model_Session	Install session model

Class Constant Summary

SESSION_ID_QUERY_PARAM = 'SID'

XML_NODE_SESSION_SAVE = 'global/session_save'

XML_NODE_SESSION_SAVE_PATH = 'global/session_save_path'

XML_NODE_USET_AGENT_SKIP = 'global/session/validation/http_user_agent_skip'

XML_PATH_COOKIE_DOMAIN = 'web/cookie/cookie_domain'

XML_PATH_COOKIE_LIFETIME = 'web/cookie/cookie_lifetime'

XML_PATH_COOKIE_PATH = 'web/cookie/cookie_path'

XML_PATH_LOG_EXCEPTION_FILE = 'dev/log/exception_file'

XML_PATH_USE_FRONTEND_SID = 'web/session/use_frontend_sid'

XML_PATH_USE_HTTP_VIA = 'web/session/use_http_via'

XML_PATH_USE_REMOTE_ADDR = 'web/session/use_remote_addr'

XML_PATH_USE_USER_AGENT = 'web/session/use_http_user_agent'

XML_PATH_USE_X_FORWARDED = 'web/session/use_http_x_forwarded_for'

Variable Summary

static string $_encryptedSessionId

static array $_urlHostCache

bool $_skipSessionIdFlag

Method Summary

Mage_Core_Model_Session_Abstract addError (string $message)

Mage_Core_Model_Session_Abstract addException ( $exception, string $alternativeText)

Mage_Core_Model_Session_Abstract addHost (string $host)

Mage_Core_Model_Session_Abstract addMessage (Mage_Core_Model_Message_Abstract $message)

Mage_Core_Model_Session_Abstract addMessages (array $messages)

Mage_Core_Model_Session_Abstract addNotice (string $message)

Mage_Core_Model_Session_Abstract addSuccess (string $message)

Mage_Core_Model_Session_Abstract addWarning (string $message)

string getCookieDomain ()

int getCookieLifetime ()

string getCookiePath ()

string getEncryptedSessionId ()

Mage_Core_Model_Message_Collection getMessages ([bool $clear = false])

array getSessionHosts ()

string getSessionIdForHost (string $urlHost)

void getSessionIdQueryParam ()

string getSessionSaveMethod ()

string getSessionSavePath ()

bool getSkipSessionIdFlag ()

array getValidateHttpUserAgentSkip ()

Mage_Core_Model_Session_Abstract init (string $namespace, [string $sessionName = null])

bool isValidForHost (string $host)

Mage_Core_Model_Session_Abstract setSessionId ([string|null $id = null])

Mage_Core_Model_Session_Abstract setSkipSessionIdFlag (bool $flag)

bool useSid ()

bool useValidateHttpUserAgent ()

bool useValidateHttpVia ()

bool useValidateHttpXForwardedFor ()

bool useValidateRemoteAddr ()

Variables

static string $_encryptedSessionId (line 66)

Encrypted session id cache

access: protected

static array $_urlHostCache = array() (line 59)

URL host cache

access: protected

bool $_skipSessionIdFlag = false (line 73)

Skip session id flag

access: protected

Methods

addError (line 262)

Adding new error message

access: public

Mage_Core_Model_Session_Abstract addError (string $message)

string $message

Redefined in descendants as:

Mage_Newsletter_Model_Session::addError()

addException (line 229)

Not Mage exeption handling

access: public

Mage_Core_Model_Session_Abstract addException ( $exception, string $alternativeText)

Exception $exception
string $alternativeText

addHost (line 450)

Add hostname to session

access: public

Mage_Core_Model_Session_Abstract addHost (string $host)

string $host

addMessage (line 249)

Adding new message to message collection

access: public

Mage_Core_Model_Session_Abstract addMessage (Mage_Core_Model_Message_Abstract $message)

Mage_Core_Model_Message_Abstract $message

addMessages (line 310)

Adding messages array to message collection

access: public

Mage_Core_Model_Session_Abstract addMessages (array $messages)

array $messages

addNotice (line 286)

Adding new nitice message

access: public

Mage_Core_Model_Session_Abstract addNotice (string $message)

string $message

addSuccess (line 298)

Adding new success message

access: public

Mage_Core_Model_Session_Abstract addSuccess (string $message)

string $message

Redefined in descendants as:

Mage_Newsletter_Model_Session::addSuccess()

addWarning (line 274)

Adding new warning message

access: public

Mage_Core_Model_Session_Abstract addWarning (string $message)

string $message

getCookieDomain (line 94)

Retrieve Cookie domain

access: public

string getCookieDomain ()

getCookieLifetime (line 114)

Retrieve cookie lifetime

access: public

int getCookieLifetime ()

getCookiePath (line 104)

Retrieve cookie path

access: public

string getCookiePath ()

getEncryptedSessionId (line 352)

Get ecrypted session identifuer No reason use crypt key for session id encryption we can use session identifier as is

access: public

string getEncryptedSessionId ()

getMessages (line 207)

Retrieve messages from session

access: public

Mage_Core_Model_Message_Collection getMessages ([bool $clear = false])

bool $clear

getSessionHosts (line 473)

Retrieve session hostnames

access: public

array getSessionHosts ()

getSessionIdForHost (line 402)

If the host was switched but session cookie won't recognize it - add session id to query

return: {session_id_key}={session_id_encrypted}
access: public

string getSessionIdForHost (string $urlHost)

string $urlHost: can be host or url

getSessionIdQueryParam (line 365)

access: public

void getSessionIdQueryParam ()

getSessionSaveMethod (line 483)

Retrieve session save method

access: public

string getSessionSaveMethod ()

Redefinition of:

Mage_Core_Model_Session_Abstract_Varien::getSessionSaveMethod(): Retrieve session save method Default files

getSessionSavePath (line 496)

Get sesssion save path

access: public

string getSessionSavePath ()

Redefinition of:

Mage_Core_Model_Session_Abstract_Varien::getSessionSavePath(): Get sesssion save path

getSkipSessionIdFlag (line 391)

Retrieve session id skip flag

access: public

bool getSkipSessionIdFlag ()

getValidateHttpUserAgentSkip (line 191)

Retrieve skip User Agent validation strings (Flash etc)

access: public

array getValidateHttpUserAgentSkip ()

Redefinition of:

Mage_Core_Model_Session_Abstract_Varien::getValidateHttpUserAgentSkip(): Retrieve skip User Agent validation strings (Flash etc)

init (line 82)

Init session

access: public

Mage_Core_Model_Session_Abstract init (string $namespace, [string $sessionName = null])

string $namespace
string $sessionName

Redefinition of:

Mage_Core_Model_Session_Abstract_Varien::init(): Init session with namespace

Redefined in descendants as:

Mage_Admin_Model_Session::init() : Pull out information from session whether there is currently the first page after log in
Mage_Api_Model_Session::init()

isValidForHost (line 437)

Check is valid session for hostname

access: public

bool isValidForHost (string $host)

string $host

setSessionId (line 326)

Specify session identifier

access: public

Mage_Core_Model_Session_Abstract setSessionId ([string|null $id = null])

string|null $id

Redefinition of:

Mage_Core_Model_Session_Abstract_Varien::setSessionId(): Set custom session id

Redefined in descendants as:

Mage_Api_Model_Session::setSessionId()

setSkipSessionIdFlag (line 380)

Set skip flag if need skip generating of _GET session_id_key param

access: public

Mage_Core_Model_Session_Abstract setSkipSessionIdFlag (bool $flag)

bool $flag

useSid (line 181)

Check whether SID can be used for session initialization Admin area will always have this feature enabled

access: public

bool useSid ()

useValidateHttpUserAgent (line 166)

Use HTTP_USER_AGENT in validator key

access: public

bool useValidateHttpUserAgent ()

Redefinition of:

Mage_Core_Model_Session_Abstract_Varien::useValidateHttpUserAgent(): Use HTTP_USER_AGENT in validator key

useValidateHttpVia (line 138)

Use HTTP_VIA in validator key

access: public

bool useValidateHttpVia ()

Redefinition of:

Mage_Core_Model_Session_Abstract_Varien::useValidateHttpVia(): Use HTTP_VIA in validator key

useValidateHttpXForwardedFor (line 152)

Use HTTP_X_FORWARDED_FOR in validator key

access: public

bool useValidateHttpXForwardedFor ()

Redefinition of:

Mage_Core_Model_Session_Abstract_Varien::useValidateHttpXForwardedFor(): Use HTTP_X_FORWARDED_FOR in validator key

useValidateRemoteAddr (line 124)

Use REMOTE_ADDR in validator key

access: public

bool useValidateRemoteAddr ()

Redefinition of:

Mage_Core_Model_Session_Abstract_Varien::useValidateRemoteAddr(): Use REMOTE_ADDR in validator key

Inherited Methods

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

SESSION_ID_QUERY_PARAM = 'SID' (line 52)

XML_NODE_SESSION_SAVE = 'global/session_save' (line 40)

XML_NODE_SESSION_SAVE_PATH = 'global/session_save_path' (line 41)

XML_NODE_USET_AGENT_SKIP = 'global/session/validation/http_user_agent_skip' (line 49)

XML_PATH_COOKIE_DOMAIN = 'web/cookie/cookie_domain' (line 37)

XML_PATH_COOKIE_LIFETIME = 'web/cookie/cookie_lifetime' (line 39)

XML_PATH_COOKIE_PATH = 'web/cookie/cookie_path' (line 38)

XML_PATH_LOG_EXCEPTION_FILE = 'dev/log/exception_file' (line 50)

XML_PATH_USE_FRONTEND_SID = 'web/session/use_frontend_sid' (line 47)

XML_PATH_USE_HTTP_VIA = 'web/session/use_http_via' (line 44)

XML_PATH_USE_REMOTE_ADDR = 'web/session/use_remote_addr' (line 43)

XML_PATH_USE_USER_AGENT = 'web/session/use_http_user_agent' (line 46)

XML_PATH_USE_X_FORWARDED = 'web/session/use_http_x_forwarded_for' (line 45)

Inherited Constants

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

Class Mage_Core_Model_Session_Abstract

Inherited Methods

Inherited Constants