Mage_Payment_Block_Form_Container Class Reference

Inheritance diagram for Mage_Payment_Block_Form_Container:

List of all members.

Public Member Functions
	setMethodFormTemplate ($method='', $template='')
	getMethods ()
	getSelectedMethodCode ()
Protected Member Functions
	_prepareLayout ()
	_canUseMethod ($method)
	_assignMethod ($method)

---

Detailed Description

Definition at line 34 of file Container.php.

---

Member Function Documentation

_assignMethod

(

$

method

)

[protected]

Check and prepare payment method model

Redeclare this method in child classes for declaring method info instance

Returns:

bool

Definition at line 84 of file Container.php.

    {
        $method->setInfoInstance($this->getQuote()->getPayment());
        return $this;
    }

_canUseMethod

(

$

method

)

[protected]

Checking for min/max order total for assigned payment method

Reimplemented in Mage_Adminhtml_Block_Sales_Order_Create_Billing_Method_Form, Mage_Checkout_Block_Multishipping_Billing, and Mage_Checkout_Block_Onepage_Payment_Methods.

Definition at line 54 of file Container.php.

    {
        if (!$method->canUseForCountry($this->getQuote()->getBillingAddress()->getCountry())) {
            return false;
        }

        if (!$method->canUseForCurrency(Mage::app()->getStore()->getBaseCurrencyCode())) {
            return false;
        }

        /**
         * Checking for min/max order total for assigned payment method
         */
        $total = $this->getQuote()->getBaseGrandTotal();
        $minTotal = $method->getConfigData('min_order_total');
        $maxTotal = $method->getConfigData('max_order_total');

        if((!empty($minTotal) && ($total < $minTotal)) || (!empty($maxTotal) && ($total > $maxTotal))) {
            return false;
        }
        return true;
    }

_prepareLayout

(

)

[protected]

Prepare children blocks

Create child blocks for payment methods forms

Reimplemented from Mage_Core_Block_Abstract.

Reimplemented in Mage_Checkout_Block_Multishipping_Billing.

Definition at line 39 of file Container.php.

    {
        /**
         * Create child blocks for payment methods forms
         */
        foreach ($this->getMethods() as $method) {
            $this->setChild(
               'payment.method.'.$method->getCode(),
               $this->helper('payment')->getMethodFormBlock($method)
            );
        }

        return parent::_prepareLayout();
    }

getMethods

(

)

Retrieve availale payment methods

Returns:

array

Definition at line 112 of file Container.php.

    {
        $methods = $this->getData('methods');
        if (is_null($methods)) {
            $store = $this->getQuote() ? $this->getQuote()->getStoreId() : null;
            $methods = $this->helper('payment')->getStoreMethods($store, $this->getQuote());
            foreach ($methods as $key => $method) {
                if ($this->_canUseMethod($method)) {
                    $this->_assignMethod($method);
                }
                else {
                    unset($methods[$key]);
                }
            }
            $this->setData('methods', $methods);
        }
        return $methods;
    }

getSelectedMethodCode

(

)

Retrieve code of current payment method

Returns:

mixed

Reimplemented in Mage_Adminhtml_Block_Sales_Order_Create_Billing_Method_Form, Mage_Checkout_Block_Multishipping_Billing, and Mage_Checkout_Block_Onepage_Payment_Methods.

Definition at line 136 of file Container.php.

    {
        $methods = $this->getMethods();
        if (!empty($methods)) {
            reset($methods);
            return current($methods)->getCode();
        }
        return false;
    }

setMethodFormTemplate	(	$	method = '',
		$	template = ''
	)

Declare template for payment method form block

Parameters:

	string	$method
	string	$template

Returns:

Mage_Payment_Block_Form_Container

Definition at line 97 of file Container.php.

    {
        if (!empty($method) && !empty($template)) {
            if ($block = $this->getChild('payment.method.'.$method)) {
                $block->setTemplate($template);
            }
        }
        return $this;
    }

---

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

• app/code/core/Mage/Payment/Block/Form/Container.php