How to Add Custom Text after Billing Address and Shipping Address in Invoice PDF in Magento2

 


Steps to Add Custom Text after Billing Address and Shipping Address in Invoice PDF in Magento 2:

Step 1:  First, we need to create a “di.xml“ file inside our extension at the following path


app\code\Vendor\Extension\etc\adminhtml\


Then add the code as follows


<?xml version="1.0"?>

<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">

    <preference for="Magento\Sales\Model\Order\Pdf\Invoice" type="Vendor\Extension\Model\Order\Pdf\Invoice"/>

</config>

Step 2:  After that, we need to create an “Invoice.php” file inside our extension at the following path


app\code\Vendor\Extension\Model\Order\Pdf\


And add the code as given below


<?php

namespace Vendor\Extension\Model\Order\Pdf;

 

use Magento\Store\Model\ScopeInterface;

use Magento\Sales\Model\RtlTextHandler;

use Magento\Framework\App\ObjectManager;

 

class Invoice extends \Magento\Sales\Model\Order\Pdf\Invoice

{

    protected $_storeManager;

    protected $_localeResolver;

    private $appEmulation;

 

    public function __construct(

        \Magento\Payment\Helper\Data $paymentData,

        \Magento\Framework\Stdlib\StringUtils $string,

        \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig,

        \Magento\Framework\Filesystem $filesystem,

        \Magento\Sales\Model\Order\Pdf\Config $pdfConfig,

        \Magento\Sales\Model\Order\Pdf\Total\Factory $pdfTotalFactory,

        \Magento\Sales\Model\Order\Pdf\ItemsFactory $pdfItemsFactory,

        \Magento\Framework\Stdlib\DateTime\TimezoneInterface $localeDate,

        \Magento\Framework\Translate\Inline\StateInterface $inlineTranslation,

        \Magento\Sales\Model\Order\Address\Renderer $addressRenderer,

        \Magento\Store\Model\StoreManagerInterface $storeManager,

        \Magento\Store\Model\App\Emulation $appEmulation,

        \Magento\Framework\Locale\ResolverInterface $localeResolver,

        array $data = []

    )

    {

        $this->_storeManager = $storeManager;

        $this->appEmulation = $appEmulation;

        parent::__construct(

            $paymentData,

            $string,

            $scopeConfig,

            $filesystem,

            $pdfConfig,

            $pdfTotalFactory,

            $pdfItemsFactory,

            $localeDate,

            $inlineTranslation,

            $addressRenderer,

            $storeManager,

            $appEmulation,

            $data

        );

        $this->_localeResolver = $localeResolver;

    }

    

    protected function _drawHeader(\Zend_Pdf_Page $page)

    {

        /* Add table head */

        $this->_setFontRegular($page, 10);

        $page->setFillColor(new \Zend_Pdf_Color_Rgb(0.93, 0.92, 0.92));

        $page->setLineColor(new \Zend_Pdf_Color_GrayScale(0.5));

        $page->setLineWidth(0.5);

        $page->drawRectangle(25, $this->y, 570, $this->y - 15);

        $this->y -= 10;

        $page->setFillColor(new \Zend_Pdf_Color_Rgb(0, 0, 0));

 

        //columns headers

        $lines[0][] = ['text' => __('Products'), 'feed' => 35];

 

        $lines[0][] = ['text' => __('SKU'), 'feed' => 290, 'align' => 'right'];

 

        $lines[0][] = ['text' => __('Qty'), 'feed' => 435, 'align' => 'right'];

 

        $lines[0][] = ['text' => __('Price'), 'feed' => 375, 'align' => 'right'];

 

        $lines[0][] = ['text' => __('Tax'), 'feed' => 495, 'align' => 'right'];

 

        $lines[0][] = ['text' => __('Subtotal'), 'feed' => 565, 'align' => 'right'];

 

        $lineBlock = ['lines' => $lines, 'height' => 5];

 

        $this->drawLineBlocks($page, [$lineBlock], ['table_header' => true]);

        $page->setFillColor(new \Zend_Pdf_Color_GrayScale(0));

        $this->y -= 20;

    }

 

