Mage_Checkout_Model_Session Class Reference

Inheritance diagram for Mage_Checkout_Model_Session:

List of all members.

Public Member Functions
	__construct ()
	unsetAll ()
	getQuote ()
	setQuoteId ($quoteId)
	getQuoteId ()
	loadCustomerQuote ()
	setStepData ($step, $data, $value=null)
	getStepData ($step=null, $data=null)
	clear ()
	resetCheckout ()
	replaceQuote ($quote)
Public Attributes
const	CHECKOUT_STATE_BEGIN = 'begin'
Protected Member Functions
	_getQuoteIdKey ()
Protected Attributes
	$_quote = null

---

Detailed Description

Definition at line 28 of file Session.php.

---

Constructor & Destructor Documentation

__construct

(

)

Constructor

By default is looking for first argument as array and assignes it as object attributes This behaviour may change in child classes

Reimplemented from Varien_Object.

Definition at line 33 of file Session.php.

    {
        $this->init('checkout');
    }

---

Member Function Documentation

_getQuoteIdKey

(

)

[protected]

Definition at line 91 of file Session.php.

    {
        return 'quote_id_' . Mage::app()->getStore()->getWebsiteId();
    }

clear

(

)

Alias for unsetAll

Returns:

Mage_Core_Model_Session_Abstract_Varien

Reimplemented from Mage_Core_Model_Session_Abstract_Varien.

Definition at line 172 of file Session.php.

    {
        Mage::dispatchEvent('checkout_quote_destroy', array('quote'=>$this->getQuote()));
        $this->_quote = null;
        $this->setQuoteId(null);
        $this->setLastSuccessQuoteId(null);
    }

getQuote

(

)

Get checkout quote instance by current session

Returns:

Mage_Sales_Model_Quote

Definition at line 49 of file Session.php.

    {
        if ($this->_quote === null) {
            $quote = Mage::getModel('sales/quote')
                ->setStoreId(Mage::app()->getStore()->getId());

            /* @var $quote Mage_Sales_Model_Quote */
            if ($this->getQuoteId()) {
                $quote->load($this->getQuoteId());
                if (!$quote->getId()) {
                    $this->setQuoteId(null);
                }
            }

            $customerSession = Mage::getSingleton('customer/session');

            if (!$this->getQuoteId()) {
                if ($customerSession->isLoggedIn()) {
                    $quote->loadByCustomer($customerSession->getCustomer());
                    $this->setQuoteId($quote->getId());
                } else {
                    $quote->setIsCheckoutCart(true);
                    Mage::dispatchEvent('checkout_quote_init', array('quote'=>$quote));
                }
            }

            if ($this->getQuoteId()) {
                if ($customerSession->isLoggedIn()) {
                    $quote->setCustomer($customerSession->getCustomer());
                }
            }

            $quote->setStore(Mage::app()->getStore());
            $this->_quote = $quote;
        }

        if (isset($_SERVER['REMOTE_ADDR'])) {
            $this->_quote->setRemoteIp($_SERVER['REMOTE_ADDR']);
        }
        return $this->_quote;
    }

getQuoteId

(

)

Definition at line 101 of file Session.php.

    {
        return $this->getData($this->_getQuoteIdKey());
    }

getStepData	(	$	step = null,
		$	data = null
	)

Definition at line 154 of file Session.php.

    {
        $steps = $this->getSteps();
        if (is_null($step)) {
            return $steps;
        }
        if (!isset($steps[$step])) {
            return false;
        }
        if (is_null($data)) {
            return $steps[$step];
        }
        if (!is_string($data) || !isset($steps[$step][$data])) {
            return false;
        }
        return $steps[$step][$data];
    }

loadCustomerQuote

(

)

Load data for customer quote and merge with current quote

Returns:

Mage_Checkout_Model_Session

Definition at line 111 of file Session.php.

    {
        $customerQuote = Mage::getModel('sales/quote')
            ->setStoreId(Mage::app()->getStore()->getId())
            ->loadByCustomer(Mage::getSingleton('customer/session')->getCustomerId());

        if ($this->getQuoteId() != $customerQuote->getId()) {
            if ($this->getQuoteId()) {
                $customerQuote->merge($this->getQuote())
                    ->collectTotals()
                    ->save();
            }

            $this->setQuoteId($customerQuote->getId());

            if ($this->_quote) {
                $this->_quote->delete();
            }
            $this->_quote = $customerQuote;
        }
        return $this;
    }

replaceQuote

(

$

quote

)

Definition at line 186 of file Session.php.

    {
        $this->_quote = $quote;
        $this->setQuoteId($quote->getId());
        return $this;
    }

resetCheckout

(

)

Definition at line 180 of file Session.php.

    {
        $this->setCheckoutState(self::CHECKOUT_STATE_BEGIN);
        return $this;
    }

setQuoteId

(

$

quoteId

)

Definition at line 96 of file Session.php.

    {
        $this->setData($this->_getQuoteIdKey(), $quoteId);
    }

setStepData	(	$	step,
		$	data,
		$	value = null
	)

Definition at line 134 of file Session.php.

    {
        $steps = $this->getSteps();
        if (is_null($value)) {
            if (is_array($data)) {
                $steps[$step] = $data;
            }
        } else {
            if (!isset($steps[$step])) {
                $steps[$step] = array();
            }
            if (is_string($data)) {
                $steps[$step][$data] = $value;
            }
        }
        $this->setSteps($steps);

        return $this;
    }

unsetAll

(

)

Unset all data

Returns:

Mage_Core_Model_Session_Abstract_Varien

Reimplemented from Mage_Core_Model_Session_Abstract_Varien.

Definition at line 38 of file Session.php.

    {
        parent::unsetAll();
        $this->_quote = null;
    }

---

Member Data Documentation

$_quote = null [protected]

Definition at line 31 of file Session.php.

const CHECKOUT_STATE_BEGIN = 'begin'

Definition at line 30 of file Session.php.

---

The documentation for this class was generated from the following file:

• app/code/core/Mage/Checkout/Model/Session.php