Docs For Class Mage_Core_Model_Session_Abstract

Description

Magento

NOTICE OF LICENSE

This source file is subject to the Open Software License (OSL 3.0) that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://opensource.org/licenses/osl-3.0.php If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to [email protected] so we can send you a copy immediately.

DISCLAIMER

Do not edit or add to this file if you wish to upgrade Magento to newer versions in the future. If you wish to customize Magento for your needs please refer to http://www.magentocommerce.com for more information.

copyright: Copyright (c) 2010 Magento Inc. (http://www.magentocommerce.com)
license: Open Software License (OSL 3.0)

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

Varien_Object
   |
   --Mage_Core_Model_Session_Abstract_Varien

Direct descendents

Class	Description
Mage_Core_Model_Session_Abstract	Core Session Abstract model

Class Constant Summary

VALIDATOR_HTTP_USER_AGENT_KEY = 'http_user_agent'

VALIDATOR_HTTP_VIA_KEY = 'http_via'

VALIDATOR_HTTP_X_FORVARDED_FOR_KEY = 'http_x_forwarded_for'

VALIDATOR_KEY = '_session_validator_data'

VALIDATOR_REMOTE_ADDR_KEY = 'remote_addr'

Method Summary

Mage_Core_Model_Session_Abstract_Varien clear ()

Mage_Core_Model_Cookie getCookie ()

mixed getData ([string $key = ''], [bool $clear = false])

string getSessionId ()

string getSessionName ()

string getSessionSaveMethod ()

string getSessionSavePath ()

array getValidateHttpUserAgentSkip ()

array getValidatorData ()

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

Mage_Core_Model_Session_Abstract_Varien revalidateCookie ()

Mage_Core_Model_Session_Abstract_Varien setSessionId ([string $id = null])

Mage_Core_Model_Session_Abstract_Varien setSessionName (string $name)

Mage_Core_Model_Session_Abstract_Varien start ([string $sessionName = null])

Mage_Core_Model_Session_Abstract_Varien unsetAll ()

bool useValidateHttpUserAgent ()

bool useValidateHttpVia ()

bool useValidateHttpXForwardedFor ()

bool useValidateRemoteAddr ()

Mage_Core_Model_Session_Abstract_Varien validate (string $namespace)

bool _validate ()

Methods

clear (line 250)

Alias for unsetAll

access: public

Mage_Core_Model_Session_Abstract_Varien clear ()

Redefined in descendants as:

getCookie (line 133)

Retrieve cookie object

access: public

Mage_Core_Model_Cookie getCookie ()

getData (line 179)

Additional get data with clear mode

access: public

mixed getData ([string $key = ''], [bool $clear = false])

string $key
bool $clear

getSessionId (line 193)

Retrieve session Id

access: public

string getSessionId ()

Redefined in descendants as:

Mage_Api_Model_Session::getSessionId()

getSessionName (line 217)

Retrieve session name

access: public

string getSessionName ()

getSessionSaveMethod (line 261)

Retrieve session save method Default files

access: public

string getSessionSaveMethod ()

Redefined in descendants as:

Mage_Core_Model_Session_Abstract::getSessionSaveMethod() : Retrieve session save method

getSessionSavePath (line 271)

Get sesssion save path

access: public

string getSessionSavePath ()

Redefined in descendants as:

Mage_Core_Model_Session_Abstract::getSessionSavePath() : Get sesssion save path

getValidateHttpUserAgentSkip (line 321)

Retrieve skip User Agent validation strings (Flash etc)

access: public

array getValidateHttpUserAgentSkip ()

Redefined in descendants as:

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

getValidatorData (line 381)

Retrieve unique user data for validator

access: public

array getValidatorData ()

init (line 155)

Init session with namespace

access: public

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

string $namespace
string $sessionName

Redefined in descendants as:

Mage_Core_Model_Session_Abstract::init() : Init session
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()

revalidateCookie (line 143)

Revalidate cookie

deprecated: after 1.4 cookie renew moved to session start method
access: public

Mage_Core_Model_Session_Abstract_Varien revalidateCookie ()

Redefined in descendants as:

Mage_Api_Model_Session::revalidateCookie()

setSessionId (line 204)

Set custom session id

access: public

Mage_Core_Model_Session_Abstract_Varien setSessionId ([string $id = null])

string $id

Redefined in descendants as:

Mage_Core_Model_Session_Abstract::setSessionId() : Specify session identifier
Mage_Api_Model_Session::setSessionId()

setSessionName (line 228)

Set session name

access: public

Mage_Core_Model_Session_Abstract_Varien setSessionName (string $name)

string $name

start (line 42)

Conigure and start session

access: public

Mage_Core_Model_Session_Abstract_Varien start ([string $sessionName = null])

string $sessionName

Redefined in descendants as:

Mage_Api_Model_Session::start()

unsetAll (line 239)

Unset all data

access: public

Mage_Core_Model_Session_Abstract_Varien unsetAll ()

Redefined in descendants as:

Mage_Checkout_Model_Session::unsetAll() : Unset all data associated with object

useValidateHttpUserAgent (line 311)

Use HTTP_USER_AGENT in validator key

access: public

bool useValidateHttpUserAgent ()

Redefined in descendants as:

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

useValidateHttpVia (line 291)

Use HTTP_VIA in validator key

access: public

bool useValidateHttpVia ()

Redefined in descendants as:

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

useValidateHttpXForwardedFor (line 301)

Use HTTP_X_FORWARDED_FOR in validator key

access: public

bool useValidateHttpXForwardedFor ()

Redefined in descendants as:

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

useValidateRemoteAddr (line 281)

Use REMOTE_ADDR in validator key

access: public

bool useValidateRemoteAddr ()

Redefined in descendants as:

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

validate (line 332)

Validate session

access: public

Mage_Core_Model_Session_Abstract_Varien validate (string $namespace)

string $namespace

_validate (line 353)

Validate data

access: protected

bool _validate ()

Class Constants

VALIDATOR_HTTP_USER_AGENT_KEY = 'http_user_agent' (line 31)

VALIDATOR_HTTP_VIA_KEY = 'http_via' (line 33)

VALIDATOR_HTTP_X_FORVARDED_FOR_KEY = 'http_x_forwarded_for' (line 32)

VALIDATOR_KEY = '_session_validator_data' (line 30)

VALIDATOR_REMOTE_ADDR_KEY = 'remote_addr' (line 34)

Class Mage_Core_Model_Session_Abstract_Varien