How does the Braintree module render a payment's information on a backend order's page?

dmitry_fedyuk · March 7, 2016, 12:16am

Preliminary context: How is the «Payment Information» block rendered on a backend order’s page?

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;
}

github.com

magento/magento2/blob/487f5f45/app/code/Magento/Braintree/Model/PaymentMethod.php#L40-L43


/**
 * @var string
 */
protected $_infoBlockType = 'Magento\Braintree\Block\Info';

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/Braintree/Block/Info.php#L53-L73


protected function _prepareSpecificInformation($transport = null)
{
    $transport = parent::_prepareSpecificInformation($transport);
    $data = [];
    $info = $this->getInfo();
    if ($ccType = $this->getCcTypeName()) {
        $data[__('Credit Card Type')->getText()] = $ccType;
    }
    if ($info->getCcLast4()) {
        $data[__('Credit Card Number')->getText()] =
            sprintf('xxxx-%s', $info->getCcLast4());
    }
    if ($this->_appState->getAreaCode() === \Magento\Backend\App\Area\FrontNameResolver::AREA_CODE
        && $info->getAdditionalInformation()
    ) {
        foreach ($info->getAdditionalInformation() as $field => $value) {
            $beautifiedFieldName = ucwords(trim(preg_replace('/(?<=\\w)(?=[A-Z])/', " $1", $field)));
            $data[__($beautifiedFieldName)->getText()] = $value;
        }
    }
    return $transport->setData(array_merge($data, $transport->getData()));

github.com

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


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

github.com

magento/magento2/blob/487f5f45/app/code/Magento/Braintree/Block/Info.php#L84-L102


public function getChildHtml($name = '', $useCache = true)
{
    $payment = $this->getRequest()->getPost('payment');
    $result = "";
    $deviceData = $this->getRequest()->getPost('device_data');


    if (isset($payment["cc_token"]) && $payment["cc_token"]) {
        $ccToken = $payment["cc_token"];
        $result .= "<input type='hidden' name='payment[cc_token]' value='$ccToken'>";
    }
    if (isset($payment['store_in_vault']) && $payment['store_in_vault']) {
        $storeInVault = $payment['store_in_vault'];
        $result .= "<input type='hidden' name='payment[store_in_vault]' value='$storeInVault'>";
    }
    if ($deviceData) {
        $result .= "<input type='hidden' name='device_data' value='$deviceData'>";
    }
    return $result;
}

dmitry_fedyuk · March 15, 2016, 2:44pm