Inheritance diagram for AbstractPdf:

Public Member Functions
	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)

Data Fields
	$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'

Protected Member Functions
	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
	$_renderers = []

	$_pdf

	$_paymentData

	$string

	$_localeDate

	$_scopeConfig

	$_mediaDirectory

	$_rootDirectory

	$_pdfConfig

	$_pdfTotalFactory

	$_pdfItemsFactory

	$inlineTranslation

	$addressRenderer

Protected Attributes inherited from DataObject
	$_data = []

Additional Inherited Members
Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

Sales Order PDF abstract model

@api @SuppressWarnings(PHPMD.ExcessiveClassComplexity) @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Since: 100.0.2

Definition at line 19 of file AbstractPdf.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,
		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
Total\Factory	$pdfTotalFactory
ItemsFactory	$pdfItemsFactory
\Magento\Framework\Stdlib\DateTime\TimezoneInterface	$localeDate
\Magento\Framework\Translate\Inline\StateInterface	$inlineTranslation
\Magento\Sales\Model\Order\Address\Renderer	$addressRenderer
array	$data	@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 133 of file AbstractPdf.php.

       {
         $this->addressRenderer = $addressRenderer;
         $this->_paymentData = $paymentData;
         $this->_localeDate = $localeDate;
         $this->string = $string;
         $this->_scopeConfig = $scopeConfig;
         $this->_mediaDirectory = $filesystem->getDirectoryWrite(DirectoryList::MEDIA);
         $this->_rootDirectory = $filesystem->getDirectoryRead(DirectoryList::ROOT);
         $this->_pdfConfig = $pdfConfig;
         $this->_pdfTotalFactory = $pdfTotalFactory;
         $this->_pdfItemsFactory = $pdfItemsFactory;
         $this->inlineTranslation = $inlineTranslation;
         parent::__construct($data);
     }

Member Function Documentation

◆ _afterGetPdf()

_afterGetPdf ( )

protected

After getPdf processing

Returns: void

Definition at line 746 of file AbstractPdf.php.

     {
         $this->inlineTranslation->resume();
     }

◆ _beforeGetPdf()

_beforeGetPdf ( )

protected

Before getPdf processing

Returns: void

Definition at line 736 of file AbstractPdf.php.

     {
         $this->inlineTranslation->suspend();
     }

◆ _calcAddressHeight()

_calcAddressHeight ( $address )

protected

Calculate address height

Parameters

array $address

Returns: int Height @SuppressWarnings(PHPMD.UnusedLocalVariable)

Definition at line 350 of file AbstractPdf.php.

     {
         $y = 0;
         foreach ($address as $value) {
             if ($value !== '') {
                 $text = [];
                 foreach ($this->string->split($value, 55, true, true) as $_value) {
                     $text[] = $_value;
                 }
                 foreach ($text as $part) {
                     $y += 15;
                 }
             }
         }
         return $y;
     }

◆ _drawItem()

_drawItem	(	\Magento\Framework\DataObject	$item,
		\Zend_Pdf_Page	$page,
		\Magento\Sales\Model\Order	$order
	)

protected

Draw Item process

Parameters

\Magento\Framework\DataObject	$item
\Zend_Pdf_Page	$page
\Magento\Sales\Model\Order	$order

Returns: \Zend_Pdf_Page

Definition at line 836 of file AbstractPdf.php.

       {
         $type = $item->getOrderItem()->getProductType();
         $renderer = $this->_getRenderer($type);
         $renderer->setOrder($order);
         $renderer->setItem($item);
         $renderer->setPdf($this);
         $renderer->setPage($page);
         $renderer->setRenderedModel($this);
 
         $renderer->draw();
 
         return $renderer->getPage();
     }

◆ _formatAddress()

_formatAddress ( $address )

protected

Format address

Parameters

string $address

Returns: array

Definition at line 329 of file AbstractPdf.php.

     {
         $return = [];
         foreach (explode('|', $address) as $str) {
             foreach ($this->string->split($str, 45, true, true) as $part) {
                 if (empty($part)) {
                     continue;
                 }
                 $return[] = $part;
             }
         }
         return $return;
     }

◆ _formatOptionValue()

_formatOptionValue	(	$value,
		$order
	)

protected

Format option value process

Parameters

array \| string	$value
\Magento\Sales\Model\Order	$order

Returns: string

