Inheritance diagram for AbstractItems:

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\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)

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)

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 = []

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

Detailed Description

Order pdf items renderer

@SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 17 of file AbstractItems.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\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\Model\ResourceModel\AbstractResource	$resource
\Magento\Framework\Data\Collection\AbstractDb	$resourceCollection
array	$data
\Magento\Framework\Serialize\Serializer\Json	$serializer

Definition at line 39 of file AbstractItems.php.

       {
         $this->serializer = $serializer ?: ObjectManager::getInstance()->get(Json::class);
         parent::__construct(
             $context,
             $registry,
             $taxData,
             $filesystem,
             $filterManager,
             $resource,
             $resourceCollection,
             $data
         );
     }

Member Function Documentation

◆ canShowPriceInfo()

canShowPriceInfo ( $item )

Can show price info for item

Parameters

\Magento\Sales\Model\Order\Item $item

Returns: bool

Definition at line 282 of file AbstractItems.php.

     {
         if ($item->getOrderItem()->getParentItem() && $this->isChildCalculated() ||
             !$item->getOrderItem()->getParentItem() && !$this->isChildCalculated()
         ) {
             return true;
         }
         return false;
     }

◆ getBundleOptions()

getBundleOptions ( $item = null )

Retrieve Bundle Options

Parameters

\Magento\Framework\DataObject $item

Returns: array @SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 184 of file AbstractItems.php.

     {
         $options = $this->getOrderItem()->getProductOptions();
         if ($options && isset($options['bundle_options'])) {
             return $options['bundle_options'];
         }
         return [];
     }

◆ getChildren()

getChildren ( $item )

Getting all available children for Invoice, Shipment or CreditMemo item

Parameters

\Magento\Framework\DataObject $item

Returns: array

Definition at line 69 of file AbstractItems.php.

     {
         $itemsArray = [];
 
         $items = null;
         if ($item instanceof \Magento\Sales\Model\Order\Invoice\Item) {
             $items = $item->getInvoice()->getAllItems();
         } elseif ($item instanceof \Magento\Sales\Model\Order\Shipment\Item) {
             $items = $item->getShipment()->getAllItems();
         } elseif ($item instanceof \Magento\Sales\Model\Order\Creditmemo\Item) {
             $items = $item->getCreditmemo()->getAllItems();
         }
 
         if ($items) {
             foreach ($items as $value) {
                 $parentItem = $value->getOrderItem()->getParentItem();
                 if ($parentItem) {
                     $itemsArray[$parentItem->getId()][$value->getOrderItemId()] = $value;
                 } else {
                     $itemsArray[$value->getOrderItem()->getId()][$value->getOrderItemId()] = $value;
                 }
             }
         }
 
         if (isset($itemsArray[$item->getOrderItem()->getId()])) {
             return $itemsArray[$item->getOrderItem()->getId()];
         }
         return null;
     }

◆ getOrderItem()

getOrderItem ( )

Retrieve Order Item

Returns: \Magento\Sales\Model\Order\Item

Definition at line 242 of file AbstractItems.php.

     {
         if ($this->getItem() instanceof \Magento\Sales\Model\Order\Item) {
             return $this->getItem();
         }
         return $this->getItem()->getOrderItem();
     }

◆ getOrderOptions()

getOrderOptions ( $item = null )

Retrieve Order options

Parameters

\Magento\Framework\DataObject $item

Returns: array @SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 219 of file AbstractItems.php.

     {
         $result = [];
         $options = $this->getOrderItem()->getProductOptions();
         if ($options) {
             if (isset($options['options'])) {
                 $result = array_merge($result, $options['options']);
             }
             if (isset($options['additional_options'])) {
                 $result = array_merge($result, $options['additional_options']);
             }
             if (!empty($options['attributes_info'])) {
                 $result = array_merge($options['attributes_info'], $result);
             }
         }
         return $result;
     }

◆ getSelectionAttributes()

getSelectionAttributes ( $item )

Retrieve Selection attributes

Parameters

