Mage_Adminhtml_Block_Sales_Order_Create_Shipping_Method_Form Class Reference

Inheritance diagram for Mage_Adminhtml_Block_Sales_Order_Create_Shipping_Method_Form:

List of all members.

Public Member Functions
	__construct ()
	getAddress ()
	getShippingRates ()
	getCarrierName ($carrierCode)
	getShippingMethod ()
	isMethodActive ($code)
	getActiveMethodRate ()
	getIsRateRequest ()
	getShippingPrice ($price, $flag)
Protected Attributes
	$_rates

---

Detailed Description

Definition at line 34 of file Form.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 38 of file Form.php.

    {
        parent::__construct();
        $this->setId('sales_order_create_shipping_method_form');
    }

---

Member Function Documentation

getActiveMethodRate

(

)

Retrieve rate of active shipping method

Returns:

Mage_Sales_Model_Quote_Address_Rate || false

Definition at line 119 of file Form.php.

    {
        $rates = $this->getShippingRates();
        if (is_array($rates)) {
            foreach ($rates as $group) {
                foreach ($group as $code => $rate) {
                    if ($rate->getCode() == $this->getShippingMethod()) {
                        return $rate;
                    }
                }
            }
        }
        return false;
    }

getAddress

(

)

Retrieve quote shipping address model

Returns:

Mage_Sales_Model_Quote_Address

Definition at line 49 of file Form.php.

    {
        return $this->getQuote()->getShippingAddress();
    }

getCarrierName

(

$

carrierCode

)

Rertrieve carrier name from store configuration

Parameters:

string

$carrierCode

Returns:

string

Definition at line 85 of file Form.php.

    {
        if ($name = Mage::getStoreConfig('carriers/'.$carrierCode.'/title', $this->getStore()->getId())) {
            return $name;
        }
        return $carrierCode;
    }

getIsRateRequest

(

)

Definition at line 134 of file Form.php.

    {
        return $this->getRequest()->getParam('collect_shipping_rates');
    }

getShippingMethod

(

)

Retrieve current selected shipping method

Returns:

string

Definition at line 98 of file Form.php.

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

getShippingPrice	(	$	price,
		$	flag
	)

Definition at line 139 of file Form.php.

    {
        return $this->getQuote()->getStore()->convertPrice(Mage::helper('tax')->getShippingPrice($price, $flag, $this->getAddress()), true);
    }

getShippingRates

(

)

Retrieve array of shipping rates groups

Returns:

array

Definition at line 59 of file Form.php.

    {
        if (empty($this->_rates)) {
            $groups = $this->getAddress()->getGroupedAllShippingRates();
            /*
            if (!empty($groups)) {

                $ratesFilter = new Varien_Filter_Object_Grid();
                $ratesFilter->addFilter($this->getStore()->getPriceFilter(), 'price');

                foreach ($groups as $code => $groupItems) {
                    $groups[$code] = $ratesFilter->filter($groupItems);
                }
            }
            */
            return $this->_rates = $groups;
        }
        return $this->_rates;
    }

isMethodActive

(

$

code

)

Check activity of method by code

Parameters:

string

$code

Returns:

bool

Definition at line 109 of file Form.php.

    {
        return $code===$this->getShippingMethod();
    }

---

Member Data Documentation

$_rates [protected]

Definition at line 36 of file Form.php.

---

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

• app/code/core/Mage/Adminhtml/Block/Sales/Order/Create/Shipping/Method/Form.php