Definition at line 758 of file AbstractPdf.php.

     {
         $resultValue = '';
         if (is_array($value)) {
             if (isset($value['qty'])) {
                 $resultValue .= sprintf('%d', $value['qty']) . ' x ';
             }
 
             $resultValue .= $value['title'];
 
             if (isset($value['price'])) {
                 $resultValue .= " " . $order->formatPrice($value['price']);
             }
             return $resultValue;
         } else {
             return $value;
         }
     }

◆ _getPdf()

_getPdf ( )

protected

Retrieve PDF object

Exceptions

Definition at line 920 of file AbstractPdf.php.

     {
         if (!$this->_pdf instanceof \Zend_Pdf) {
             throw new \Magento\Framework\Exception\LocalizedException(__('Please define the PDF object before using.'));
         }
 
         return $this->_pdf;
     }

◆ _getRenderer()

_getRenderer ( $type )

protected

Retrieve renderer model

Parameters

string $type

Returns: \Magento\Sales\Model\Order\Pdf\Items\AbstractItems

Exceptions

Definition at line 798 of file AbstractPdf.php.

     {
         if (!isset($this->_renderers[$type])) {
             $type = 'default';
         }
 
         if (!isset($this->_renderers[$type])) {
             throw new \Magento\Framework\Exception\LocalizedException(__('We found an invalid renderer model.'));
         }
 
         if ($this->_renderers[$type]['renderer'] === null) {
             $this->_renderers[$type]['renderer'] = $this->_pdfItemsFactory->get($this->_renderers[$type]['model']);
         }
 
         return $this->_renderers[$type]['renderer'];
     }

◆ _getTotalsList()

_getTotalsList ( )

protected

Return total list

Returns: \Magento\Sales\Model\Order\Pdf\Total\DefaultTotal[] Array of totals

Definition at line 656 of file AbstractPdf.php.

     {
         $totals = $this->_pdfConfig->getTotals();
         usort($totals, [$this, '_sortTotalsList']);
         $totalModels = [];
         foreach ($totals as $totalInfo) {
             $class = empty($totalInfo['model']) ? null : $totalInfo['model'];
             $totalModel = $this->_pdfTotalFactory->create($class);
             $totalModel->setData($totalInfo);
             $totalModels[] = $totalModel;
         }
 
         return $totalModels;
     }

◆ _initRenderer()

_initRenderer ( $type )

protected

Initialize renderer process

Parameters

string $type

Returns: void

Definition at line 783 of file AbstractPdf.php.

     {
         $rendererData = $this->_pdfConfig->getRenderersPerProduct($type);
         foreach ($rendererData as $productType => $renderer) {
             $this->_renderers[$productType] = ['model' => $renderer, 'renderer' => null];
         }
     }

◆ _parseItemDescription()

_parseItemDescription ( $item )

protected

Parse item description

Parameters

\Magento\Framework\DataObject $item

Returns: array

Definition at line 720 of file AbstractPdf.php.

     {
         $matches = [];
         $description = $item->getDescription();
         if (preg_match_all('/<li.*?>(.*?)<\/li>/i', $description, $matches)) {
             return $matches[1];
         }
 
         return [$description];
     }

◆ _setFontBold()

_setFontBold	(	$object,
		$size = `7`
	)

protected

Set font as bold

Parameters

\Zend_Pdf_Page	$object
int	$size

Returns: \Zend_Pdf_Resource_Font

Definition at line 877 of file AbstractPdf.php.

     {
         $font = \Zend_Pdf_Font::fontWithPath(
             $this->_rootDirectory->getAbsolutePath('lib/internal/GnuFreeFont/FreeSerifBold.ttf')
         );
         $object->setFont($font, $size);
         return $font;
     }

◆ _setFontItalic()

_setFontItalic	(	$object,
		$size = `7`
	)

protected

Set font as italic

Parameters

\Zend_Pdf_Page	$object
int	$size

Returns: \Zend_Pdf_Resource_Font

Definition at line 893 of file AbstractPdf.php.

     {
         $font = \Zend_Pdf_Font::fontWithPath(
             $this->_rootDirectory->getAbsolutePath('lib/internal/GnuFreeFont/FreeSerifItalic.ttf')
         );
         $object->setFont($font, $size);
         return $font;
     }

◆ _setFontRegular()

_setFontRegular	(	$object,
		$size = `7`
	)

protected

Set font as regular

Parameters

\Zend_Pdf_Page	$object
int	$size

Returns: \Zend_Pdf_Resource_Font

