How is the \Magento\Payment\Helper\Data::getInfoBlockHtml() method implemented and used?

dmitry_fedyuk · March 25, 2017, 8:31am

Implementation

magento/magento2/blob/2.1.5/app/code/Magento/Payment/Helper/Data.php#L196-L224


/**
 * Render payment information block
 *
 * @param InfoInterface $info
 * @param int $storeId
 * @return string
 * @throws \Exception
 */
public function getInfoBlockHtml(InfoInterface $info, $storeId)
{
    $this->_appEmulation->startEnvironmentEmulation($storeId);


    try {
        // Retrieve specified view block from appropriate design package (depends on emulated store)
        $paymentBlock = $this->getInfoBlock($info);
        $paymentBlock->setArea(\Magento\Framework\App\Area::AREA_FRONTEND)
            ->setIsSecureMode(true);
        $paymentBlock->getMethod()
            ->setStore($storeId);
        $paymentBlockHtml = $paymentBlock->toHtml();
    } catch (\Exception $exception) {
        $this->_appEmulation->stopEnvironmentEmulation();
        throw $exception;
    }


    $this->_appEmulation->stopEnvironmentEmulation();


    return $paymentBlockHtml;
}

Usages

It is used only for the transactional emails.

1. Magento\Sales\Model\Order\Creditmemo\Sender\EmailSender::getPaymentHtml()

github.com

magento/magento2/blob/2.1.5/app/code/Magento/Sales/Model/Order/Creditmemo/Sender/EmailSender.php#L135-L148


/**
 * Returns payment info block as HTML.
 *
 * @param \Magento\Sales\Api\Data\OrderInterface $order
 *
 * @return string
 */
private function getPaymentHtml(\Magento\Sales\Api\Data\OrderInterface $order)
{
    return $this->paymentHelper->getInfoBlockHtml(
        $order->getPayment(),
        $this->identityContainer->getStore()->getStoreId()
    );
}

2. Magento\Sales\Model\Order\Email\Sender\CreditmemoSender::getPaymentHtml()

github.com

magento/magento2/blob/2.1.5/app/code/Magento/Sales/Model/Order/Email/Sender/CreditmemoSender.php#L136-L148


/**
 * Return payment info block as html
 *
 * @param Order $order
 * @return string
 */
protected function getPaymentHtml(Order $order)
{
    return $this->paymentHelper->getInfoBlockHtml(
        $order->getPayment(),
        $this->identityContainer->getStore()->getStoreId()
    );
}

3. Magento\Sales\Model\Order\Email\Sender\InvoiceSender::getPaymentHtml()

github.com

magento/magento2/blob/2.1.5/app/code/Magento/Sales/Model/Order/Email/Sender/InvoiceSender.php#L136-L148


/**
 * Return payment info block as html
 *
 * @param Order $order
 * @return string
 */
protected function getPaymentHtml(Order $order)
{
    return $this->paymentHelper->getInfoBlockHtml(
        $order->getPayment(),
        $this->identityContainer->getStore()->getStoreId()
    );
}

4. Magento\Sales\Model\Order\Email\Sender\OrderSender::getPaymentHtml()

github.com

magento/magento2/blob/2.1.5/app/code/Magento/Sales/Model/Order/Email/Sender/OrderSender.php#L142-L154


/**
 * Get payment info block as html
 *
 * @param Order $order
 * @return string
 */
protected function getPaymentHtml(Order $order)
{
    return $this->paymentHelper->getInfoBlockHtml(
        $order->getPayment(),
        $this->identityContainer->getStore()->getStoreId()
    );
}

5. Magento\Sales\Model\Order\Email\Sender\ShipmentSender::getPaymentHtml()

github.com

magento/magento2/blob/2.1.5/app/code/Magento/Sales/Model/Order/Email/Sender/ShipmentSender.php#L136-L148


/**
 * Get payment info block as html
 *
 * @param Order $order
 * @return string
 */
protected function getPaymentHtml(Order $order)
{
    return $this->paymentHelper->getInfoBlockHtml(
        $order->getPayment(),
        $this->identityContainer->getStore()->getStoreId()
    );
}

6. Magento\Sales\Model\Order\Invoice\Sender\EmailSender::getPaymentHtml()

github.com

magento/magento2/blob/2.1.5/app/code/Magento/Sales/Model/Order/Invoice/Sender/EmailSender.php#L135-L148


/**
 * Returns payment info block as HTML.
 *
 * @param \Magento\Sales\Api\Data\OrderInterface $order
 *
 * @return string
 */
private function getPaymentHtml(\Magento\Sales\Api\Data\OrderInterface $order)
{
    return $this->paymentHelper->getInfoBlockHtml(
        $order->getPayment(),
        $this->identityContainer->getStore()->getStoreId()
    );
}

7. Magento\Sales\Model\Order\Shipment\Sender\EmailSender::getPaymentHtml()

github.com

magento/magento2/blob/2.1.5/app/code/Magento/Sales/Model/Order/Shipment/Sender/EmailSender.php#L135-L148


/**
 * Returns payment info block as HTML.
 *
 * @param \Magento\Sales\Api\Data\OrderInterface $order
 *
 * @return string
 */
private function getPaymentHtml(\Magento\Sales\Api\Data\OrderInterface $order)
{
    return $this->paymentHelper->getInfoBlockHtml(
        $order->getPayment(),
        $this->identityContainer->getStore()->getStoreId()
    );
}