Mage_Checkout_Model_Type_Multishipping_State Class Reference

Inheritance diagram for Mage_Checkout_Model_Type_Multishipping_State:

List of all members.

Public Member Functions
	__construct ()
	getCheckout ()
	getSteps ()
	getActiveStep ()
	setActiveStep ($step)
	setCompleteStep ($step)
	getCompleteStep ($step)
	unsCompleteStep ($step)
	canSelectAddresses ()
	canInputShipping ()
	canSeeOverview ()
	canSuccess ()
	getCheckoutSession ()
Public Attributes
const	STEP_SELECT_ADDRESSES = 'multishipping_addresses'
const	STEP_SHIPPING = 'multishipping_shipping'
const	STEP_BILLING = 'multishipping_billing'
const	STEP_OVERVIEW = 'multishipping_overview'
const	STEP_SUCCESS = 'multishipping_success'
Protected Attributes
	$_steps
	$_checkout

---

Detailed Description

Definition at line 34 of file State.php.

---

Constructor & Destructor Documentation

__construct

(

)

Init model, steps

Reimplemented from Varien_Object.

Definition at line 60 of file State.php.

    {
        parent::__construct();
        $this->_steps = array(
            self::STEP_SELECT_ADDRESSES => new Varien_Object(array(
                'label' => Mage::helper('checkout')->__('Select Addresses')
            )),
            self::STEP_SHIPPING => new Varien_Object(array(
                'label' => Mage::helper('checkout')->__('Shipping Information')
            )),
            self::STEP_BILLING => new Varien_Object(array(
                'label' => Mage::helper('checkout')->__('Billing Information')
            )),
            self::STEP_OVERVIEW => new Varien_Object(array(
                'label' => Mage::helper('checkout')->__('Place Order')
            )),
            self::STEP_SUCCESS => new Varien_Object(array(
                'label' => Mage::helper('checkout')->__('Order Success')
            )),
        );

        foreach ($this->_steps as $step) {
            $step->setIsComplete(false);
        }

        $this->_checkout = Mage::getSingleton('checkout/type_multishipping');
        $this->_steps[$this->getActiveStep()]->setIsActive(true);
    }

---

Member Function Documentation

canInputShipping

(

)

Definition at line 189 of file State.php.

    {

    }

canSeeOverview

(

)

Definition at line 194 of file State.php.

    {

    }

canSelectAddresses

(

)

Definition at line 184 of file State.php.

    {

    }

canSuccess

(

)

Definition at line 199 of file State.php.

    {

    }

getActiveStep

(

)

Retrieve active step code

Returns:

string

Definition at line 114 of file State.php.

    {
        $step = $this->getCheckoutSession()->getCheckoutState();
        if (isset($this->_steps[$step])) {
            return $step;
        }
        return self::STEP_SELECT_ADDRESSES;
    }

getCheckout

(

)

Retrieve checkout model

Returns:

Mage_Checkout_Model_Type_Multishipping

Definition at line 94 of file State.php.

    {
        return $this->_checkout;
    }

getCheckoutSession

(

)

Retrieve checkout session

Returns:

Mage_Checkout_Model_Session

Definition at line 209 of file State.php.

    {
        return Mage::getSingleton('checkout/session');
    }

getCompleteStep

(

$

step

)

Retrieve step complete status

Parameters:

string

$step

Returns:

bool

Definition at line 162 of file State.php.

    {
        if (isset($this->_steps[$step])) {
            return $this->getCheckoutSession()->getStepData($step, 'is_complete');
        }
        return false;
    }

getSteps

(

)

Retrieve available checkout steps

Returns:

array

Definition at line 104 of file State.php.

    {
        return $this->_steps;
    }

setActiveStep

(

$

step

)

Definition at line 123 of file State.php.

    {
        if (isset($this->_steps[$step])) {
            $this->getCheckoutSession()->setCheckoutState($step);
        }
        else {
            $this->getCheckoutSession()->setCheckoutState(self::STEP_SELECT_ADDRESSES);
        }

        // Fix active step changing
        if(!$this->_steps[$step]->getIsActive()) {
            foreach($this->getSteps() as $stepObject) {
                $stepObject->unsIsActive();
            }
            $this->_steps[$step]->setIsActive(true);
        }
        return $this;
    }

setCompleteStep

(

$

step

)

Mark step as completed

Parameters:

string

$step

Returns:

Mage_Checkout_Model_Type_Multishipping_State

Definition at line 148 of file State.php.

    {
        if (isset($this->_steps[$step])) {
            $this->getCheckoutSession()->setStepData($step, 'is_complete', true);
        }
        return $this;
    }

unsCompleteStep

(

$

step

)

Unset complete status from step

Parameters:

string

$step

Returns:

Mage_Checkout_Model_Type_Multishipping_State

Definition at line 176 of file State.php.

    {
        if (isset($this->_steps[$step])) {
            $this->getCheckoutSession()->setStepData($step, 'is_complete', false);
        }
        return $this;
    }

---

Member Data Documentation

$_checkout [protected]

Definition at line 54 of file State.php.

$_steps [protected]

Definition at line 47 of file State.php.

const STEP_BILLING = 'multishipping_billing'

Definition at line 38 of file State.php.

const STEP_OVERVIEW = 'multishipping_overview'

Definition at line 39 of file State.php.

const STEP_SELECT_ADDRESSES = 'multishipping_addresses'

Definition at line 36 of file State.php.

const STEP_SHIPPING = 'multishipping_shipping'

Definition at line 37 of file State.php.

const STEP_SUCCESS = 'multishipping_success'

Definition at line 40 of file State.php.

---

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

• app/code/core/Mage/Checkout/Model/Type/Multishipping/State.php