Mage_Checkout_Block_Onepage_Abstract Class Reference

Inheritance diagram for Mage_Checkout_Block_Onepage_Abstract:

List of all members.

Public Member Functions
	getCustomer ()
	getCheckout ()
	getQuote ()
	isCustomerLoggedIn ()
	getCountryCollection ()
	getRegionCollection ()
	customerHasAddresses ()
	getAddressesHtmlSelect ($type)
	getCountryHtmlSelect ($type)
	getRegionHtmlSelect ($type)
	getCountryOptions ()
	isShow ()
Protected Attributes
	$_customer
	$_checkout
	$_quote
	$_countryCollection
	$_regionCollection
	$_addressesCollection

---

Detailed Description

One page common functionality block

Author:

Magento Core Team <core@magentocommerce.com>

Definition at line 32 of file Abstract.php.

---

Member Function Documentation

customerHasAddresses

(

)

Definition at line 104 of file Abstract.php.

    {
        return count($this->getCustomer()->getAddresses());
    }

getAddressesHtmlSelect

(

$

type

)

Definition at line 110 of file Abstract.php.

    {
        if ($this->isCustomerLoggedIn()) {
            $options = array();
            foreach ($this->getCustomer()->getAddresses() as $address) {
                $options[] = array(
                    'value'=>$address->getId(),
                    'label'=>$address->format('oneline')
                );
            }

            $addressId = $this->getAddress()->getId();
            if (empty($addressId)) {
                if ($type=='billing') {
                    $address = $this->getCustomer()->getPrimaryBillingAddress();
                } else {
                    $address = $this->getCustomer()->getPrimaryShippingAddress();
                }
                if ($address) {
                    $addressId = $address->getId();
                }
            }

            $select = $this->getLayout()->createBlock('core/html_select')
                ->setName($type.'_address_id')
                ->setId($type.'-address-select')
                ->setClass('address-select')
                ->setExtraParams('onchange="'.$type.'.newAddress(!this.value)"')
                ->setValue($addressId)
                ->setOptions($options);

            $select->addOption('', Mage::helper('checkout')->__('New Address'));

            return $select->getHtml();
        }
        return '';
    }

getCheckout

(

)

Retrieve checkout session model

Returns:

Mage_Checkout_Model_Session

Definition at line 59 of file Abstract.php.

    {
        if (empty($this->_checkout)) {
            $this->_checkout = Mage::getSingleton('checkout/session');
        }
        return $this->_checkout;
    }

getCountryCollection

(

)

Definition at line 85 of file Abstract.php.

    {
        if (!$this->_countryCollection) {
            $this->_countryCollection = Mage::getSingleton('directory/country')->getResourceCollection()
                ->loadByStore();
        }
        return $this->_countryCollection;
    }

getCountryHtmlSelect

(

$

type

)

Definition at line 148 of file Abstract.php.

    {
        $countryId = $this->getAddress()->getCountryId();
        if (is_null($countryId)) {
            $countryId = Mage::getStoreConfig('general/country/default');
        }
        $select = $this->getLayout()->createBlock('core/html_select')
            ->setName($type.'[country_id]')
            ->setId($type.':country_id')
            ->setTitle(Mage::helper('checkout')->__('Country'))
            ->setClass('validate-select')
            ->setValue($countryId)
            ->setOptions($this->getCountryOptions());
        if ($type === 'shipping') {
            $select->setExtraParams('onchange="shipping.setSameAsBilling(false);"');
        }

        return $select->getHtml();
    }

getCountryOptions

(

)

Definition at line 182 of file Abstract.php.

    {
        $options    = false;
        $useCache   = Mage::app()->useCache('config');
        if ($useCache) {
            $cacheId    = 'DIRECTORY_COUNTRY_SELECT_STORE_' . Mage::app()->getStore()->getCode();
            $cacheTags  = array('config');
            if ($optionsCache = Mage::app()->loadCache($cacheId)) {
                $options = unserialize($optionsCache);
            }
        }

        if ($options == false) {
            $options = $this->getCountryCollection()->toOptionArray();
            if ($useCache) {
                Mage::app()->saveCache(serialize($options), $cacheId, $cacheTags);
            }
        }
        return $options;
    }

getCustomer

(

)

Get logged in customer

Returns:

Mage_Customer_Model_Customer

Definition at line 46 of file Abstract.php.

    {
        if (empty($this->_customer)) {
            $this->_customer = Mage::getSingleton('customer/session')->getCustomer();
        }
        return $this->_customer;
    }

getQuote

(

)

Retrieve sales quote model

Returns:

Mage_Sales_Model_Quote

Definition at line 72 of file Abstract.php.

    {
        if (empty($this->_quote)) {
            $this->_quote = $this->getCheckout()->getQuote();
        }
        return $this->_quote;
    }

getRegionCollection

(

)

Definition at line 94 of file Abstract.php.

    {
        if (!$this->_regionCollection) {
            $this->_regionCollection = Mage::getModel('directory/region')->getResourceCollection()
                ->addCountryFilter($this->getAddress()->getCountryId())
                ->load();
        }
        return $this->_regionCollection;
    }

getRegionHtmlSelect

(

$

type

)

Definition at line 169 of file Abstract.php.

    {
        $select = $this->getLayout()->createBlock('core/html_select')
            ->setName($type.'[region]')
            ->setId($type.':region')
            ->setTitle(Mage::helper('checkout')->__('State/Province'))
            ->setClass('required-entry validate-state')
            ->setValue($this->getAddress()->getRegionId())
            ->setOptions($this->getRegionCollection()->toOptionArray());

        return $select->getHtml();
    }

isCustomerLoggedIn

(

)

Definition at line 80 of file Abstract.php.

    {
        return Mage::getSingleton('customer/session')->isLoggedIn();
    }

isShow

(

)

Retrieve is allow and show block

Returns:

bool

Reimplemented in Mage_Checkout_Block_Onepage_Shipping_Method, and Mage_Checkout_Block_Onepage_Shipping.

Definition at line 208 of file Abstract.php.

    {
        return true;
    }

---

Member Data Documentation

$_addressesCollection [protected]

Definition at line 39 of file Abstract.php.

$_checkout [protected]

Definition at line 35 of file Abstract.php.

$_countryCollection [protected]

Definition at line 37 of file Abstract.php.

$_customer [protected]

Definition at line 34 of file Abstract.php.

$_quote [protected]

Definition at line 36 of file Abstract.php.

$_regionCollection [protected]

Definition at line 38 of file Abstract.php.

---

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

• app/code/core/Mage/Checkout/Block/Onepage/Abstract.php