Invoice Class Reference

Inheritance diagram for Invoice:

Public Member Functions
	__construct (\Magento\Payment\Helper\Data $paymentData, \Magento\Framework\Stdlib\StringUtils $string, \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig, \Magento\Framework\Filesystem $filesystem, 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\Framework\Locale\ResolverInterface $localeResolver, array $data=[])
	getPdf ($invoices=[])
	newPage (array $settings=[])
Public Member Functions inherited from AbstractPdf
	getPdf ()
	__construct (\Magento\Payment\Helper\Data $paymentData, \Magento\Framework\Stdlib\StringUtils $string, \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig, \Magento\Framework\Filesystem $filesystem, 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, array $data=[])
	widthForStringUsingFontSize ($string, $font, $fontSize)
	getAlignRight ($string, $x, $columnWidth, \Zend_Pdf_Resource_Font $font, $fontSize, $padding=5)
	getAlignCenter ($string, $x, $columnWidth, \Zend_Pdf_Resource_Font $font, $fontSize)
	insertDocumentNumber (\Zend_Pdf_Page $page, $text)
	getRenderer ($type)
	newPage (array $settings=[])
	drawLineBlocks (\Zend_Pdf_Page $page, array $draw, array $pageSettings=[])
Public Member Functions inherited from DataObject
	__construct (array $data=[])
	addData (array $arr)
	setData ($key, $value=null)
	unsetData ($key=null)
	getData ($key='', $index=null)
	getDataByPath ($path)
	getDataByKey ($key)
	setDataUsingMethod ($key, $args=[])
	getDataUsingMethod ($key, $args=null)
	hasData ($key='')
	toArray (array $keys=[])
	convertToArray (array $keys=[])
	toXml (array $keys=[], $rootName='item', $addOpenTag=false, $addCdata=true)
	convertToXml (array $arrAttributes=[], $rootName='item', $addOpenTag=false, $addCdata=true)
	toJson (array $keys=[])
	convertToJson (array $keys=[])
	toString ($format='')
	__call ($method, $args)
	isEmpty ()
	serialize ($keys=[], $valueSeparator='=', $fieldSeparator=' ', $quote='"')
	debug ($data=null, &$objects=[])
	offsetSet ($offset, $value)
	offsetExists ($offset)
	offsetUnset ($offset)
	offsetGet ($offset)

Protected Member Functions
	_drawHeader (\Zend_Pdf_Page $page)
Protected Member Functions inherited from AbstractPdf
	insertLogo (&$page, $store=null)
	insertAddress (&$page, $store=null)
	_formatAddress ($address)
	_calcAddressHeight ($address)
	insertOrder (&$page, $obj, $putOrderId=true)
	_sortTotalsList ($a, $b)
	_getTotalsList ()
	insertTotals ($page, $source)
	_parseItemDescription ($item)
	_beforeGetPdf ()
	_afterGetPdf ()
	_formatOptionValue ($value, $order)
	_initRenderer ($type)
	_getRenderer ($type)
	_drawItem (\Magento\Framework\DataObject $item, \Zend_Pdf_Page $page, \Magento\Sales\Model\Order $order)
	_setFontRegular ($object, $size=7)
	_setFontBold ($object, $size=7)
	_setFontItalic ($object, $size=7)
	_setPdf (\Zend_Pdf $pdf)
	_getPdf ()
Protected Member Functions inherited from DataObject
	_getData ($key)
	_underscore ($name)

Protected Attributes
	$_storeManager
	$_localeResolver
Protected Attributes inherited from AbstractPdf
	$_renderers = []
	$_pdf
	$_paymentData
	$string
	$_localeDate
	$_scopeConfig
	$_mediaDirectory
	$_rootDirectory
	$_pdfConfig
	$_pdfTotalFactory
	$_pdfItemsFactory
	$inlineTranslation
	$addressRenderer
Protected Attributes inherited from DataObject
	$_data = []

Additional Inherited Members
Data Fields inherited from AbstractPdf
	$y
const	XML_PATH_SALES_PDF_INVOICE_PUT_ORDER_ID = 'sales_pdf/invoice/put_order_id'
const	XML_PATH_SALES_PDF_SHIPMENT_PUT_ORDER_ID = 'sales_pdf/shipment/put_order_id'
const	XML_PATH_SALES_PDF_CREDITMEMO_PUT_ORDER_ID = 'sales_pdf/creditmemo/put_order_id'
Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

Sales Order Invoice PDF model @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 14 of file Invoice.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Payment\Helper\Data	$paymentData,
		\Magento\Framework\Stdlib\StringUtils	$string,
		\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig,
		\Magento\Framework\Filesystem	$filesystem,
		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\Framework\Locale\ResolverInterface	$localeResolver,
		array	$data = []
	)

Parameters

\Magento\Payment\Helper\Data	$paymentData
\Magento\Framework\Stdlib\StringUtils	$string
\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig
\Magento\Framework\Filesystem	$filesystem
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\Framework\Locale\ResolverInterface	$localeResolver
array	$data	@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 43 of file Invoice.php.

      {
        $this->_storeManager = $storeManager;
        $this->_localeResolver = $localeResolver;
        parent::__construct(
            $paymentData,
            $string,
            $scopeConfig,
            $filesystem,
            $pdfConfig,
            $pdfTotalFactory,
            $pdfItemsFactory,
            $localeDate,
            $inlineTranslation,
            $addressRenderer,
            $data
        );
    }

Member Function Documentation

_drawHeader()

_drawHeader ( \Zend_Pdf_Page  $page )

protected

Draw header for item table

Parameters

\Zend_Pdf_Page

$page

Returns

void

Definition at line 81 of file Invoice.php.

    {
        /* 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' => 360, '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;
    }

getPdf()

getPdf

(

$invoices = []

)

Return PDF document

Parameters

array | Collection

$invoices

Returns

\Zend_Pdf

Definition at line 118 of file Invoice.php.

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

newPage()

newPage

(

array

$settings = []

)

Create new page and assign to PDF object

Parameters

array

$settings

Returns

\Zend_Pdf_Page

Definition at line 178 of file Invoice.php.

    {
        /* 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;
    }

Field Documentation

$_localeResolver

$_localeResolver

protected

Definition at line 24 of file Invoice.php.

$_storeManager

$_storeManager

protected

Definition at line 19 of file Invoice.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/module-sales/Model/Order/Pdf/Invoice.php