Definition at line 861 of file AbstractPdf.php.

     {
         $font = \Zend_Pdf_Font::fontWithPath(
             $this->_rootDirectory->getAbsolutePath('lib/internal/GnuFreeFont/FreeSerif.ttf')
         );
         $object->setFont($font, $size);
         return $font;
     }

◆ _setPdf()

_setPdf ( \Zend_Pdf $pdf )

protected

Set PDF object

Parameters

\Zend_Pdf $pdf

Returns: $this

Definition at line 908 of file AbstractPdf.php.

     {
         $this->_pdf = $pdf;
         return $this;
     }

◆ _sortTotalsList()

_sortTotalsList	(	$a,
		$b
	)

protected

Sort totals list

Parameters

array	$a
array	$b

Returns: int

Definition at line 638 of file AbstractPdf.php.

     {
         if (!isset($a['sort_order']) || !isset($b['sort_order'])) {
             return 0;
         }
 
         if ($a['sort_order'] == $b['sort_order']) {
             return 0;
         }
 
         return $a['sort_order'] > $b['sort_order'] ? 1 : -1;
     }

◆ drawLineBlocks()

drawLineBlocks	(	\Zend_Pdf_Page	$page,
		array	$draw,
		array	$pageSettings = `[]`
	)

Draw lines

Draw items array format: lines array;array of line blocks (required) shift int; full line height (optional) height int;line spacing (default 10)

line block has line columns array

column array format text string|array; draw text (required) feed int; x position (required) font string; font style, optional: bold, italic, regular font_file string; path to font file (optional for use your custom font) font_size int; font size (default 7) align string; text align (also see feed parameter), optional left, right height int;line spacing (default 10)

Parameters

\Zend_Pdf_Page	$page
array	$draw
array	$pageSettings

Exceptions

Definition at line 973 of file AbstractPdf.php.

     {
         foreach ($draw as $itemsProp) {
             if (!isset($itemsProp['lines']) || !is_array($itemsProp['lines'])) {
                 throw new \Magento\Framework\Exception\LocalizedException(
                     __('We don\'t recognize the draw line data. Please define the "lines" array.')
                 );
             }
             $lines = $itemsProp['lines'];
             $height = isset($itemsProp['height']) ? $itemsProp['height'] : 10;
 
             if (empty($itemsProp['shift'])) {
                 $shift = 0;
                 foreach ($lines as $line) {
                     $maxHeight = 0;
                     foreach ($line as $column) {
                         $lineSpacing = !empty($column['height']) ? $column['height'] : $height;
                         if (!is_array($column['text'])) {
                             $column['text'] = [$column['text']];
                         }
                         $top = 0;
                         foreach ($column['text'] as $part) {
                             $top += $lineSpacing;
                         }
 
                         $maxHeight = $top > $maxHeight ? $top : $maxHeight;
                     }
                     $shift += $maxHeight;
                 }
                 $itemsProp['shift'] = $shift;
             }
 
             if ($this->y - $itemsProp['shift'] < 15) {
                 $page = $this->newPage($pageSettings);
             }
 
             foreach ($lines as $line) {
                 $maxHeight = 0;
                 foreach ($line as $column) {
                     $fontSize = empty($column['font_size']) ? 10 : $column['font_size'];
                     if (!empty($column['font_file'])) {
                         $font = \Zend_Pdf_Font::fontWithPath($column['font_file']);
                         $page->setFont($font, $fontSize);
                     } else {
                         $fontStyle = empty($column['font']) ? 'regular' : $column['font'];
                         switch ($fontStyle) {
                             case 'bold':
                                 $font = $this->_setFontBold($page, $fontSize);
                                 break;
                             case 'italic':
                                 $font = $this->_setFontItalic($page, $fontSize);
                                 break;
                             default:
                                 $font = $this->_setFontRegular($page, $fontSize);
                                 break;
                         }
                     }
 
                     if (!is_array($column['text'])) {
                         $column['text'] = [$column['text']];
                     }
 
                     $lineSpacing = !empty($column['height']) ? $column['height'] : $height;
                     $top = 0;
                     foreach ($column['text'] as $part) {
                         if ($this->y - $lineSpacing < 15) {
                             $page = $this->newPage($pageSettings);
                         }
 
                         $feed = $column['feed'];
                         $textAlign = empty($column['align']) ? 'left' : $column['align'];
                         $width = empty($column['width']) ? 0 : $column['width'];
                         switch ($textAlign) {
                             case 'right':
                                 if ($width) {
                                     $feed = $this->getAlignRight($part, $feed, $width, $font, $fontSize);
                                 } else {
                                     $feed = $feed - $this->widthForStringUsingFontSize($part, $font, $fontSize);
                                 }
                                 break;
                             case 'center':
                                 if ($width) {
                                     $feed = $this->getAlignCenter($part, $feed, $width, $font, $fontSize);
                                 }
                                 break;
                             default:
                                 break;
                         }
                         $page->drawText($part, $feed, $this->y - $top, 'UTF-8');
                         $top += $lineSpacing;
                     }
 
                     $maxHeight = $top > $maxHeight ? $top : $maxHeight;
                 }
                 $this->y -= $maxHeight;
             }
         }
 
         return $page;
     }