\Magento\Framework\DataObject $item

Returns: mixed

Definition at line 199 of file AbstractItems.php.

     {
         if ($item instanceof \Magento\Sales\Model\Order\Item) {
             $options = $item->getProductOptions();
         } else {
             $options = $item->getOrderItem()->getProductOptions();
         }
         if (isset($options['bundle_selection_attributes'])) {
             return $this->serializer->unserialize($options['bundle_selection_attributes']);
         }
         return null;
     }

◆ getValueHtml()

getValueHtml ( $item )

Retrieve Value HTML

Parameters

\Magento\Sales\Model\Order\Item $item

Returns: string

Definition at line 256 of file AbstractItems.php.

     {
         $result = $this->filterManager->stripTags($item->getName());
         if (!$this->isShipmentSeparately($item)) {
             $attributes = $this->getSelectionAttributes($item);
             if ($attributes) {
                 $result = $this->filterManager->sprintf($attributes['qty'], ['format' => '%d']) . ' x ' . $result;
             }
         }
         if (!$this->isChildCalculated($item)) {
             $attributes = $this->getSelectionAttributes($item);
             if ($attributes) {
                 $result .= " " . $this->filterManager->stripTags(
                     $this->getOrderItem()->getOrder()->formatPrice($attributes['price'])
                 );
             }
         }
         return $result;
     }

◆ isChildCalculated()

isChildCalculated ( $item = null )

Retrieve is Child Calculated

Parameters

\Magento\Framework\DataObject $item

Returns: bool @SuppressWarnings(PHPMD.CyclomaticComplexity)

Definition at line 144 of file AbstractItems.php.

     {
         if ($item) {
             if ($item->getOrderItem()) {
                 $item = $item->getOrderItem();
             }
             $parentItem = $item->getParentItem();
             if ($parentItem) {
                 $options = $parentItem->getProductOptions();
                 if ($options) {
                     return (isset($options['product_calculations'])
                         && $options['product_calculations'] == AbstractType::CALCULATE_CHILD);
                 }
             } else {
                 $options = $item->getProductOptions();
                 if ($options) {
                     return !(isset($options['product_calculations'])
                         && $options['product_calculations'] == AbstractType::CALCULATE_CHILD);
                 }
             }
         }
 
         $options = $this->getOrderItem()->getProductOptions();
         if ($options) {
             if (isset($options['product_calculations'])
                 && $options['product_calculations'] == AbstractType::CALCULATE_CHILD
             ) {
                 return true;
             }
         }
         return false;
     }

◆ isShipmentSeparately()

isShipmentSeparately ( $item = null )

Retrieve is Shipment Separately flag for Item

Parameters

\Magento\Framework\DataObject $item

Returns: bool @SuppressWarnings(PHPMD.CyclomaticComplexity)

Definition at line 106 of file AbstractItems.php.

     {
         if ($item) {
             if ($item->getOrderItem()) {
                 $item = $item->getOrderItem();
             }
             $parentItem = $item->getParentItem();
             if ($parentItem) {
                 $options = $parentItem->getProductOptions();
                 if ($options) {
                     return (isset($options['shipment_type'])
                         && $options['shipment_type'] == AbstractType::SHIPMENT_SEPARATELY);
                 }
             } else {
                 $options = $item->getProductOptions();
                 if ($options) {
                     return !(isset($options['shipment_type'])
                         && $options['shipment_type'] == AbstractType::SHIPMENT_SEPARATELY);
                 }
             }
         }
 
         $options = $this->getOrderItem()->getProductOptions();
         if ($options) {
             if (isset($options['shipment_type']) && $options['shipment_type'] == AbstractType::SHIPMENT_SEPARATELY) {
                 return true;
             }
         }
         return false;
     }

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

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ canShowPriceInfo()

◆ getBundleOptions()

◆ getChildren()

◆ getOrderItem()

◆ getOrderOptions()

◆ getSelectionAttributes()

◆ getValueHtml()

◆ isChildCalculated()

◆ isShipmentSeparately()