How is a payment method's getFormBlockType() used?

dmitry_fedyuk · February 11, 2016, 10:36pm

Declaration

magento/magento2/blob/6ce74b2/app/code/Magento/Payment/Model/MethodInterface.php#L25-L32


/**
 * Retrieve block type for method form generation
 *
 * @return string
 * 
 * @deprecated
 */
public function getFormBlockType();

Definition

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Payment/Model/Method/AbstractMethod.php#L69-L72


/**
 * @var string
 */
protected $_formBlockType = 'Magento\Payment\Block\Form';

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Payment/Model/Method/AbstractMethod.php#L510-L518


/**
 * Retrieve block type for method form generation
 *
 * @return string
 */
public function getFormBlockType()
{
    return $this->_formBlockType;
}

Usage

It is used only while creation an order in the backend.

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Payment/Helper/Data.php#L165-L177


/**
 * Retrieve payment method form html
 *
 * @param MethodInterface $method
 * @param LayoutInterface $layout
 * @return Form
 */
public function getMethodFormBlock(MethodInterface $method, LayoutInterface $layout)
{
    $block = $layout->createBlock($method->getFormBlockType(), $method->getCode());
    $block->setMethod($method);
    return $block;
}

github.com

magento/magento2/blob/cf7df72/app/code/Magento/Payment/Block/Form/Container.php#L44-L62


/**
 * Prepare children blocks
 *
 * @return $this
 */
protected function _prepareLayout()
{
    /**
     * Create child blocks for payment methods forms
     */
    foreach ($this->getMethods() as $method) {
        $this->setChild(
            'payment.method.' . $method->getCode(),
            $this->_paymentHelper->getMethodFormBlock($method, $this->_layout)
        );
    }


    return parent::_prepareLayout();
}

github.com

magento/magento2/blob/cf7df72/app/code/Magento/Sales/Block/Adminhtml/Order/Create/Billing/Method/Form.php#L6-L13


namespace Magento\Sales\Block\Adminhtml\Order\Create\Billing\Method;


/**
* Adminhtml sales order create payment method form block
*
* @author      Magento Core Team <core@magentocommerce.com>
*/
class Form extends \Magento\Payment\Block\Form\Container

github.com

magento/magento2/blob/cf7df72/app/code/Magento/Sales/view/adminhtml/layout/sales_order_create_index.xml#L54-L54


<block class="Magento\Sales\Block\Adminhtml\Order\Create\Billing\Method\Form" template="order/create/billing/method/form.phtml" name="order_create_billing_form" as="form"/>

github.com

magento/magento2/blob/cf7df72/app/code/Magento/Sales/view/adminhtml/layout/sales_order_create_load_block_billing_method.xml#L12-L12


<block class="Magento\Sales\Block\Adminhtml\Order\Create\Billing\Method\Form" template="order/create/billing/method/form.phtml" name="order.create.billing.method.form" as="form"/>

github.com

magento/magento2/blob/cf7df72/app/code/Magento/Sales/view/adminhtml/layout/sales_order_create_load_block_data.xml#L29-L29


<block class="Magento\Sales\Block\Adminhtml\Order\Create\Billing\Method\Form" template="order/create/billing/method/form.phtml" name="order.create.billing.method.form" as="form"/>

dmitry_fedyuk · February 11, 2016, 10:39pm