◆ getAlignCenter()

getAlignCenter	(		$string,
			$x,
			$columnWidth,
		\Zend_Pdf_Resource_Font	$font,
			$fontSize
	)

Calculate coordinates to draw something in a column aligned to the center

Parameters

string	$string
int	$x
int	$columnWidth
\Zend_Pdf_Resource_Font	$font
int	$fontSize

Returns: int

Definition at line 223 of file AbstractPdf.php.

     {
         $width = $this->widthForStringUsingFontSize($string, $font, $fontSize);
         return $x + round(($columnWidth - $width) / 2);
     }

◆ getAlignRight()

getAlignRight	(		$string,
			$x,
			$columnWidth,
		\Zend_Pdf_Resource_Font	$font,
			$fontSize,
			$padding = `5`
	)

Calculate coordinates to draw something in a column aligned to the right

Parameters

string	$string
int	$x
int	$columnWidth
\Zend_Pdf_Resource_Font	$font
int	$fontSize
int	$padding

Returns: int

Definition at line 207 of file AbstractPdf.php.

     {
         $width = $this->widthForStringUsingFontSize($string, $font, $fontSize);
         return $x + $columnWidth - $width - $padding;
     }

◆ getPdf()

getPdf ( )

abstract

Retrieve PDF

Returns: \Zend_Pdf

◆ getRenderer()

getRenderer ( $type )

Public method of protected

See also: _getRenderer()

Retrieve renderer model

Parameters

string $type

Returns: \Magento\Sales\Model\Order\Pdf\Items\AbstractItems

Definition at line 823 of file AbstractPdf.php.

     {
         return $this->_getRenderer($type);
     }

◆ insertAddress()

insertAddress	(	&	$page,
			$store = `null`
	)

protected

Insert address to pdf page

Parameters

\Zend_Pdf_Page	&$page
null	$store

Returns: void

Definition at line 291 of file AbstractPdf.php.

     {
         $page->setFillColor(new \Zend_Pdf_Color_GrayScale(0));
         $font = $this->_setFontRegular($page, 10);
         $page->setLineWidth(0);
         $this->y = $this->y ? $this->y : 815;
         $top = 815;
         $values = explode(
             "\n",
             $this->_scopeConfig->getValue(
                 'sales/identity/address',
                 \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
                 $store
             )
         );
         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;
     }

◆ insertDocumentNumber()

insertDocumentNumber	(	\Zend_Pdf_Page	$page,
			$text
	)

Insert title and number for concrete document type

Parameters

\Zend_Pdf_Page	$page
string	$text

Returns: void

Definition at line 623 of file AbstractPdf.php.

     {
         $page->setFillColor(new \Zend_Pdf_Color_GrayScale(1));
         $this->_setFontRegular($page, 10);
         $docHeader = $this->getDocHeaderCoordinates();
         $page->drawText($text, 35, $docHeader[1] - 15, 'UTF-8');
     }

◆ insertLogo()

insertLogo	(	&	$page,
			$store = `null`
	)

protected

Insert logo to pdf page

Parameters

\Zend_Pdf_Page	&$page
null	$store

Returns: void @SuppressWarnings(PHPMD.CyclomaticComplexity)