    public function getPdf($invoices = [])

    {

        $this->_beforeGetPdf();

        $this->_initRenderer('invoice');

 

        $pdf = new \Zend_Pdf();

        $this->_setPdf($pdf);

        $style = new \Zend_Pdf_Style();

        $this->_setFontBold($style, 10);

 

        foreach ($invoices as $invoice)

        {

            if ($invoice->getStoreId())

            {

                $this->_localeResolver->emulate($invoice->getStoreId());

                $this->_storeManager->setCurrentStore($invoice->getStoreId());

            }

            $page = $this->newPage();

            $order = $invoice->getOrder();

            /* Add image */

            $this->insertLogo($page, $invoice->getStore());

            /* Add address */

            $this->insertAddress($page, $invoice->getStore());

            /* Add head */

            $this->insertOrder(

                $page,

                $order,

                $this->_scopeConfig->isSetFlag(

                    self::XML_PATH_SALES_PDF_INVOICE_PUT_ORDER_ID,

                    \Magento\Store\Model\ScopeInterface::SCOPE_STORE,

                    $order->getStoreId()

                )

            );

            /* Add document text and number */

            $this->insertDocumentNumber($page, __('Invoice # ') . $invoice->getIncrementId());

            /* Add table */

            $this->_drawHeader($page);

            /* Add body */

            foreach ($invoice->getAllItems() as $item)

            {

                if ($item->getOrderItem()->getParentItem())

                {

                    continue;

                }

                /* Draw item */

                $this->_drawItem($item, $page, $order);

                $page = end($pdf->pages);

            }

            /* Add totals */

            $this->insertTotals($page, $invoice);

            if ($invoice->getStoreId())

            {

                $this->_localeResolver->revert();

            }

        }

        $this->_afterGetPdf();

        return $pdf;

    }

   

    public function newPage(array $settings = [])

    {

        /* Add new table head */

        $page = $this->_getPdf()->newPage(\Zend_Pdf_Page::SIZE_A4);

        $this->_getPdf()->pages[] = $page;

        $this->y = 800;

        if (!empty($settings['table_header']))

        {

            $this->_drawHeader($page);

        }

        return $page;

    }

 

    protected function insertAddress(&$page, $store = null)

    {

        $page->setFillColor(new \Zend_Pdf_Color_GrayScale(0));

        $font = $this->_setFontRegular($page, 10);

        $page->setLineWidth(0);

        $this->y = $this->y ?: 815;

        $top = 815;

        $configAddress = $this->_scopeConfig->getValue(

            'sales/identity/address',

            ScopeInterface::SCOPE_STORE,

            $store

        );

        $values = $configAddress ? explode("\n", $configAddress) : [];

        foreach ($values as $value)

        {

            if ($value !== '')

            {

                $value = preg_replace('/<br[^>]*>/i', "\n", $value);

                foreach ($this->string->split($value, 45, true, true) as $_value)

                {

                    $page->drawText(

                        trim(strip_tags($_value)),

                        $this->getAlignRight($_value, 130, 440, $font, 10),

                        $top,

                        'UTF-8'

                    );

                    $top -= 10;

                }

            }

        }

        $this->y = $this->y > $top ? $top : $this->y;

    }

    

    protected function insertOrder(&$page, $obj, $putOrderId = true)

