Inheritance diagram for Shipment:

Public Member Functions
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Tax\Helper\Data $taxData, \Magento\Framework\Filesystem $filesystem, \Magento\Framework\Filter\FilterManager $filterManager, \Magento\Framework\Stdlib\StringUtils $string, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[], Json $serializer=null)

	draw ()

Public Member Functions inherited from AbstractItems
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Tax\Helper\Data $taxData, \Magento\Framework\Filesystem $filesystem, \Magento\Framework\Filter\FilterManager $filterManager, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[], Json $serializer=null)

	getChildren ($item)

	isShipmentSeparately ($item=null)

	isChildCalculated ($item=null)

	getBundleOptions ($item=null)

	getSelectionAttributes ($item)

	getOrderOptions ($item=null)

	getOrderItem ()

	getValueHtml ($item)

	canShowPriceInfo ($item)

Public Member Functions inherited from AbstractItems
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Tax\Helper\Data $taxData, \Magento\Framework\Filesystem $filesystem, \Magento\Framework\Filter\FilterManager $filterManager, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[])

	setOrder (\Magento\Sales\Model\Order $order)

	setSource (\Magento\Framework\Model\AbstractModel $source)

	setItem (\Magento\Framework\DataObject $item)

	setPdf (\Magento\Sales\Model\Order\Pdf\AbstractPdf $pdf)

	setPage (\Zend_Pdf_Page $page)

	getOrder ()

	getSource ()

	getItem ()

	getPdf ()

	getPage ()

	draw ()

	getItemPricesForDisplay ()

	getItemOptions ()

	getSku ($item)

Public Member Functions inherited from AbstractModel
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[])

	__sleep ()

	__wakeup ()

	setIdFieldName ($name)

	getIdFieldName ()

	getId ()

	setId ($value)

	isDeleted ($isDeleted=null)

	hasDataChanges ()

	setData ($key, $value=null)

	unsetData ($key=null)

	setDataChanges ($value)

	getOrigData ($key=null)

	setOrigData ($key=null, $data=null)

	dataHasChangedFor ($field)

	getResourceName ()

	getResourceCollection ()

	getCollection ()

	load ($modelId, $field=null)

	beforeLoad ($identifier, $field=null)

	afterLoad ()

	isSaveAllowed ()

	setHasDataChanges ($flag)

	save ()

	afterCommitCallback ()

	isObjectNew ($flag=null)

	beforeSave ()

	validateBeforeSave ()

	getCacheTags ()

	cleanModelCache ()

	afterSave ()

	delete ()

	beforeDelete ()

	afterDelete ()

	afterDeleteCommit ()

	getResource ()

	getEntityId ()

	setEntityId ($entityId)

	clearInstance ()

	getStoredData ()

	getEventPrefix ()

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 Attributes
	$string

Protected Attributes inherited from AbstractItems
	$_order

	$_source

	$_item

	$_pdf

	$_pdfPage

	$_taxData

	$_rootDirectory

	$filterManager

Protected Attributes inherited from AbstractModel
	$_eventPrefix = 'core_abstract'

	$_eventObject = 'object'

	$_idFieldName = 'id'

	$_hasDataChanges = false

	$_origData

	$_isDeleted = false

	$_resource

	$_resourceCollection

	$_resourceName

	$_collectionName

	$_cacheTag = false

	$_dataSaveAllowed = true

	$_isObjectNew = null

	$_validatorBeforeSave = null

	$_eventManager

	$_cacheManager

	$_registry

	$_logger

	$_appState

	$_actionValidator

	$storedData = []

Protected Attributes inherited from DataObject
	$_data = []

Additional Inherited Members
Protected Member Functions inherited from AbstractItems
	_formatOptionValue ($value)

	_setFontRegular ($size=7)

	_setFontBold ($size=7)

	_setFontItalic ($size=7)

Protected Member Functions inherited from AbstractModel
	_construct ()

	_init ($resourceModel)

	_setResourceModel ($resourceName, $collectionName=null)

	_getResource ()

	_getEventData ()

	_beforeLoad ($modelId, $field=null)

	_afterLoad ()

	_hasModelChanged ()

	_getValidatorBeforeSave ()

	_createValidatorBeforeSave ()

	_getValidationRulesBeforeSave ()

	_clearReferences ()

	_clearData ()

Protected Member Functions inherited from DataObject
	_getData ($key)

	_underscore ($name)

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

Detailed Description

Order shipment pdf items renderer

Definition at line 14 of file Shipment.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Framework\Model\Context	$context,
		\Magento\Framework\Registry	$registry,
		\Magento\Tax\Helper\Data	$taxData,
		\Magento\Framework\Filesystem	$filesystem,
		\Magento\Framework\Filter\FilterManager	$filterManager,
		\Magento\Framework\Stdlib\StringUtils	$string,
		\Magento\Framework\Model\ResourceModel\AbstractResource	$resource = `null`,
		\Magento\Framework\Data\Collection\AbstractDb	$resourceCollection = `null`,
		array	$data = `[]`,
		Json	$serializer = `null`
	)