Definition at line 237 of file AbstractPdf.php.

     {
         $this->y = $this->y ? $this->y : 815;
         $image = $this->_scopeConfig->getValue(
             'sales/identity/logo',
             \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
             $store
         );
         if ($image) {
             $imagePath = '/sales/store/logo/' . $image;
             if ($this->_mediaDirectory->isFile($imagePath)) {
                 $image = \Zend_Pdf_Image::imageWithPath($this->_mediaDirectory->getAbsolutePath($imagePath));
                 $top = 830;
                 //top border of the page
                 $widthLimit = 270;
                 //half of the page width
                 $heightLimit = 270;
                 //assuming the image is not a "skyscraper"
                 $width = $image->getPixelWidth();
                 $height = $image->getPixelHeight();
 
                 //preserving aspect ratio (proportions)
                 $ratio = $width / $height;
                 if ($ratio > 1 && $width > $widthLimit) {
                     $width = $widthLimit;
                     $height = $width / $ratio;
                 } elseif ($ratio < 1 && $height > $heightLimit) {
                     $height = $heightLimit;
                     $width = $height * $ratio;
                 } elseif ($ratio == 1 && $height > $heightLimit) {
                     $height = $heightLimit;
                     $width = $widthLimit;
                 }
 
                 $y1 = $top - $height;
                 $y2 = $top;
                 $x1 = 25;
                 $x2 = $x1 + $width;
 
                 //coordinates after transformation are rounded by Zend
                 $page->drawImage($image, $x1, $y1, $x2, $y2);
 
                 $this->y = $y1 - 10;
             }
         }
     }

◆ insertOrder()

insertOrder	(	&	$page,
			$obj,
			$putOrderId = `true`
	)

protected

Insert order to pdf page

Parameters

\Zend_Pdf_Page	&$page
\Magento\Sales\Model\Order	$obj
bool	$putOrderId

Returns: void @SuppressWarnings(PHPMD.CyclomaticComplexity) @SuppressWarnings(PHPMD.NPathComplexity) @SuppressWarnings(PHPMD.ExcessiveMethodLength)

Definition at line 378 of file AbstractPdf.php.

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

◆ insertTotals()

insertTotals	(	$page,
		$source
	)

protected

Insert totals to pdf page

Parameters

\Zend_Pdf_Page	$page
\Magento\Sales\Model\AbstractModel	$source

Returns: \Zend_Pdf_Page

Definition at line 678 of file AbstractPdf.php.

     {
         $order = $source->getOrder();
         $totals = $this->_getTotalsList();
         $lineBlock = ['lines' => [], 'height' => 15];
         foreach ($totals as $total) {
             $total->setOrder($order)->setSource($source);
 
             if ($total->canDisplay()) {
                 $total->setFontSize(10);
                 foreach ($total->getTotalsForDisplay() as $totalData) {
                     $lineBlock['lines'][] = [
                         [
                             'text' => $totalData['label'],
                             'feed' => 475,
                             'align' => 'right',
                             'font_size' => $totalData['font_size'],
                             'font' => 'bold',
                         ],
                         [
                             'text' => $totalData['amount'],
                             'feed' => 565,
                             'align' => 'right',
                             'font_size' => $totalData['font_size'],
                             'font' => 'bold'
                         ],
                     ];
                 }
             }
         }
 
         $this->y -= 20;
         $page = $this->drawLineBlocks($page, [$lineBlock]);
         return $page;
     }

◆ newPage()

newPage ( array $settings = [] )

Create new page and assign to PDF object

Parameters

array $settings

Returns: \Zend_Pdf_Page

Definition at line 935 of file AbstractPdf.php.

     {
         $pageSize = !empty($settings['page_size']) ? $settings['page_size'] : \Zend_Pdf_Page::SIZE_A4;
         $page = $this->_getPdf()->newPage($pageSize);
         $this->_getPdf()->pages[] = $page;
         $this->y = 800;
 
         return $page;
     }

◆ widthForStringUsingFontSize()

widthForStringUsingFontSize	(	$string,
		$font,
		$fontSize
	)

Returns the total width in points of the string using the specified font and size.

This is not the most efficient way to perform this calculation. I'm concentrating optimization efforts on the upcoming layout manager class. Similar calculations exist inside the layout manager class, but widths are generally calculated only after determining line fragments.

Parameters

string	$string
\Zend_Pdf_Resource_Font	$font
float	$fontSize	Font size in points

Returns: float

