Class Mage_Checkout_Model_Session

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 license@magentocommerce.com 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.

Varien_Object

Mage_Core_Model_Session_Abstract_Varien

Mage_Core_Model_Session_Abstract

Mage_Checkout_Model_Session

Package: Mage\Checkout
Category: Mage
Copyright: Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)
License: Open Software License (OSL 3.0)
Located at code/core/Mage/Checkout/Model/Session.php

Methods summary
`public`	# `__construct( )` Class constructor. Initialize checkout session namespace Class constructor. Initialize checkout session namespace
`public Mage_Core_Model_Session_Abstract_Varien`	# `unsetAll( )` Unset all data associated with object Unset all data associated with object Returns `Mage_Core_Model_Session_Abstract_Varien` Overrides `Mage_Core_Model_Session_Abstract_Varien::unsetAll()`
`public Mage_Checkout_Model_Session`	# `setCustomer( Mage_Customer_Model_Customer\|null $customer )` Set customer instance Set customer instance Parameters `$customer` `Mage_Customer_Model_Customer\|null` $customer Returns `Mage_Checkout_Model_Session`
`public boolean`	# `hasQuote( )` Check whether current session has quote Check whether current session has quote Returns `boolean`
`public Mage_Checkout_Model_Session`	# `setLoadInactive( boolean $load = true )` Set quote to be loaded even if inactive Set quote to be loaded even if inactive Parameters `$load` `boolean` $load Returns `Mage_Checkout_Model_Session`
`public Mage_Sales_Model_Quote`	# `getQuote( )` Get checkout quote instance by current session Get checkout quote instance by current session Returns `Mage_Sales_Model_Quote`
`protected`	# `_getQuoteIdKey( )`
`public`	# `setQuoteId( mixed $quoteId )`
`public`	# `getQuoteId( )`
`public Mage_Checkout_Model_Session`	# `loadCustomerQuote( )` Load data for customer quote and merge with current quote Load data for customer quote and merge with current quote Returns `Mage_Checkout_Model_Session`
`public`	# `setStepData( mixed $step, mixed $data, mixed $value = null )`
`public`	# `getStepData( mixed $step = null, mixed $data = null )`
`public array`	# `getAdditionalMessages( boolean $clear = false )` 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 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 Parameters `$clear` `boolean` $clear Returns `array`
`public null\|Mage_Core_Model_Message_Collection`	# `getItemAdditionalMessages( string $itemKey, boolean $clear = false )` Retrieves list of item additional messages itemKey is a unique hash (e.g 'quote_item17') to distinguish item messages among message collections Retrieves list of item additional messages itemKey is a unique hash (e.g 'quote_item17') to distinguish item messages among message collections Parameters `$itemKey` `string` $itemKey `$clear` `boolean` $clear Returns `null\|Mage_Core_Model_Message_Collection`
`public Mage_Checkout_Model_Session`	# `addItemAdditionalMessage( string $itemKey, Mage_Core_Model_Message $message )` 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 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 Parameters `$itemKey` `string` $itemKey `$message` `Mage_Core_Model_Message` $message Returns `Mage_Checkout_Model_Session`
`public null\|Mage_Core_Model_Message_Collection`	# `getQuoteItemMessages( integer $itemId, boolean $clear = false )` Retrieves list of quote item messages Retrieves list of quote item messages Parameters `$itemId` `integer` $itemId `$clear` `boolean` $clear Returns `null\|Mage_Core_Model_Message_Collection`
`public Mage_Checkout_Model_Session`	# `addQuoteItemMessage( integer $itemId, Mage_Core_Model_Message $message )` Adds new message to a list of quote item messages, saved in this session Adds new message to a list of quote item messages, saved in this session Parameters `$itemId` `integer` $itemId `$message` `Mage_Core_Model_Message` $message Returns `Mage_Checkout_Model_Session`
`public Mage_Core_Model_Session_Abstract_Varien`	# `clear( )` Alias for unsetAll Alias for unsetAll Returns `Mage_Core_Model_Session_Abstract_Varien` Overrides `Mage_Core_Model_Session_Abstract_Varien::clear()`
`public`	# `clearHelperData( )` Clear misc checkout parameters Clear misc checkout parameters
`public`	# `resetCheckout( )`
`public`	# `replaceQuote( mixed $quote )`

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(), renewSession(), setSessionId(), setSkipSessionIdFlag(), useSid(), useValidateHttpUserAgent(), useValidateHttpVia(), useValidateHttpXForwardedFor(), useValidateRemoteAddr()

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

Constants summary
`string`	`CHECKOUT_STATE_BEGIN`	`'begin'`	#

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 null\|Mage_Sales_Model_Quote`	`$_quote`		# Quote instance Quote instance
`protected null\|Mage_Customer_Model_Customer`	`$_customer`		# Customer instance Customer instance
`protected boolean`	`$_loadInactive`	`false`	# Whether load only active quote Whether load only active quote

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

Packages

Classes

Interfaces

Class Mage_Checkout_Model_Session

Returns

Overrides

Parameters

Returns

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Overrides