Constructor

Parameters

\Magento\Framework\Model\Context	$context
\Magento\Framework\Registry	$registry
\Magento\Tax\Helper\Data	$taxData
\Magento\Framework\Filesystem	$filesystem
\Magento\Framework\Filter\FilterManager	$filterManager
\Magento\Framework\Stdlib\StringUtils	$string
\Magento\Framework\Model\ResourceModel\AbstractResource	$resource
\Magento\Framework\Data\Collection\AbstractDb	$resourceCollection
array	$data
\Magento\Framework\Serialize\Serializer\Json \| null	$serializer	@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 36 of file Shipment.php.

       {
         $this->string = $string;
         parent::__construct(
             $context,
             $registry,
             $taxData,
             $filesystem,
             $filterManager,
             $resource,
             $resourceCollection,
             $data,
             $serializer
         );
     }

Member Function Documentation

◆ draw()

draw ( )

Draw item line

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

Definition at line 70 of file Shipment.php.

     {
         $item = $this->getItem();
         $pdf = $this->getPdf();
         $page = $this->getPage();
 
         $this->_setFontRegular();
 
         $shipItems = $this->getChildren($item);
         $items = array_merge([$item->getOrderItem()], $item->getOrderItem()->getChildrenItems());
 
         $prevOptionId = '';
         $drawItems = [];
 
         foreach ($items as $childItem) {
             $line = [];
 
             $attributes = $this->getSelectionAttributes($childItem);
             if (is_array($attributes)) {
                 $optionId = $attributes['option_id'];
             } else {
                 $optionId = 0;
             }
 
             if (!isset($drawItems[$optionId])) {
                 $drawItems[$optionId] = ['lines' => [], 'height' => 15];
             }
 
             if ($childItem->getParentItem()) {
                 if ($prevOptionId != $attributes['option_id']) {
                     $line[0] = [
                         'font' => 'italic',
                         'text' => $this->string->split($attributes['option_label'], 60, true, true),
                         'feed' => 60,
                     ];
 
                     $drawItems[$optionId] = ['lines' => [$line], 'height' => 15];
 
                     $line = [];
 
                     $prevOptionId = $attributes['option_id'];
                 }
             }
 
             if ($this->isShipmentSeparately() && $childItem->getParentItem() ||
                 !$this->isShipmentSeparately() && !$childItem->getParentItem()
             ) {
                 if (isset($shipItems[$childItem->getId()])) {
                     $qty = $shipItems[$childItem->getId()]->getQty() * 1;
                 } elseif ($childItem->getIsVirtual()) {
                     $qty = __('N/A');
                 } else {
                     $qty = 0;
                 }
             } else {
                 $qty = '';
             }
 
             $line[] = ['text' => $qty, 'feed' => 35];
 
             // draw Name
             if ($childItem->getParentItem()) {
                 $feed = 65;
                 $name = $this->getValueHtml($childItem);
             } else {
                 $feed = 60;
                 $name = $childItem->getName();
             }
             $text = [];
             foreach ($this->string->split($name, 60, true, true) as $part) {
                 $text[] = $part;
             }
             $line[] = ['text' => $text, 'feed' => $feed];
 
             // draw SKUs
             $text = [];
             foreach ($this->string->split($childItem->getSku(), 25) as $part) {
                 $text[] = $part;
             }
             $line[] = ['text' => $text, 'feed' => 440];
 
             $drawItems[$optionId]['lines'][] = $line;
         }
 
         // custom options
         $options = $item->getOrderItem()->getProductOptions();
         if ($options) {
             if (isset($options['options'])) {
                 foreach ($options['options'] as $option) {
                     $lines = [];
                     $lines[][] = [
                         'text' => $this->string->split(
                             $this->filterManager->stripTags($option['label']),
                             70,
                             true,
                             true
                         ),
                         'font' => 'italic',
                         'feed' => 60,
                     ];
 
                     if ($option['value']) {
                         $text = [];
                         $printValue = isset(
                             $option['print_value']
                         ) ? $option['print_value'] : $this->filterManager->stripTags(
                             $option['value']
                         );
                         $values = explode(', ', $printValue);
                         foreach ($values as $value) {
                             foreach ($this->string->split($value, 50, true, true) as $subValue) {
                                 $text[] = $subValue;
                             }
                         }
 
                         $lines[][] = ['text' => $text, 'feed' => 65];
                     }
 
                     $drawItems[] = ['lines' => $lines, 'height' => 15];
                 }
             }
         }
 
         $page = $pdf->drawLineBlocks($page, $drawItems, ['table_header' => true]);
         $this->setPage($page);
     }

Field Documentation

◆ $string

$string

protected

Definition at line 19 of file Shipment.php.

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

vendor/magento/module-bundle/Model/Sales/Order/Pdf/Items/Shipment.php

Public Member Functions

Protected Attributes