    {

        if ($obj instanceof \Magento\Sales\Model\Order)

        {

            $shipment = null;

            $order = $obj;

        }

        elseif ($obj instanceof \Magento\Sales\Model\Order\Shipment)

        {

            $shipment = $obj;

            $order = $shipment->getOrder();

        }

 

        $this->y = $this->y ? $this->y : 815;

        $top = $this->y;

 

        $page->setFillColor(new \Zend_Pdf_Color_GrayScale(0.45));

        $page->setLineColor(new \Zend_Pdf_Color_GrayScale(0.45));

        $page->drawRectangle(25, $top, 570, $top - 55);

        $page->setFillColor(new \Zend_Pdf_Color_GrayScale(1));

        $this->setDocHeaderCoordinates([25, $top, 570, $top - 55]);

        $this->_setFontRegular($page, 10);

 

        if ($putOrderId)

        {

            $page->drawText(__('Order # ') . $order->getRealOrderId(), 35, $top -= 30, 'UTF-8');

            $top +=15;

        }

 

        $top -=30;

        $page->drawText(

            __('Order Date: ') .

            $this->_localeDate->formatDate(

                $this->_localeDate->scopeDate(

                    $order->getStore(),

                    $order->getCreatedAt(),

                    true

                ),

                \IntlDateFormatter::MEDIUM,

                false

            ),

            35,

            $top,

            'UTF-8'

        );

 

        $top -= 10;

        $page->setFillColor(new \Zend_Pdf_Color_Rgb(0.93, 0.92, 0.92));

        $page->setLineColor(new \Zend_Pdf_Color_GrayScale(0.5));

        $page->setLineWidth(0.5);

        $page->drawRectangle(25, $top, 275, $top - 25);

        $page->drawRectangle(275, $top, 570, $top - 25);

 

        /* Calculate blocks info */

 

        /* Billing Address */

        $billingAddress = $this->_formatAddress($this->addressRenderer->format($order->getBillingAddress(), 'pdf'));

        

        /*Custom billing text add here...*/

        $billingAddress[] = "Custom Billing Text" ;

 

        /* Payment */

        $paymentInfo = $this->_paymentData->getInfoBlock($order->getPayment())->setIsSecureMode(true)->toPdf();

        $paymentInfo = htmlspecialchars_decode($paymentInfo, ENT_QUOTES);

        $payment = explode('{{pdf_row_separator}}', $paymentInfo);

        foreach ($payment as $key => $value)

        {

            if (strip_tags(trim($value)) == '')

            {

                unset($payment[$key]);

            }

        }

        reset($payment);

 

        /* Shipping Address and Method */

        if (!$order->getIsVirtual())

        {

            /* Shipping Address */

            $shippingAddress = $this->_formatAddress($this->addressRenderer->format($order->getShippingAddress(), 'pdf'));

           

            /*Custom shipping text add here...*/

            $shippingAddress[] = "Custom Shipping Text" ;

            $shippingMethod = $order->getShippingDescription();

        }

 

        $page->setFillColor(new \Zend_Pdf_Color_GrayScale(0));

        $this->_setFontBold($page, 12);

        $page->drawText(__('Sold to:'), 35, $top - 15, 'UTF-8');

 

        if (!$order->getIsVirtual())

        {

            $page->drawText(__('Ship to:'), 285, $top - 15, 'UTF-8');

        }

        else

        {

            $page->drawText(__('Payment Method:'), 285, $top - 15, 'UTF-8');

        }

 

        $addressesHeight = $this->_calcAddressHeight($billingAddress);

        if (isset($shippingAddress))

        {

            $addressesHeight = max($addressesHeight, $this->_calcAddressHeight($shippingAddress));

        }

 

        $page->setFillColor(new \Zend_Pdf_Color_GrayScale(1));

        $page->drawRectangle(25, $top - 25, 570, $top - 33 - $addressesHeight);

        $page->setFillColor(new \Zend_Pdf_Color_GrayScale(0));

        $this->_setFontRegular($page, 10);

        $this->y = $top - 40;

        $addressesStartY = $this->y;

 

        foreach ($billingAddress as $value)

        {

            if ($value !== '')

            {

                $text = [];

                foreach ($this->string->split($value, 45, true, true) as $_value)

                {

                    $text[] = $_value;

                }

                foreach ($text as $part)

                {

                    $page->drawText(strip_tags(ltrim($part)), 35, $this->y, 'UTF-8');

                    $this->y -= 15;

                }

            }

        }

 

        $addressesEndY = $this->y;

 

        if (!$order->getIsVirtual())

        {

            $this->y = $addressesStartY;

            foreach ($shippingAddress as $value)

            {

                if ($value !== '')

                {

                    $text = [];

                    foreach ($this->string->split($value, 45, true, true) as $_value)

                    {

                        $text[] = $_value;

                    }

                    foreach ($text as $part)

                    {

                        $page->drawText(strip_tags(ltrim($part)), 285, $this->y, 'UTF-8');

                        $this->y -= 15;

                    }

                }

            }

 

            $addressesEndY = min($addressesEndY, $this->y);

            $this->y = $addressesEndY;

 

            $page->setFillColor(new \Zend_Pdf_Color_Rgb(0.93, 0.92, 0.92));

            $page->setLineWidth(0.5);

            $page->drawRectangle(25, $this->y, 275, $this->y - 25);

            $page->drawRectangle(275, $this->y, 570, $this->y - 25);

 

            $this->y -= 15;

            $this->_setFontBold($page, 12);

            $page->setFillColor(new \Zend_Pdf_Color_GrayScale(0));

            $page->drawText(__('Payment Method'), 35, $this->y, 'UTF-8');

            $page->drawText(__('Shipping Method:'), 285, $this->y, 'UTF-8');

 

            $this->y -= 10;

            $page->setFillColor(new \Zend_Pdf_Color_GrayScale(1));

 

            $this->_setFontRegular($page, 10);

            $page->setFillColor(new \Zend_Pdf_Color_GrayScale(0));

 

            $paymentLeft = 35;

            $yPayments = $this->y - 15;

        }

        else

        {

            $yPayments = $addressesStartY;

            $paymentLeft = 285;

        }

 

        foreach ($payment as $value)

        {

            if (trim($value) != '')

            {

                //Printing "Payment Method" lines

                $value = preg_replace('/<br[^>]*>/i', "\n", $value);

                foreach ($this->string->split($value, 45, true, true) as $_value)

                {

                    $page->drawText(strip_tags(trim($_value)), $paymentLeft, $yPayments, 'UTF-8');

                    $yPayments -= 15;

                }

            }

        }

 

        if ($order->getIsVirtual())

        {

            // replacement of Shipments-Payments rectangle block

            $yPayments = min($addressesEndY, $yPayments);

            $page->drawLine(25, $top - 25, 25, $yPayments);

            $page->drawLine(570, $top - 25, 570, $yPayments);

            $page->drawLine(25, $yPayments, 570, $yPayments);

 

            $this->y = $yPayments - 15;

        }

        else

        {

            $topMargin = 15;

            $methodStartY = $this->y;

            $this->y -= 15;

 

            foreach ($this->string->split($shippingMethod, 45, true, true) as $_value)

            {

                $page->drawText(strip_tags(trim($_value)), 285, $this->y, 'UTF-8');

                $this->y -= 15;

            }

 

            $yShipments = $this->y;

            $totalShippingChargesText = "(" . __(

                    'Total Shipping Charges'

                ) . " " . $order->formatPriceTxt(

                    $order->getShippingAmount()

                ) . ")";

 

            $page->drawText($totalShippingChargesText, 285, $yShipments - $topMargin, 'UTF-8');

            $yShipments -= $topMargin + 10;

 

            $tracks = [];

            if ($shipment)

            {

                $tracks = $shipment->getAllTracks();

            }

            if (count($tracks))

            {

                $page->setFillColor(new \Zend_Pdf_Color_Rgb(0.93, 0.92, 0.92));

                $page->setLineWidth(0.5);

                $page->drawRectangle(285, $yShipments, 510, $yShipments - 10);

                $page->drawLine(400, $yShipments, 400, $yShipments - 10);

                //$page->drawLine(510, $yShipments, 510, $yShipments - 10);

 

                $this->_setFontRegular($page, 9);

                $page->setFillColor(new \Zend_Pdf_Color_GrayScale(0));

                //$page->drawText(__('Carrier'), 290, $yShipments - 7 , 'UTF-8');

                $page->drawText(__('Title'), 290, $yShipments - 7, 'UTF-8');

                $page->drawText(__('Number'), 410, $yShipments - 7, 'UTF-8');

 

                $yShipments -= 20;

                $this->_setFontRegular($page, 8);

                foreach ($tracks as $track)

                {

                    $maxTitleLen = 45;

                    $endOfTitle = strlen($track->getTitle()) > $maxTitleLen ? '...' : '';

                    $truncatedTitle = substr($track->getTitle(), 0, $maxTitleLen) . $endOfTitle;

                    $page->drawText($truncatedTitle, 292, $yShipments, 'UTF-8');

                    $page->drawText($track->getNumber(), 410, $yShipments, 'UTF-8');

                    $yShipments -= $topMargin - 5;

                }

            }

            else

            {

                $yShipments -= $topMargin - 5;

            }

 

            $currentY = min($yPayments, $yShipments);

 

            // replacement of Shipments-Payments rectangle block

            $page->drawLine(25, $methodStartY, 25, $currentY);

            //left

            $page->drawLine(25, $currentY, 570, $currentY);

            //bottom

            $page->drawLine(570, $currentY, 570, $methodStartY);

            //right

 

            $this->y = $currentY;

            $this->y -= 15;

        }

    }

}