Definition at line 174 of file AbstractPdf.php.

     {
         $drawingString = '"libiconv"' == ICONV_IMPL ? iconv(
             'UTF-8',
             'UTF-16BE//IGNORE',
             $string
         ) : @iconv(
             'UTF-8',
             'UTF-16BE',
             $string
         );
 
         $characters = [];
         for ($i = 0; $i < strlen($drawingString); $i++) {
             $characters[] = ord($drawingString[$i++]) << 8 | ord($drawingString[$i]);
         }
         $glyphs = $font->glyphNumbersForCharacters($characters);
         $widths = $font->widthsForGlyphs($glyphs);
         $stringWidth = array_sum($widths) / $font->getUnitsPerEm() * $fontSize;
         return $stringWidth;
     }

Field Documentation

◆ $_localeDate

$_localeDate

protected

Definition at line 75 of file AbstractPdf.php.

◆ $_mediaDirectory

$_mediaDirectory

protected

Definition at line 87 of file AbstractPdf.php.

◆ $_paymentData

$_paymentData

protected

Definition at line 65 of file AbstractPdf.php.

◆ $_pdf

$_pdf

protected

Definition at line 51 of file AbstractPdf.php.

◆ $_pdfConfig

$_pdfConfig

protected

Definition at line 97 of file AbstractPdf.php.

◆ $_pdfItemsFactory

$_pdfItemsFactory

protected

Definition at line 107 of file AbstractPdf.php.

◆ $_pdfTotalFactory

$_pdfTotalFactory

protected

Definition at line 102 of file AbstractPdf.php.

◆ $_renderers

$_renderers = []

protected

Definition at line 35 of file AbstractPdf.php.

◆ $_rootDirectory

$_rootDirectory

protected

Definition at line 92 of file AbstractPdf.php.

◆ $_scopeConfig

$_scopeConfig

protected

Definition at line 82 of file AbstractPdf.php.

◆ $addressRenderer

$addressRenderer

protected

Definition at line 117 of file AbstractPdf.php.

◆ $inlineTranslation

$inlineTranslation

protected

Definition at line 112 of file AbstractPdf.php.

◆ $string

$string

protected

Definition at line 70 of file AbstractPdf.php.

◆ $y

$y

Definition at line 26 of file AbstractPdf.php.

◆ XML_PATH_SALES_PDF_CREDITMEMO_PUT_ORDER_ID

const XML_PATH_SALES_PDF_CREDITMEMO_PUT_ORDER_ID = 'sales_pdf/creditmemo/put_order_id'

Definition at line 44 of file AbstractPdf.php.

◆ XML_PATH_SALES_PDF_INVOICE_PUT_ORDER_ID

const XML_PATH_SALES_PDF_INVOICE_PUT_ORDER_ID = 'sales_pdf/invoice/put_order_id'

Predefined constants

Definition at line 40 of file AbstractPdf.php.

◆ XML_PATH_SALES_PDF_SHIPMENT_PUT_ORDER_ID

const XML_PATH_SALES_PDF_SHIPMENT_PUT_ORDER_ID = 'sales_pdf/shipment/put_order_id'

Definition at line 42 of file AbstractPdf.php.

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

vendor/magento/module-sales/Model/Order/Pdf/AbstractPdf.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _afterGetPdf()

◆ _beforeGetPdf()

◆ _calcAddressHeight()

◆ _drawItem()

◆ _formatAddress()

◆ _formatOptionValue()

◆ _getPdf()

◆ _getRenderer()

◆ _getTotalsList()

◆ _initRenderer()

◆ _parseItemDescription()

◆ _setFontBold()

◆ _setFontItalic()

◆ _setFontRegular()

◆ _setPdf()

◆ _sortTotalsList()

◆ drawLineBlocks()

◆ getAlignCenter()

◆ getAlignRight()

◆ getPdf()

◆ getRenderer()

◆ insertAddress()

◆ insertDocumentNumber()

◆ insertLogo()

◆ insertOrder()

◆ insertTotals()

◆ newPage()

◆ widthForStringUsingFontSize()

Field Documentation

◆ $_localeDate

◆ $_mediaDirectory

◆ $_paymentData

◆ $_pdf

◆ $_pdfConfig

◆ $_pdfItemsFactory

◆ $_pdfTotalFactory

◆ $_renderers

◆ $_rootDirectory

◆ $_scopeConfig

◆ $addressRenderer

◆ $inlineTranslation

◆ $string

◆ $y

◆ XML_PATH_SALES_PDF_CREDITMEMO_PUT_ORDER_ID

◆ XML_PATH_SALES_PDF_INVOICE_PUT_ORDER_ID

◆ XML_PATH_SALES_PDF_SHIPMENT_PUT_ORDER_ID