Mage_Checkout_Block_Cart_Shipping Class Reference

Inheritance diagram for Mage_Checkout_Block_Cart_Shipping:

List of all members.

Public Member Functions
	getEstimateRates ()
	getAddress ()
	getCarrierName ($carrierCode)
	getAddressShippingMethod ()
	getEstimateCountryId ()
	getEstimatePostcode ()
	getEstimateCity ()
	getEstimateRegionId ()
	getEstimateRegion ()
	getCityActive ()
	getStateActive ()
	formatPrice ($price)
	getShippingPrice ($price, $flag)
	getCarriers ()
	isStateProvinceRequired ()
	isCityRequired ()
	isZipCodeRequired ()
Protected Attributes
	$_carriers = null
	$_rates = array()
	$_address = array()

---

Detailed Description

Definition at line 28 of file Shipping.php.

---

Member Function Documentation

formatPrice

(

$

price

)

Definition at line 104 of file Shipping.php.

    {
        return $this->getQuote()->getStore()->convertPrice($price, true);
    }

getAddress

(

)

Get address model

Returns:

Mage_Sales_Model_Quote_Address

Definition at line 48 of file Shipping.php.

    {
        if (empty($this->_address)) {
            $this->_address = $this->getQuote()->getShippingAddress();
        }
        return $this->_address;
    }

getAddressShippingMethod

(

)

Definition at line 64 of file Shipping.php.

    {
        return $this->getAddress()->getShippingMethod();
    }

getCarrierName

(

$

carrierCode

)

Definition at line 56 of file Shipping.php.

    {
        if ($name = Mage::getStoreConfig('carriers/'.$carrierCode.'/title')) {
            return $name;
        }
        return $carrierCode;
    }

getCarriers

(

)

Obtain available carriers instances

Returns:

array

Definition at line 119 of file Shipping.php.

    {
        if (null === $this->_carriers) {
            $this->_carriers = array();
            $this->getEstimateRates();
            foreach ($this->_rates as $rateGroup) {
                if (!empty($rateGroup)) {
                    foreach ($rateGroup as $rate) {
                        $this->_carriers[] = $rate->getCarrierInstance();
                    }
                }
            }
        }
        return $this->_carriers;
    }

getCityActive

(

)

Definition at line 94 of file Shipping.php.

    {
        return (bool)Mage::getStoreConfig('carriers/dhl/active');
    }

getEstimateCity

(

)

Definition at line 79 of file Shipping.php.

    {
        return $this->getAddress()->getCity();
    }

getEstimateCountryId

(

)

Definition at line 69 of file Shipping.php.

    {
        return $this->getAddress()->getCountryId();
    }

getEstimatePostcode

(

)

Definition at line 74 of file Shipping.php.

    {
        return $this->getAddress()->getPostcode();
    }

getEstimateRates

(

)

Definition at line 34 of file Shipping.php.

    {
        if (empty($this->_rates)) {
            $groups = $this->getAddress()->getGroupedAllShippingRates();
            $this->_rates = $groups;
        }
        return $this->_rates;
    }

getEstimateRegion

(

)

Definition at line 89 of file Shipping.php.

    {
        return $this->getAddress()->getRegion();
    }

getEstimateRegionId

(

)

Definition at line 84 of file Shipping.php.

    {
        return $this->getAddress()->getRegionId();
    }

getShippingPrice	(	$	price,
		$	flag
	)

Definition at line 109 of file Shipping.php.

    {
        return $this->formatPrice($this->helper('tax')->getShippingPrice($price, $flag, $this->getAddress()));
    }

getStateActive

(

)

Definition at line 99 of file Shipping.php.

    {
        return (bool)Mage::getStoreConfig('carriers/dhl/active') || (bool)Mage::getStoreConfig('carriers/tablerate/active');
    }

isCityRequired

(

)

Check if one of carriers require city

Returns:

bool

Definition at line 155 of file Shipping.php.

    {
        foreach ($this->getCarriers() as $carrier) {
            if ($carrier->isCityRequired()) {
                return true;
            }
        }
        return false;
    }

isStateProvinceRequired

(

)

Check if one of carriers require state/province

Returns:

bool

Definition at line 140 of file Shipping.php.

    {
        foreach ($this->getCarriers() as $carrier) {
            if ($carrier->isStateProvinceRequired()) {
                return true;
            }
        }
        return false;
    }

isZipCodeRequired

(

)

Check if one of carriers require zip code

Returns:

bool

Definition at line 170 of file Shipping.php.

    {
        foreach ($this->getCarriers() as $carrier) {
            if ($carrier->isZipCodeRequired()) {
                return true;
            }
        }
        return false;
    }

---

Member Data Documentation

$_address = array() [protected]

Definition at line 32 of file Shipping.php.

$_carriers = null [protected]

Definition at line 30 of file Shipping.php.

$_rates = array() [protected]

Definition at line 31 of file Shipping.php.

---

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

• app/code/core/Mage/Checkout/Block/Cart/Shipping.php