Comments

Post a Comment

Popular posts from this blog

Add Admin User name and Action name in Order Comment Section through Action Performed from Sales Order Grid in Magento 2

  Step 1:  First, we need to create an “events.xml“ file inside our extension at the following path app\code\Vendor\Extension\etc\adminhtml\ Then add the code as follows. <?xml version="1.0"?> <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Event/etc/events.xsd">     <event name="sales_order_save_after">         <observer name="sales_order_save_after_comment_history_add"           instance="\Vendor\Extension\Observer\OrderSaveAfter" />     </event> </config> Step 2:  After that, we need to create an “OrderSaveAfter.php” file inside our extension at the following path app\code\Vendor\Extension\Observer\ And embed the code as given below. <?php  namespace Vendor\Extension\Observer;   use Magento\Framework\Event\ObserverInterface; use Magento\Framework\App\RequestInterface; use Magento\Backen...
Read more

How to Update Product Stock Programmatically in Magento 2

 Steps to Update Product Stock Programmatically in Magento 2: Step 1: We need to create a “Data.php” file inside our extension at the following path app\code\Vendor\Extension\Helper\ Now add the code as follows <?php namespace Vendor\Extension\Helper;   class Data extends \Magento\Framework\App\Helper\AbstractHelper {     protected $_productobj;     protected $_stockRegistry;       public function __construct(         \Magento\Framework\App\Helper\Context $context,         \Magento\Catalog\Model\Product $productobj,         \Magento\CatalogInventory\Api\StockRegistryInterface $stockRegistry,      ) {         $this->_productobj = $productobj;         $this->_stockRegistry = $stockRegistry;         parent::__construct($context);     }       public function updateProductStock($pr...
Read more

How to Set and Get Cookie in Magento 2

 <?php namespace Vendor\Extension\Model; class Customcookie {     private $customCookieManager;     private $customCookieMetadataFactory;     public function __construct(         \Magento\Framework\Stdlib\CookieManagerInterface $customCookieManager,         \Magento\Framework\Stdlib\Cookie\CookieMetadataFactory $customCookieMetadataFactory)    {         $this->customCookieManager = $customCookieManager;         $this->customCookieMetadataFactory = $customCookieMetadataFactory;     }     public function setCookie()     {         $customCookieMetadata = $this->customCookieMetadataFactory->createPublicCookieMetadata();         $customCookieMetadata->setDurationOneYear();         $customCookieMetadata->setPath('/');         $customCookieMe...
Read more