Class Mage_Checkout_Model_Session

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

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.

Located in /Checkout/Model/Session.php (line 28) 

Varien_Object
   |
   --Mage_Core_Model_Session_Abstract_Varien
      |
      --Mage_Core_Model_Session_Abstract
         |
         --Mage_Checkout_Model_Session
Class Constant Summary
Description | Constants (details) Vars (details) | | Methods (details)
CHECKOUT_STATE_BEGIN = 'begin'
Variable Summary
Description | Vars (details) | Methods (details) Constants (details)
mixed $_quote
Method Summary
Description | Constants (details) Vars (details) | Methods (details)
Mage_Checkout_Model_Session __construct ()
Mage_Checkout_Model_Session addItemAdditionalMessage (string $itemKey, Mage_Core_Model_Message $message)
Mage_Checkout_Model_Session addQuoteItemMessage (int $itemId, Mage_Core_Model_Message $message)
void clear ()
void clearHelperData ()
array getAdditionalMessages ([bool $clear = false])
null|Mage_Core_Model_Message_Collection getItemAdditionalMessages (string $itemKey, [bool $clear = false])
Mage_Sales_Model_Quote getQuote ()
void getQuoteId ()
null|Mage_Core_Model_Message_Collection getQuoteItemMessages (int $itemId, [bool $clear = false])
void getStepData ([ $step = null], [ $data = null])
Mage_Checkout_Model_Session loadCustomerQuote ()
void replaceQuote ( $quote)
void resetCheckout ()
void setQuoteId ( $quoteId)
void setStepData ( $step,  $data, [ $value = null])
void unsetAll ()
void _getQuoteIdKey ()
Variables
Description | Vars (details) Constants (details) | Methods (details)
mixed $_quote = null (line 31)
  • 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 (details) Methods (details)
Constructor __construct (line 36)

Class constructor. Initialize checkout session namespace

  • access: public
Mage_Checkout_Model_Session __construct ()
addItemAdditionalMessage (line 256)

Adds new message in this session to a list of additional messages for some item itemKey is a unique hash (e.g 'quote_item17') to distinguish item messages among message collections

  • access: public
Mage_Checkout_Model_Session addItemAdditionalMessage (string $itemKey, Mage_Core_Model_Message $message)
addQuoteItemMessage (line 288)

Adds new message to a list of quote item messages, saved in this session

Mage_Checkout_Model_Session addQuoteItemMessage (int $itemId, Mage_Core_Model_Message $message)
clear (line 293)
  • access: public
void clear ()
Redefinition of:
Mage_Core_Model_Session_Abstract_Varien::clear()
Alias for unsetAll
clearHelperData (line 304)

Clear misc checkout parameters

  • access: public
void clearHelperData ()
getAdditionalMessages (line 211)

Retrieves list of all saved additional messages for different instances (e.g. quote items) in checkout session Returned: array(itemKey => messageCollection, ...) where itemKey is a unique hash (e.g 'quote_item17') to distinguish item messages among message collections

  • access: public
array getAdditionalMessages ([bool $clear = false])
  • bool $clear
getItemAdditionalMessages (line 232)

Retrieves list of item additional messages itemKey is a unique hash (e.g 'quote_item17') to distinguish item messages among message collections

  • access: public
null|Mage_Core_Model_Message_Collection getItemAdditionalMessages (string $itemKey, [bool $clear = false])
  • string $itemKey
  • bool $clear
getQuote (line 55)

Get checkout quote instance by current session

  • access: public
Mage_Sales_Model_Quote getQuote ()
getQuoteId (line 125)
  • access: public
void getQuoteId ()
getQuoteItemMessages (line 275)

Retrieves list of quote item messages

  • access: public
null|Mage_Core_Model_Message_Collection getQuoteItemMessages (int $itemId, [bool $clear = false])
  • int $itemId
  • bool $clear
getStepData (line 184)
  • access: public
void getStepData ([ $step = null], [ $data = null])
  • $step
  • $data
loadCustomerQuote (line 135)

Load data for customer quote and merge with current quote

  • access: public
Mage_Checkout_Model_Session loadCustomerQuote ()
replaceQuote (line 321)
  • access: public
void replaceQuote ( $quote)
  • $quote
resetCheckout (line 315)
  • access: public
void resetCheckout ()
setQuoteId (line 120)
  • access: public
void setQuoteId ( $quoteId)
  • $quoteId
setStepData (line 164)
  • access: public
void setStepData ( $step,  $data, [ $value = null])
  • $step
  • $data
  • $value
unsetAll (line 44)

Unset all data associated with object

  • access: public
void unsetAll ()
Redefinition of:
Mage_Core_Model_Session_Abstract_Varien::unsetAll()
Unset all data
_getQuoteIdKey (line 115)
  • access: protected
void _getQuoteIdKey ()

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)
CHECKOUT_STATE_BEGIN = 'begin' (line 30)

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