How is the «Payment Information» block rendered on a backend order's page?

dmitry_fedyuk · March 6, 2016, 11:54pm

magento/magento2/blob/487f5f45/app/code/Magento/Sales/view/adminhtml/layout/sales_order_view.xml#L34-L34


<block class="Magento\Sales\Block\Adminhtml\Order\Payment" name="order_payment"/>

github.com

magento/magento2/blob/487f5f45/app/code/Magento/Sales/Block/Adminhtml/Order/Payment.php#L38-L51


/**
 * Retrieve required options from parent
 *
 * @return void
 * @throws \Magento\Framework\Exception\LocalizedException
 */
protected function _beforeToHtml()
{
    if (!$this->getParentBlock()) {
        throw new \Magento\Framework\Exception\LocalizedException(__('Invalid parent block for this block'));
    }
    $this->setPayment($this->getParentBlock()->getOrder()->getPayment());
    parent::_beforeToHtml();
}

github.com

magento/magento2/blob/487f5f45/app/code/Magento/Sales/Block/Adminhtml/Order/Payment.php#L53-L65


/**
 * Set payment
 *
 * @param Info $payment
 * @return $this
 */
public function setPayment($payment)
{
    $paymentInfoBlock = $this->_paymentData->getInfoBlock($payment, $this->getLayout());
    $this->setChild('info', $paymentInfoBlock);
    $this->setData('payment', $payment);
    return $this;
}

github.com

magento/magento2/blob/487f5f45/app/code/Magento/Payment/Helper/Data.php#L179-L193


/**
 * Retrieve payment information block
 *
 * @param InfoInterface $info
 * @param \Magento\Framework\View\LayoutInterface $layout
 * @return Template
 */
public function getInfoBlock(InfoInterface $info, LayoutInterface $layout = null)
{
    $layout = $layout ?: $this->_layout;
    $blockType = $info->getMethodInstance()->getInfoBlockType();
    $block = $layout->createBlock($blockType);
    $block->setInfo($info);
    return $block;
}

How is a payment method’s getInfoBlockType() used?

Further reading: How does the Braintree module render a payment’s information on a backend order’s page?

github.com

magento/magento2/blob/487f5f45/app/code/Magento/Sales/Block/Adminhtml/Order/Payment.php#L67-L75


/**
 * Prepare html output
 *
 * @return string
 */
protected function _toHtml()
{
    return $this->getChildHtml('info');
}

github.com

magento/magento2/blob/487f5f45/app/code/Magento/Payment/Block/Info.php#L20-L23


/**
 * @var string
 */
protected $_template = 'Magento_Payment::info/default.phtml';

github.com

magento/magento2/blob/487f5f45/app/code/Magento/Payment/view/adminhtml/templates/info/default.phtml#L12-L29


$specificInfo = $block->getSpecificInformation();
?>
<?php echo $block->escapeHtml($block->getMethod()->getTitle()); ?>


<?php if ($specificInfo): ?>
<table class="data-table admin__table-secondary">
<?php foreach ($specificInfo as $label => $value):?>
    <tr>
        <th><?php echo $block->escapeHtml($label)?>:</th>
        <td>
            <?php /* @noEscape */ echo nl2br($block->escapeHtml(implode("\n", $block->getValueAsArray($value, true))));?>
        </td>
    </tr>
<?php endforeach; ?>
</table>
<?php endif;?>


<?php echo $block->getChildHtml()?>

github.com

magento/magento2/blob/487f5f45/app/code/Magento/Payment/Block/Info.php#L80-L88


/**
 * Get some specific information in format of array($label => $value)
 *
 * @return array
 */
public function getSpecificInformation()
{
    return $this->_prepareSpecificInformation()->getData();
}

github.com

magento/magento2/blob/487f5f45/app/code/Magento/Payment/Block/Info.php#L141-L158


/**
 * Prepare information specific to current payment method
 *
 * @param null|\Magento\Framework\DataObject|array $transport
 * @return \Magento\Framework\DataObject
 */
protected function _prepareSpecificInformation($transport = null)
{
    if (null === $this->_paymentSpecificInformation) {
        if (null === $transport) {
            $transport = new \Magento\Framework\DataObject();
        } elseif (is_array($transport)) {
            $transport = new \Magento\Framework\DataObject($transport);
        }
        $this->_paymentSpecificInformation = $transport;
    }
    return $this->_paymentSpecificInformation;
}

dmitry_fedyuk · March 7, 2016, 12:06am