Magento Extensions Rating 2024
Magento 2 Documentation  2.3
Documentation for Magento 2 CMS v2.3 (December 2018)
Public Member Functions | Static Public Member Functions | Data Fields | Protected Member Functions | Protected Attributes | Static Protected Attributes
Item Class Reference
Inheritance diagram for Item:
AbstractModel OrderItemInterface AbstractExtensibleModel ExtensibleDataInterface AbstractModel CustomAttributesDataInterface DataObject ExtensibleDataInterface

Public Member Functions

 __construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Framework\Api\ExtensionAttributesFactory $extensionFactory, AttributeValueFactory $customAttributeFactory, \Magento\Sales\Model\OrderFactory $orderFactory, \Magento\Store\Model\StoreManagerInterface $storeManager, \Magento\Catalog\Api\ProductRepositoryInterface $productRepository, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[], \Magento\Framework\Serialize\Serializer\Json $serializer=null)
 
 setParentItem ($item)
 
 getParentItem ()
 
 canInvoice ()
 
 canShip ()
 
 canRefund ()
 
 getQtyToShip ()
 
 getSimpleQtyToShip ()
 
 getQtyToInvoice ()
 
 getQtyToRefund ()
 
 getQtyToCancel ()
 
 setOrder (\Magento\Sales\Model\Order $order)
 
 getOrder ()
 
 getStatusId ()
 
 getStatus ()
 
 cancel ()
 
 getOriginalPrice ()
 
 setProductOptions (array $options=null)
 
 getProductOptions ()
 
 getProductOptionByCode ($code=null)
 
 getRealProductType ()
 
 addChildItem ($item)
 
 getChildrenItems ()
 
 isChildrenCalculated ()
 
 getForceApplyDiscountToParentItem ()
 
 isShipSeparately ()
 
 isDummy ($shipment=false)
 
 getBuyRequest ()
 
 getProduct ()
 
 getStore ()
 
 getAdditionalData ()
 
 getAmountRefunded ()
 
 getAppliedRuleIds ()
 
 getBaseAmountRefunded ()
 
 getBaseCost ()
 
 getBaseDiscountAmount ()
 
 getBaseDiscountInvoiced ()
 
 getBaseDiscountRefunded ()
 
 getBaseDiscountTaxCompensationAmount ()
 
 getBaseDiscountTaxCompensationInvoiced ()
 
 getBaseDiscountTaxCompensationRefunded ()
 
 getBaseOriginalPrice ()
 
 getBasePrice ()
 
 getBasePriceInclTax ()
 
 getBaseRowInvoiced ()
 
 getBaseRowTotal ()
 
 getBaseRowTotalInclTax ()
 
 getBaseTaxAmount ()
 
 getBaseTaxBeforeDiscount ()
 
 getBaseTaxInvoiced ()
 
 getBaseTaxRefunded ()
 
 getBaseWeeeTaxAppliedAmount ()
 
 getBaseWeeeTaxAppliedRowAmnt ()
 
 getBaseWeeeTaxDisposition ()
 
 getBaseWeeeTaxRowDisposition ()
 
 getCreatedAt ()
 
 setCreatedAt ($createdAt)
 
 getDescription ()
 
 getDiscountAmount ()
 
 getDiscountInvoiced ()
 
 getDiscountPercent ()
 
 getDiscountRefunded ()
 
 getEventId ()
 
 getExtOrderItemId ()
 
 getFreeShipping ()
 
 getGwBasePrice ()
 
 getGwBasePriceInvoiced ()
 
 getGwBasePriceRefunded ()
 
 getGwBaseTaxAmount ()
 
 getGwBaseTaxAmountInvoiced ()
 
 getGwBaseTaxAmountRefunded ()
 
 getGwId ()
 
 getGwPrice ()
 
 getGwPriceInvoiced ()
 
 getGwPriceRefunded ()
 
 getGwTaxAmount ()
 
 getGwTaxAmountInvoiced ()
 
 getGwTaxAmountRefunded ()
 
 getDiscountTaxCompensationAmount ()
 
 getDiscountTaxCompensationCanceled ()
 
 getDiscountTaxCompensationInvoiced ()
 
 getDiscountTaxCompensationRefunded ()
 
 getIsQtyDecimal ()
 
 getIsVirtual ()
 
 getItemId ()
 
 getLockedDoInvoice ()
 
 getLockedDoShip ()
 
 getName ()
 
 getNoDiscount ()
 
 getOrderId ()
 
 getParentItemId ()
 
 getPrice ()
 
 getPriceInclTax ()
 
 getProductId ()
 
 getProductType ()
 
 getQtyBackordered ()
 
 getQtyCanceled ()
 
 getQtyInvoiced ()
 
 getQtyOrdered ()
 
 getQtyRefunded ()
 
 getQtyReturned ()
 
 getQtyShipped ()
 
 getQuoteItemId ()
 
 getRowInvoiced ()
 
 getRowTotal ()
 
 getRowTotalInclTax ()
 
 getRowWeight ()
 
 getSku ()
 
 getStoreId ()
 
 getTaxAmount ()
 
 getTaxBeforeDiscount ()
 
 getTaxCanceled ()
 
 getTaxInvoiced ()
 
 getTaxPercent ()
 
 getTaxRefunded ()
 
 getUpdatedAt ()
 
 getWeeeTaxApplied ()
 
 getWeeeTaxAppliedAmount ()
 
 getWeeeTaxAppliedRowAmount ()
 
 getWeeeTaxDisposition ()
 
 getWeeeTaxRowDisposition ()
 
 getWeight ()
 
 setUpdatedAt ($timestamp)
 
 setItemId ($id)
 
 setOrderId ($id)
 
 setParentItemId ($id)
 
 setQuoteItemId ($id)
 
 setStoreId ($id)
 
 setProductId ($id)
 
 setProductType ($productType)
 
 setWeight ($weight)
 
 setIsVirtual ($isVirtual)
 
 setSku ($sku)
 
 setName ($name)
 
 setDescription ($description)
 
 setAppliedRuleIds ($appliedRuleIds)
 
 setAdditionalData ($additionalData)
 
 setIsQtyDecimal ($isQtyDecimal)
 
 setNoDiscount ($noDiscount)
 
 setQtyBackordered ($qtyBackordered)
 
 setQtyCanceled ($qtyCanceled)
 
 setQtyInvoiced ($qtyInvoiced)
 
 setQtyOrdered ($qtyOrdered)
 
 setQtyRefunded ($qtyRefunded)
 
 setQtyShipped ($qtyShipped)
 
 setBaseCost ($baseCost)
 
 setPrice ($price)
 
 setBasePrice ($price)
 
 setOriginalPrice ($price)
 
 setBaseOriginalPrice ($price)
 
 setTaxPercent ($taxPercent)
 
 setTaxAmount ($amount)
 
 setBaseTaxAmount ($amount)
 
 setTaxInvoiced ($taxInvoiced)
 
 setBaseTaxInvoiced ($baseTaxInvoiced)
 
 setDiscountPercent ($discountPercent)
 
 setDiscountAmount ($amount)
 
 setBaseDiscountAmount ($amount)
 
 setDiscountInvoiced ($discountInvoiced)
 
 setBaseDiscountInvoiced ($baseDiscountInvoiced)
 
 setAmountRefunded ($amountRefunded)
 
 setBaseAmountRefunded ($baseAmountRefunded)
 
 setRowTotal ($amount)
 
 setBaseRowTotal ($amount)
 
 setRowInvoiced ($rowInvoiced)
 
 setBaseRowInvoiced ($baseRowInvoiced)
 
 setRowWeight ($rowWeight)
 
 setBaseTaxBeforeDiscount ($baseTaxBeforeDiscount)
 
 setTaxBeforeDiscount ($taxBeforeDiscount)
 
 setExtOrderItemId ($id)
 
 setLockedDoInvoice ($flag)
 
 setLockedDoShip ($flag)
 
 setPriceInclTax ($amount)
 
 setBasePriceInclTax ($amount)
 
 setRowTotalInclTax ($amount)
 
 setBaseRowTotalInclTax ($amount)
 
 setDiscountTaxCompensationAmount ($amount)
 
 setBaseDiscountTaxCompensationAmount ($amount)
 
 setDiscountTaxCompensationInvoiced ($discountTaxCompensationInvoiced)
 
 setBaseDiscountTaxCompensationInvoiced ($baseDiscountTaxCompensationInvoiced)
 
 setDiscountTaxCompensationRefunded ($discountTaxCompensationRefunded)
 
 setBaseDiscountTaxCompensationRefunded ($baseDiscountTaxCompensationRefunded)
 
 setTaxCanceled ($taxCanceled)
 
 setDiscountTaxCompensationCanceled ($discountTaxCompensationCanceled)
 
 setTaxRefunded ($taxRefunded)
 
 setBaseTaxRefunded ($baseTaxRefunded)
 
 setDiscountRefunded ($discountRefunded)
 
 setBaseDiscountRefunded ($baseDiscountRefunded)
 
 setGwId ($id)
 
 setGwBasePrice ($price)
 
 setGwPrice ($price)
 
 setGwBaseTaxAmount ($amount)
 
 setGwTaxAmount ($amount)
 
 setGwBasePriceInvoiced ($gwBasePriceInvoiced)
 
 setGwPriceInvoiced ($gwPriceInvoiced)
 
 setGwBaseTaxAmountInvoiced ($gwBaseTaxAmountInvoiced)
 
 setGwTaxAmountInvoiced ($gwTaxAmountInvoiced)
 
 setGwBasePriceRefunded ($gwBasePriceRefunded)
 
 setGwPriceRefunded ($gwPriceRefunded)
 
 setGwBaseTaxAmountRefunded ($gwBaseTaxAmountRefunded)
 
 setGwTaxAmountRefunded ($gwTaxAmountRefunded)
 
 setFreeShipping ($freeShipping)
 
 setQtyReturned ($qtyReturned)
 
 setEventId ($id)
 
 setBaseWeeeTaxAppliedAmount ($amount)
 
 setBaseWeeeTaxAppliedRowAmnt ($amnt)
 
 setWeeeTaxAppliedAmount ($amount)
 
 setWeeeTaxAppliedRowAmount ($amount)
 
 setWeeeTaxApplied ($weeeTaxApplied)
 
 setWeeeTaxDisposition ($weeeTaxDisposition)
 
 setWeeeTaxRowDisposition ($weeeTaxRowDisposition)
 
 setBaseWeeeTaxDisposition ($baseWeeeTaxDisposition)
 
 setBaseWeeeTaxRowDisposition ($baseWeeeTaxRowDisposition)
 
 getProductOption ()
 
 setProductOption (\Magento\Catalog\Api\Data\ProductOptionInterface $productOption)
 
 getExtensionAttributes ()
 
 setExtensionAttributes (\Magento\Sales\Api\Data\OrderItemExtensionInterface $extensionAttributes)
 
 isProcessingAvailable ()
 
- Public Member Functions inherited from AbstractModel
 __construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Framework\Api\ExtensionAttributesFactory $extensionFactory, AttributeValueFactory $customAttributeFactory, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[])
 
 getEventObject ()
 
- Public Member Functions inherited from AbstractExtensibleModel
 __construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, ExtensionAttributesFactory $extensionFactory, AttributeValueFactory $customAttributeFactory, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[])
 
 getCustomAttributes ()
 
 getCustomAttribute ($attributeCode)
 
 setCustomAttributes (array $attributes)
 
 setCustomAttribute ($attributeCode, $attributeValue)
 
 setData ($key, $value=null)
 
 unsetData ($key=null)
 
 getData ($key='', $index=null)
 
 setId ($value)
 
 __sleep ()
 
 __wakeup ()
 
- 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)
 
- Public Member Functions inherited from OrderItemInterface
 setProductOption (\Magento\Catalog\Api\Data\ProductOptionInterface $productOption)
 
 setExtensionAttributes (\Magento\Sales\Api\Data\OrderItemExtensionInterface $extensionAttributes)
 

Static Public Member Functions

static getStatusName ($statusId)
 
static getStatuses ()
 

Data Fields

const STATUS_PENDING = 1
 
const STATUS_SHIPPED = 2
 
const STATUS_INVOICED = 9
 
const STATUS_BACKORDERED = 3
 
const STATUS_CANCELED = 5
 
const STATUS_PARTIAL = 6
 
const STATUS_MIXED = 7
 
const STATUS_REFUNDED = 8
 
const STATUS_RETURNED = 4
 
- Data Fields inherited from CustomAttributesDataInterface
const CUSTOM_ATTRIBUTES = 'custom_attributes'
 
- Data Fields inherited from ExtensibleDataInterface
const EXTENSION_ATTRIBUTES_KEY = 'extension_attributes'
 
- Data Fields inherited from OrderItemInterface
const ITEM_ID = 'item_id'
 
const ORDER_ID = 'order_id'
 
const PARENT_ITEM_ID = 'parent_item_id'
 
const QUOTE_ITEM_ID = 'quote_item_id'
 
const STORE_ID = 'store_id'
 
const CREATED_AT = 'created_at'
 
const UPDATED_AT = 'updated_at'
 
const PRODUCT_ID = 'product_id'
 
const PRODUCT_TYPE = 'product_type'
 
const WEIGHT = 'weight'
 
const IS_VIRTUAL = 'is_virtual'
 
const SKU = 'sku'
 
const NAME = 'name'
 
const DESCRIPTION = 'description'
 
const APPLIED_RULE_IDS = 'applied_rule_ids'
 
const ADDITIONAL_DATA = 'additional_data'
 
const IS_QTY_DECIMAL = 'is_qty_decimal'
 
const NO_DISCOUNT = 'no_discount'
 
const QTY_BACKORDERED = 'qty_backordered'
 
const QTY_CANCELED = 'qty_canceled'
 
const QTY_INVOICED = 'qty_invoiced'
 
const QTY_ORDERED = 'qty_ordered'
 
const QTY_REFUNDED = 'qty_refunded'
 
const QTY_SHIPPED = 'qty_shipped'
 
const BASE_COST = 'base_cost'
 
const PRICE = 'price'
 
const BASE_PRICE = 'base_price'
 
const ORIGINAL_PRICE = 'original_price'
 
const BASE_ORIGINAL_PRICE = 'base_original_price'
 
const TAX_PERCENT = 'tax_percent'
 
const TAX_AMOUNT = 'tax_amount'
 
const BASE_TAX_AMOUNT = 'base_tax_amount'
 
const TAX_INVOICED = 'tax_invoiced'
 
const BASE_TAX_INVOICED = 'base_tax_invoiced'
 
const DISCOUNT_PERCENT = 'discount_percent'
 
const DISCOUNT_AMOUNT = 'discount_amount'
 
const BASE_DISCOUNT_AMOUNT = 'base_discount_amount'
 
const DISCOUNT_INVOICED = 'discount_invoiced'
 
const BASE_DISCOUNT_INVOICED = 'base_discount_invoiced'
 
const AMOUNT_REFUNDED = 'amount_refunded'
 
const BASE_AMOUNT_REFUNDED = 'base_amount_refunded'
 
const ROW_TOTAL = 'row_total'
 
const BASE_ROW_TOTAL = 'base_row_total'
 
const ROW_INVOICED = 'row_invoiced'
 
const BASE_ROW_INVOICED = 'base_row_invoiced'
 
const ROW_WEIGHT = 'row_weight'
 
const BASE_TAX_BEFORE_DISCOUNT = 'base_tax_before_discount'
 
const TAX_BEFORE_DISCOUNT = 'tax_before_discount'
 
const EXT_ORDER_ITEM_ID = 'ext_order_item_id'
 
const LOCKED_DO_INVOICE = 'locked_do_invoice'
 
const LOCKED_DO_SHIP = 'locked_do_ship'
 
const PRICE_INCL_TAX = 'price_incl_tax'
 
const BASE_PRICE_INCL_TAX = 'base_price_incl_tax'
 
const ROW_TOTAL_INCL_TAX = 'row_total_incl_tax'
 
const BASE_ROW_TOTAL_INCL_TAX = 'base_row_total_incl_tax'
 
const DISCOUNT_TAX_COMPENSATION_AMOUNT = 'discount_tax_compensation_amount'
 
const BASE_DISCOUNT_TAX_COMPENSATION_AMOUNT = 'base_discount_tax_compensation_amount'
 
const DISCOUNT_TAX_COMPENSATION_INVOICED = 'discount_tax_compensation_invoiced'
 
const BASE_DISCOUNT_TAX_COMPENSATION_INVOICED = 'base_discount_tax_compensation_invoiced'
 
const DISCOUNT_TAX_COMPENSATION_REFUNDED = 'discount_tax_compensation_refunded'
 
const BASE_DISCOUNT_TAX_COMPENSATION_REFUNDED = 'base_discount_tax_compensation_refunded'
 
const TAX_CANCELED = 'tax_canceled'
 
const DISCOUNT_TAX_COMPENSATION_CANCELED = 'discount_tax_compensation_canceled'
 
const TAX_REFUNDED = 'tax_refunded'
 
const BASE_TAX_REFUNDED = 'base_tax_refunded'
 
const DISCOUNT_REFUNDED = 'discount_refunded'
 
const BASE_DISCOUNT_REFUNDED = 'base_discount_refunded'
 
const GW_ID = 'gw_id'
 
const GW_BASE_PRICE = 'gw_base_price'
 
const GW_PRICE = 'gw_price'
 
const GW_BASE_TAX_AMOUNT = 'gw_base_tax_amount'
 
const GW_TAX_AMOUNT = 'gw_tax_amount'
 
const GW_BASE_PRICE_INVOICED = 'gw_base_price_invoiced'
 
const GW_PRICE_INVOICED = 'gw_price_invoiced'
 
const GW_BASE_TAX_AMOUNT_INVOICED = 'gw_base_tax_amount_invoiced'
 
const GW_TAX_AMOUNT_INVOICED = 'gw_tax_amount_invoiced'
 
const GW_BASE_PRICE_REFUNDED = 'gw_base_price_refunded'
 
const GW_PRICE_REFUNDED = 'gw_price_refunded'
 
const GW_BASE_TAX_AMOUNT_REFUNDED = 'gw_base_tax_amount_refunded'
 
const GW_TAX_AMOUNT_REFUNDED = 'gw_tax_amount_refunded'
 
const FREE_SHIPPING = 'free_shipping'
 
const QTY_RETURNED = 'qty_returned'
 
const EVENT_ID = 'event_id'
 
const BASE_WEEE_TAX_APPLIED_AMOUNT = 'base_weee_tax_applied_amount'
 
const BASE_WEEE_TAX_APPLIED_ROW_AMNT = 'base_weee_tax_applied_row_amnt'
 
const WEEE_TAX_APPLIED_AMOUNT = 'weee_tax_applied_amount'
 
const WEEE_TAX_APPLIED_ROW_AMOUNT = 'weee_tax_applied_row_amount'
 
const WEEE_TAX_APPLIED = 'weee_tax_applied'
 
const WEEE_TAX_DISPOSITION = 'weee_tax_disposition'
 
const WEEE_TAX_ROW_DISPOSITION = 'weee_tax_row_disposition'
 
const BASE_WEEE_TAX_DISPOSITION = 'base_weee_tax_disposition'
 
const BASE_WEEE_TAX_ROW_DISPOSITION = 'base_weee_tax_row_disposition'
 
const PARENT_ITEM = 'parent_item'
 
const KEY_PRODUCT_OPTION = 'product_option'
 

Protected Member Functions

 _construct ()
 
 _getQtyChildrenBackordered ()
 
- Protected Member Functions inherited from AbstractExtensibleModel
 filterCustomAttributes ($data)
 
 initializeCustomAttributes ()
 
 convertCustomAttributeValues (array &$customAttributes)
 
 getCustomAttributesCodes ()
 
 _setExtensionAttributes (\Magento\Framework\Api\ExtensionAttributesInterface $extensionAttributes)
 
 _getExtensionAttributes ()
 
- 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

 $_eventPrefix = 'sales_order_item'
 
 $_eventObject = 'item'
 
 $_order = null
 
 $_children = []
 
 $_orderFactory
 
 $productRepository
 
 $_storeManager
 
- Protected Attributes inherited from AbstractExtensibleModel
 $extensionAttributesFactory
 
 $extensionAttributes
 
 $customAttributeFactory
 
 $customAttributesCodes = null
 
 $customAttributesChanged = false
 
- 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

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

Detailed Description

Order Item Model

@api @method int getGiftMessageId() @method \Magento\Sales\Model\Order\Item setGiftMessageId(int $value) @method int getGiftMessageAvailable() @method \Magento\Sales\Model\Order\Item setGiftMessageAvailable(int $value) @SuppressWarnings(PHPMD.ExcessivePublicCount) @SuppressWarnings(PHPMD.ExcessiveClassComplexity) @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Since
100.0.2

Definition at line 25 of file Item.php.

Constructor & Destructor Documentation

◆ __construct()

__construct ( \Magento\Framework\Model\Context  $context,
\Magento\Framework\Registry  $registry,
\Magento\Framework\Api\ExtensionAttributesFactory  $extensionFactory,
AttributeValueFactory  $customAttributeFactory,
\Magento\Sales\Model\OrderFactory  $orderFactory,
\Magento\Store\Model\StoreManagerInterface  $storeManager,
\Magento\Catalog\Api\ProductRepositoryInterface  $productRepository,
\Magento\Framework\Model\ResourceModel\AbstractResource  $resource = null,
\Magento\Framework\Data\Collection\AbstractDb  $resourceCollection = null,
array  $data = [],
\Magento\Framework\Serialize\Serializer\Json  $serializer = null 
)

Initialize dependencies.

Parameters
\Magento\Framework\Model\Context$context
\Magento\Framework\Registry$registry
\Magento\Framework\Api\ExtensionAttributesFactory$extensionFactory
AttributeValueFactory$customAttributeFactory
\Magento\Sales\Model\OrderFactory$orderFactory
\Magento\Store\Model\StoreManagerInterface$storeManager
\Magento\Catalog\Api\ProductRepositoryInterface$productRepository
\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 119 of file Item.php.

131  {
132  parent::__construct(
133  $context,
134  $registry,
135  $extensionFactory,
136  $customAttributeFactory,
137  $resource,
138  $resourceCollection,
139  $data
140  );
141  $this->serializer = $serializer ?: \Magento\Framework\App\ObjectManager::getInstance()
142  ->get(\Magento\Framework\Serialize\Serializer\Json::class);
143  $this->_orderFactory = $orderFactory;
144  $this->_storeManager = $storeManager;
145  $this->productRepository = $productRepository;
146  }
$serializer
$serializer
Definition: quote_with_payment_saved.php:10
$storeManager
$storeManager
Definition: paypal_quote.php:14
$resource
$resource
Definition: bulk.php:12
$registry
$registry
Definition: bundle_product_with_not_visible_children_rollback.php:16
$data
$data
Definition: attribute_set_with_image_attribute.php:16

Member Function Documentation

◆ _construct()

_construct ( )
protected

Init resource model

Returns
void

Definition at line 153 of file Item.php.

154  {
155  $this->_init(\Magento\Sales\Model\ResourceModel\Order\Item::class);
156  }

◆ _getQtyChildrenBackordered()

_getQtyChildrenBackordered ( )
protected

Retrieve backordered qty of children items

Returns
float|null

Definition at line 363 of file Item.php.

364  {
365  $backordered = null;
366  foreach ($this->_children as $childItem) {
367  $backordered += (double)$childItem->getQtyBackordered();
368  }
369 
370  return $backordered;
371  }

◆ addChildItem()

addChildItem (   $item)

Adds child item to this item

Parameters
Item$item
Returns
void

Definition at line 524 of file Item.php.

525  {
526  if ($item instanceof \Magento\Sales\Model\Order\Item) {
527  $this->_children[] = $item;
528  } elseif (is_array($item)) {
529  $this->_children = array_merge($this->_children, $item);
530  }
531  }
elseif
elseif(isset( $params[ 'redirect_parent']))
Definition: iframe.phtml:17
$item
$item
Definition: partial_invoice.php:27

◆ cancel()

cancel ( )

Cancel order item

Returns
$this

Definition at line 405 of file Item.php.

406  {
407  if ($this->getStatusId() !== self::STATUS_CANCELED) {
408  $this->_eventManager->dispatch('sales_order_item_cancel', ['item' => $this]);
409  $this->setQtyCanceled($this->getQtyToCancel());
410  $this->setTaxCanceled(
411  $this->getTaxCanceled() + $this->getBaseTaxAmount() * $this->getQtyCanceled() / $this->getQtyOrdered()
412  );
413  $this->setDiscountTaxCompensationCanceled(
414  $this->getDiscountTaxCompensationCanceled() +
415  $this->getDiscountTaxCompensationAmount() * $this->getQtyCanceled() / $this->getQtyOrdered()
416  );
417  }
418  return $this;
419  }
Magento\Sales\Model\Order\Item\setDiscountTaxCompensationCanceled
setDiscountTaxCompensationCanceled($discountTaxCompensationCanceled)
Definition: Item.php:2120
Magento\Sales\Model\Order\Item\setQtyCanceled
setQtyCanceled($qtyCanceled)
Definition: Item.php:1770
Magento\Sales\Model\Order\Item\setTaxCanceled
setTaxCanceled($taxCanceled)
Definition: Item.php:2112

◆ canInvoice()

canInvoice ( )

Check item invoice availability

Returns
bool

Definition at line 189 of file Item.php.

190  {
191  return $this->getQtyToInvoice() > 0;
192  }

◆ canRefund()

canRefund ( )

Check item refund availability

Returns
bool

Definition at line 209 of file Item.php.

210  {
211  return $this->getQtyToRefund() > 0;
212  }

◆ canShip()

canShip ( )

Check item ship availability

Returns
bool

Definition at line 199 of file Item.php.

200  {
201  return $this->getQtyToShip() > 0;
202  }

◆ getAdditionalData()

getAdditionalData ( )

Return additional_data

Returns
string|null

Implements OrderItemInterface.

Definition at line 710 of file Item.php.

711  {
712  return $this->getData(OrderItemInterface::ADDITIONAL_DATA);
713  }

◆ getAmountRefunded()

getAmountRefunded ( )

Return amount_refunded

Returns
float|null

Implements OrderItemInterface.

Definition at line 720 of file Item.php.

721  {
722  return $this->getData(OrderItemInterface::AMOUNT_REFUNDED);
723  }

◆ getAppliedRuleIds()

getAppliedRuleIds ( )

Return applied_rule_ids

Returns
string|null

Implements OrderItemInterface.

Definition at line 730 of file Item.php.

731  {
732  return $this->getData(OrderItemInterface::APPLIED_RULE_IDS);
733  }

◆ getBaseAmountRefunded()

getBaseAmountRefunded ( )

Return base_amount_refunded

Returns
float|null

Implements OrderItemInterface.

Definition at line 740 of file Item.php.

741  {
742  return $this->getData(OrderItemInterface::BASE_AMOUNT_REFUNDED);
743  }

◆ getBaseCost()

getBaseCost ( )

Return base_cost

Returns
float|null

Implements OrderItemInterface.

Definition at line 750 of file Item.php.

751  {
752  return $this->getData(OrderItemInterface::BASE_COST);
753  }

◆ getBaseDiscountAmount()

getBaseDiscountAmount ( )

Return base_discount_amount

Returns
float|null

Implements OrderItemInterface.

Definition at line 760 of file Item.php.

761  {
762  return $this->getData(OrderItemInterface::BASE_DISCOUNT_AMOUNT);
763  }

◆ getBaseDiscountInvoiced()

getBaseDiscountInvoiced ( )

Return base_discount_invoiced

Returns
float|null

Implements OrderItemInterface.

Definition at line 770 of file Item.php.

771  {
772  return $this->getData(OrderItemInterface::BASE_DISCOUNT_INVOICED);
773  }

◆ getBaseDiscountRefunded()

getBaseDiscountRefunded ( )

Return base_discount_refunded

Returns
float|null

Implements OrderItemInterface.

Definition at line 780 of file Item.php.

781  {
782  return $this->getData(OrderItemInterface::BASE_DISCOUNT_REFUNDED);
783  }

◆ getBaseDiscountTaxCompensationAmount()

getBaseDiscountTaxCompensationAmount ( )

Return base_discount_tax_compensation_amount

Returns
float|null

Implements OrderItemInterface.

Definition at line 790 of file Item.php.

791  {
792  return $this->getData(OrderItemInterface::BASE_DISCOUNT_TAX_COMPENSATION_AMOUNT);
793  }

◆ getBaseDiscountTaxCompensationInvoiced()

getBaseDiscountTaxCompensationInvoiced ( )

Return base_discount_tax_compensation_invoiced

Returns
float|null

Implements OrderItemInterface.

Definition at line 800 of file Item.php.

801  {
802  return $this->getData(OrderItemInterface::BASE_DISCOUNT_TAX_COMPENSATION_INVOICED);
803  }

◆ getBaseDiscountTaxCompensationRefunded()

getBaseDiscountTaxCompensationRefunded ( )

Return base_discount_tax_compensation_refunded

Returns
float|null

Implements OrderItemInterface.

Definition at line 810 of file Item.php.

811  {
812  return $this->getData(OrderItemInterface::BASE_DISCOUNT_TAX_COMPENSATION_REFUNDED);
813  }

◆ getBaseOriginalPrice()

getBaseOriginalPrice ( )

Return base_original_price

Returns
float|null

Implements OrderItemInterface.

Definition at line 820 of file Item.php.

821  {
822  return $this->getData(OrderItemInterface::BASE_ORIGINAL_PRICE);
823  }

◆ getBasePrice()

getBasePrice ( )

Return base_price

Returns
float|null

Implements OrderItemInterface.

Definition at line 830 of file Item.php.

831  {
832  return $this->getData(OrderItemInterface::BASE_PRICE);
833  }

◆ getBasePriceInclTax()

getBasePriceInclTax ( )

Return base_price_incl_tax

Returns
float|null

Implements OrderItemInterface.

Definition at line 840 of file Item.php.

841  {
842  return $this->getData(OrderItemInterface::BASE_PRICE_INCL_TAX);
843  }

◆ getBaseRowInvoiced()

getBaseRowInvoiced ( )

Return base_row_invoiced

Returns
float|null

Implements OrderItemInterface.

Definition at line 850 of file Item.php.

851  {
852  return $this->getData(OrderItemInterface::BASE_ROW_INVOICED);
853  }

◆ getBaseRowTotal()

getBaseRowTotal ( )

Return base_row_total

Returns
float|null

Implements OrderItemInterface.

Definition at line 860 of file Item.php.

861  {
862  return $this->getData(OrderItemInterface::BASE_ROW_TOTAL);
863  }

◆ getBaseRowTotalInclTax()

getBaseRowTotalInclTax ( )

Return base_row_total_incl_tax

Returns
float|null

Implements OrderItemInterface.

Definition at line 870 of file Item.php.

871  {
872  return $this->getData(OrderItemInterface::BASE_ROW_TOTAL_INCL_TAX);
873  }

◆ getBaseTaxAmount()

getBaseTaxAmount ( )

Return base_tax_amount

Returns
float|null

Implements OrderItemInterface.

Definition at line 880 of file Item.php.

881  {
882  return $this->getData(OrderItemInterface::BASE_TAX_AMOUNT);
883  }

◆ getBaseTaxBeforeDiscount()

getBaseTaxBeforeDiscount ( )

Return base_tax_before_discount

Returns
float|null

Implements OrderItemInterface.

Definition at line 890 of file Item.php.

891  {
892  return $this->getData(OrderItemInterface::BASE_TAX_BEFORE_DISCOUNT);
893  }

◆ getBaseTaxInvoiced()

getBaseTaxInvoiced ( )

Return base_tax_invoiced

Returns
float|null

Implements OrderItemInterface.

Definition at line 900 of file Item.php.

901  {
902  return $this->getData(OrderItemInterface::BASE_TAX_INVOICED);
903  }

◆ getBaseTaxRefunded()

getBaseTaxRefunded ( )

Return base_tax_refunded

Returns
float|null

Implements OrderItemInterface.

Definition at line 910 of file Item.php.

911  {
912  return $this->getData(OrderItemInterface::BASE_TAX_REFUNDED);
913  }

◆ getBaseWeeeTaxAppliedAmount()

getBaseWeeeTaxAppliedAmount ( )

Return base_weee_tax_applied_amount

Returns
float|null

Implements OrderItemInterface.

Definition at line 920 of file Item.php.

921  {
922  return $this->getData(OrderItemInterface::BASE_WEEE_TAX_APPLIED_AMOUNT);
923  }

◆ getBaseWeeeTaxAppliedRowAmnt()

getBaseWeeeTaxAppliedRowAmnt ( )

Return base_weee_tax_applied_row_amnt

Returns
float|null

Implements OrderItemInterface.

Definition at line 930 of file Item.php.

931  {
932  return $this->getData(OrderItemInterface::BASE_WEEE_TAX_APPLIED_ROW_AMNT);
933  }

◆ getBaseWeeeTaxDisposition()

getBaseWeeeTaxDisposition ( )

Return base_weee_tax_disposition

Returns
float|null

Implements OrderItemInterface.

Definition at line 940 of file Item.php.

941  {
942  return $this->getData(OrderItemInterface::BASE_WEEE_TAX_DISPOSITION);
943  }

◆ getBaseWeeeTaxRowDisposition()

getBaseWeeeTaxRowDisposition ( )

Return base_weee_tax_row_disposition

Returns
float|null

Implements OrderItemInterface.

Definition at line 950 of file Item.php.

951  {
952  return $this->getData(OrderItemInterface::BASE_WEEE_TAX_ROW_DISPOSITION);
953  }

◆ getBuyRequest()

getBuyRequest ( )

Return formatted buy request.

This object is holding request received from product view page with keys and options for configured product.

Returns
\Magento\Framework\DataObject

Definition at line 660 of file Item.php.

661  {
662  $option = $this->getProductOptionByCode('info_buyRequest');
663  if (!$option) {
664  $option = [];
665  }
666  $buyRequest = new \Magento\Framework\DataObject($option);
667  $buyRequest->setQty($this->getQtyOrdered() * 1);
668  return $buyRequest;
669  }
Magento\Sales\Model\Order\Item\getProductOptionByCode
getProductOptionByCode($code=null)
Definition: Item.php:492
$buyRequest
foreach($product->getExtensionAttributes() ->getBundleProductOptions() as $option) $buyRequest
Definition: quote_with_bundle.php:166
$option
$option
Definition: product_configurable_with_single_child.php:38

◆ getChildrenItems()

getChildrenItems ( )

Return children items of this item

Returns
array

Definition at line 538 of file Item.php.

539  {
540  return $this->_children;
541  }

◆ getCreatedAt()

getCreatedAt ( )

Return created_at

Returns
string|null

Implements OrderItemInterface.

Definition at line 960 of file Item.php.

961  {
962  return $this->getData(OrderItemInterface::CREATED_AT);
963  }

◆ getDescription()

getDescription ( )

Return description

Returns
string|null

Implements OrderItemInterface.

Definition at line 978 of file Item.php.

979  {
980  return $this->getData(OrderItemInterface::DESCRIPTION);
981  }

◆ getDiscountAmount()

getDiscountAmount ( )

Return discount_amount

Returns
float|null

Implements OrderItemInterface.

Definition at line 988 of file Item.php.

989  {
990  return $this->getData(OrderItemInterface::DISCOUNT_AMOUNT);
991  }

◆ getDiscountInvoiced()

getDiscountInvoiced ( )

Return discount_invoiced

Returns
float|null

Implements OrderItemInterface.

Definition at line 998 of file Item.php.

999  {
1000  return $this->getData(OrderItemInterface::DISCOUNT_INVOICED);
1001  }

◆ getDiscountPercent()

getDiscountPercent ( )

Return discount_percent

Returns
float|null

Implements OrderItemInterface.

Definition at line 1008 of file Item.php.

1009  {
1010  return $this->getData(OrderItemInterface::DISCOUNT_PERCENT);
1011  }

◆ getDiscountRefunded()

getDiscountRefunded ( )

Return discount_refunded

Returns
float|null

Implements OrderItemInterface.

Definition at line 1018 of file Item.php.

1019  {
1020  return $this->getData(OrderItemInterface::DISCOUNT_REFUNDED);
1021  }

◆ getDiscountTaxCompensationAmount()

getDiscountTaxCompensationAmount ( )

Return discount_tax_compensation_amount

Returns
float|null

Implements OrderItemInterface.

Definition at line 1188 of file Item.php.

1189  {
1190  return $this->getData(OrderItemInterface::DISCOUNT_TAX_COMPENSATION_AMOUNT);
1191  }

◆ getDiscountTaxCompensationCanceled()

getDiscountTaxCompensationCanceled ( )

Return discount_tax_compensation_canceled

Returns
float|null

Implements OrderItemInterface.

Definition at line 1198 of file Item.php.

1199  {
1200  return $this->getData(OrderItemInterface::DISCOUNT_TAX_COMPENSATION_CANCELED);
1201  }

◆ getDiscountTaxCompensationInvoiced()

getDiscountTaxCompensationInvoiced ( )

Return discount_tax_compensation_invoiced

Returns
float|null

Implements OrderItemInterface.

Definition at line 1208 of file Item.php.

1209  {
1210  return $this->getData(OrderItemInterface::DISCOUNT_TAX_COMPENSATION_INVOICED);
1211  }

◆ getDiscountTaxCompensationRefunded()

getDiscountTaxCompensationRefunded ( )

Return discount_tax_compensation_refunded

Returns
float|null

Implements OrderItemInterface.

Definition at line 1218 of file Item.php.

1219  {
1220  return $this->getData(OrderItemInterface::DISCOUNT_TAX_COMPENSATION_REFUNDED);
1221  }

◆ getEventId()

getEventId ( )

Return event_id

Returns
int|null

Implements OrderItemInterface.

Definition at line 1028 of file Item.php.

1029  {
1030  return $this->getData(OrderItemInterface::EVENT_ID);
1031  }

◆ getExtensionAttributes()

getExtensionAttributes ( )

Retrieve existing extension attributes object or create a new one.

Returns
\Magento\Sales\Api\Data\OrderItemExtensionInterface|null

Returns
\Magento\Sales\Api\Data\OrderItemExtensionInterface|null

Implements OrderItemInterface.

Definition at line 2378 of file Item.php.

2379  {
2380  return $this->_getExtensionAttributes();
2381  }

◆ getExtOrderItemId()

getExtOrderItemId ( )

Return ext_order_item_id

Returns
string|null

Implements OrderItemInterface.

Definition at line 1038 of file Item.php.

1039  {
1040  return $this->getData(OrderItemInterface::EXT_ORDER_ITEM_ID);
1041  }

◆ getForceApplyDiscountToParentItem()

getForceApplyDiscountToParentItem ( )

Check if discount has to be applied to parent item

Returns
bool @SuppressWarnings(PHPMD.BooleanGetMethodName)

Definition at line 572 of file Item.php.

573  {
574  if ($this->getParentItem()) {
575  $product = $this->getParentItem()->getProduct();
576  } else {
577  $product = $this->getProduct();
578  }
579 
580  return $product->getTypeInstance()->getForceApplyDiscountToParentItem();
581  }
$product
$product
Definition: bundle_product_with_not_visible_children.php:22

◆ getFreeShipping()

getFreeShipping ( )

Return free_shipping

Returns
int|null

Implements OrderItemInterface.

Definition at line 1048 of file Item.php.

1049  {
1050  return $this->getData(OrderItemInterface::FREE_SHIPPING);
1051  }

◆ getGwBasePrice()

getGwBasePrice ( )

Return gw_base_price

Returns
float|null

Implements OrderItemInterface.

Definition at line 1058 of file Item.php.

1059  {
1060  return $this->getData(OrderItemInterface::GW_BASE_PRICE);
1061  }

◆ getGwBasePriceInvoiced()

getGwBasePriceInvoiced ( )

Return gw_base_price_invoiced

Returns
float|null

Implements OrderItemInterface.

Definition at line 1068 of file Item.php.

1069  {
1070  return $this->getData(OrderItemInterface::GW_BASE_PRICE_INVOICED);
1071  }

◆ getGwBasePriceRefunded()

getGwBasePriceRefunded ( )

Return gw_base_price_refunded

Returns
float|null

Implements OrderItemInterface.

Definition at line 1078 of file Item.php.

1079  {
1080  return $this->getData(OrderItemInterface::GW_BASE_PRICE_REFUNDED);
1081  }

◆ getGwBaseTaxAmount()

getGwBaseTaxAmount ( )

Return gw_base_tax_amount

Returns
float|null

Implements OrderItemInterface.

Definition at line 1088 of file Item.php.

1089  {
1090  return $this->getData(OrderItemInterface::GW_BASE_TAX_AMOUNT);
1091  }

◆ getGwBaseTaxAmountInvoiced()

getGwBaseTaxAmountInvoiced ( )

Return gw_base_tax_amount_invoiced

Returns
float|null

Implements OrderItemInterface.

Definition at line 1098 of file Item.php.

1099  {
1100  return $this->getData(OrderItemInterface::GW_BASE_TAX_AMOUNT_INVOICED);
1101  }

◆ getGwBaseTaxAmountRefunded()

getGwBaseTaxAmountRefunded ( )

Return gw_base_tax_amount_refunded

Returns
float|null

Implements OrderItemInterface.

Definition at line 1108 of file Item.php.

1109  {
1110  return $this->getData(OrderItemInterface::GW_BASE_TAX_AMOUNT_REFUNDED);
1111  }

◆ getGwId()

getGwId ( )

Return gw_id

Returns
int|null

Implements OrderItemInterface.

Definition at line 1118 of file Item.php.

1119  {
1120  return $this->getData(OrderItemInterface::GW_ID);
1121  }

◆ getGwPrice()

getGwPrice ( )

Return gw_price

Returns
float|null

Implements OrderItemInterface.

Definition at line 1128 of file Item.php.

1129  {
1130  return $this->getData(OrderItemInterface::GW_PRICE);
1131  }

◆ getGwPriceInvoiced()

getGwPriceInvoiced ( )

Return gw_price_invoiced

Returns
float|null

Implements OrderItemInterface.

Definition at line 1138 of file Item.php.

1139  {
1140  return $this->getData(OrderItemInterface::GW_PRICE_INVOICED);
1141  }

◆ getGwPriceRefunded()

getGwPriceRefunded ( )

Return gw_price_refunded

Returns
float|null

Implements OrderItemInterface.

Definition at line 1148 of file Item.php.

1149  {
1150  return $this->getData(OrderItemInterface::GW_PRICE_REFUNDED);
1151  }

◆ getGwTaxAmount()

getGwTaxAmount ( )

Return gw_tax_amount

Returns
float|null

Implements OrderItemInterface.

Definition at line 1158 of file Item.php.

1159  {
1160  return $this->getData(OrderItemInterface::GW_TAX_AMOUNT);
1161  }

◆ getGwTaxAmountInvoiced()

getGwTaxAmountInvoiced ( )

Return gw_tax_amount_invoiced

Returns
float|null

Implements OrderItemInterface.

Definition at line 1168 of file Item.php.

1169  {
1170  return $this->getData(OrderItemInterface::GW_TAX_AMOUNT_INVOICED);
1171  }

◆ getGwTaxAmountRefunded()

getGwTaxAmountRefunded ( )

Return gw_tax_amount_refunded

Returns
float|null

Implements OrderItemInterface.

Definition at line 1178 of file Item.php.

1179  {
1180  return $this->getData(OrderItemInterface::GW_TAX_AMOUNT_REFUNDED);
1181  }

◆ getIsQtyDecimal()

getIsQtyDecimal ( )

Return is_qty_decimal

Returns
int|null

Implements OrderItemInterface.

Definition at line 1228 of file Item.php.

1229  {
1230  return $this->getData(OrderItemInterface::IS_QTY_DECIMAL);
1231  }

◆ getIsVirtual()

getIsVirtual ( )

Return is_virtual

Returns
int|null

Implements OrderItemInterface.

Definition at line 1238 of file Item.php.

1239  {
1240  return $this->getData(OrderItemInterface::IS_VIRTUAL);
1241  }

◆ getItemId()

getItemId ( )

Return item_id

Returns
int|null

Implements OrderItemInterface.

Definition at line 1248 of file Item.php.

1249  {
1250  return $this->getData(OrderItemInterface::ITEM_ID);
1251  }

◆ getLockedDoInvoice()

getLockedDoInvoice ( )

Return locked_do_invoice

Returns
int|null

Implements OrderItemInterface.

Definition at line 1258 of file Item.php.

1259  {
1260  return $this->getData(OrderItemInterface::LOCKED_DO_INVOICE);
1261  }

◆ getLockedDoShip()

getLockedDoShip ( )

Return locked_do_ship

Returns
int|null

Implements OrderItemInterface.

Definition at line 1268 of file Item.php.

1269  {
1270  return $this->getData(OrderItemInterface::LOCKED_DO_SHIP);
1271  }

◆ getName()

getName ( )

Return name

Returns
string|null

Implements OrderItemInterface.

Definition at line 1278 of file Item.php.

1279  {
1280  return $this->getData(OrderItemInterface::NAME);
1281  }

◆ getNoDiscount()

getNoDiscount ( )

Return no_discount

Returns
int|null

Implements OrderItemInterface.

Definition at line 1288 of file Item.php.

1289  {
1290  return $this->getData(OrderItemInterface::NO_DISCOUNT);
1291  }

◆ getOrder()

getOrder ( )

Retrieve order model object

Returns
\Magento\Sales\Model\Order

Definition at line 297 of file Item.php.

298  {
299  if ($this->_order === null && ($orderId = $this->getOrderId())) {
300  $order = $this->_orderFactory->create();
301  $order->load($orderId);
302  $this->setOrder($order);
303  }
304  return $this->_order;
305  }
$order
$order
Definition: order.php:55
Magento\Sales\Model\Order\Item\setOrder
setOrder(\Magento\Sales\Model\Order $order)
Definition: Item.php:285

◆ getOrderId()

getOrderId ( )

Return order_id

Returns
int|null

Implements OrderItemInterface.

Definition at line 1298 of file Item.php.

1299  {
1300  return $this->getData(OrderItemInterface::ORDER_ID);
1301  }

◆ getOriginalPrice()

getOriginalPrice ( )

Redeclare getter for back compatibility

Returns
float|null

Implements OrderItemInterface.

Definition at line 449 of file Item.php.

450  {
451  $price = $this->getData(OrderItemInterface::ORIGINAL_PRICE);
452  if ($price === null) {
453  return $this->getPrice();
454  }
455  return $price;
456  }
$price
$price
Definition: product_alert.php:10

◆ getParentItem()

getParentItem ( )

Get parent item

Returns
OrderItemInterface|null

Implements OrderItemInterface.

Definition at line 179 of file Item.php.

180  {
181  return $this->getData(OrderItemInterface::PARENT_ITEM);
182  }

◆ getParentItemId()

getParentItemId ( )

Return parent_item_id

Returns
int|null

Implements OrderItemInterface.

Definition at line 1308 of file Item.php.

1309  {
1310  return $this->getData(OrderItemInterface::PARENT_ITEM_ID);
1311  }

◆ getPrice()

getPrice ( )

Return price

Returns
float|null

Implements OrderItemInterface.

Definition at line 1318 of file Item.php.

1319  {
1320  return $this->getData(OrderItemInterface::PRICE);
1321  }

◆ getPriceInclTax()

getPriceInclTax ( )

Return price_incl_tax

Returns
float|null

Implements OrderItemInterface.

Definition at line 1328 of file Item.php.

1329  {
1330  return $this->getData(OrderItemInterface::PRICE_INCL_TAX);
1331  }

◆ getProduct()

getProduct ( )

Retrieve product

Returns
\Magento\Catalog\Model\Product|null

Definition at line 676 of file Item.php.

677  {
678  if (!$this->hasData('product')) {
679  try {
680  $product = $this->productRepository->getById($this->getProductId());
681  } catch (\Magento\Framework\Exception\NoSuchEntityException $noEntityException) {
682  $product = null;
683  }
684  $this->setProduct($product);
685  }
686  return $this->getData('product');
687  }
$product
$product
Definition: bundle_product_with_not_visible_children.php:22

◆ getProductId()

getProductId ( )

Return product_id

Returns
int|null

Implements OrderItemInterface.

Definition at line 1338 of file Item.php.

1339  {
1340  return $this->getData(OrderItemInterface::PRODUCT_ID);
1341  }

◆ getProductOption()

getProductOption ( )

Returns product option

Returns
\Magento\Catalog\Api\Data\ProductOptionInterface|null

Implements OrderItemInterface.

Definition at line 2360 of file Item.php.

2361  {
2362  return $this->getData(self::KEY_PRODUCT_OPTION);
2363  }

◆ getProductOptionByCode()

getProductOptionByCode (   $code = null)

Get product options array by code.

If code is null return all options

Parameters
string$code
Returns
array

Definition at line 492 of file Item.php.

493  {
494  $options = $this->getProductOptions();
495  if ($code === null) {
496  return $options;
497  }
498  if (isset($options[$code])) {
499  return $options[$code];
500  }
501  return null;
502  }
$options
$options
Definition: multiple_mixed_products.php:29
$code
$code
Definition: info.phtml:12

◆ getProductOptions()

getProductOptions ( )

Get product options array

Returns
array

Definition at line 475 of file Item.php.

476  {
477  $data = $this->_getData('product_options');
478  if (is_string($data)) {
479  $data = $this->serializer->unserialize($data);
480  }
481  return $data;
482  }
$data
$data
Definition: attribute_set_with_image_attribute.php:16

◆ getProductType()

getProductType ( )

Return product_type

Returns
string|null

Implements OrderItemInterface.

Definition at line 1348 of file Item.php.

1349  {
1350  return $this->getData(OrderItemInterface::PRODUCT_TYPE);
1351  }

◆ getQtyBackordered()

getQtyBackordered ( )

Return qty_backordered

Returns
float|null

Implements OrderItemInterface.

Definition at line 1358 of file Item.php.

1359  {
1360  return $this->getData(OrderItemInterface::QTY_BACKORDERED);
1361  }

◆ getQtyCanceled()

getQtyCanceled ( )

Return qty_canceled

Returns
float|null

Implements OrderItemInterface.

Definition at line 1368 of file Item.php.

1369  {
1370  return $this->getData(OrderItemInterface::QTY_CANCELED);
1371  }

◆ getQtyInvoiced()

getQtyInvoiced ( )

Return qty_invoiced

Returns
float|null

Implements OrderItemInterface.

Definition at line 1378 of file Item.php.

1379  {
1380  return $this->getData(OrderItemInterface::QTY_INVOICED);
1381  }

◆ getQtyOrdered()

getQtyOrdered ( )

Return qty_ordered

Returns
float|null

Implements OrderItemInterface.

Definition at line 1388 of file Item.php.

1389  {
1390  return $this->getData(OrderItemInterface::QTY_ORDERED);
1391  }

◆ getQtyRefunded()

getQtyRefunded ( )

Return qty_refunded

Returns
float|null

Implements OrderItemInterface.

Definition at line 1398 of file Item.php.

1399  {
1400  return $this->getData(OrderItemInterface::QTY_REFUNDED);
1401  }

◆ getQtyReturned()

getQtyReturned ( )

Return qty_returned

Returns
float|null

Implements OrderItemInterface.

Definition at line 1408 of file Item.php.

1409  {
1410  return $this->getData(OrderItemInterface::QTY_RETURNED);
1411  }

◆ getQtyShipped()

getQtyShipped ( )

Return qty_shipped

Returns
float|null

Implements OrderItemInterface.

Definition at line 1418 of file Item.php.

1419  {
1420  return $this->getData(OrderItemInterface::QTY_SHIPPED);
1421  }

◆ getQtyToCancel()

getQtyToCancel ( )

Retrieve item qty available for cancel

Returns
float|integer

Definition at line 273 of file Item.php.

274  {
275  $qtyToCancel = min($this->getQtyToInvoice(), $this->getQtyToShip());
276  return max($qtyToCancel, 0);
277  }

◆ getQtyToInvoice()

getQtyToInvoice ( )

Retrieve item qty available for invoice

Returns
float|integer

Definition at line 244 of file Item.php.

245  {
246  if ($this->isDummy()) {
247  return 0;
248  }
249 
250  $qty = $this->getQtyOrdered() - $this->getQtyInvoiced() - $this->getQtyCanceled();
251  return max(round($qty, 8), 0);
252  }
Magento\Sales\Model\Order\Item\isDummy
isDummy($shipment=false)
Definition: Item.php:615

◆ getQtyToRefund()

getQtyToRefund ( )

Retrieve item qty available for refund

Returns
float|integer

Definition at line 259 of file Item.php.

260  {
261  if ($this->isDummy()) {
262  return 0;
263  }
264 
265  return max($this->getQtyInvoiced() - $this->getQtyRefunded(), 0);
266  }
Magento\Sales\Model\Order\Item\isDummy
isDummy($shipment=false)
Definition: Item.php:615

◆ getQtyToShip()

getQtyToShip ( )

Retrieve item qty available for ship

Returns
float|integer

Definition at line 219 of file Item.php.

220  {
221  if ($this->isDummy(true)) {
222  return 0;
223  }
224 
225  return $this->getSimpleQtyToShip();
226  }
Magento\Sales\Model\Order\Item\isDummy
isDummy($shipment=false)
Definition: Item.php:615

◆ getQuoteItemId()

getQuoteItemId ( )

Return quote_item_id

Returns
int|null

Implements OrderItemInterface.

Definition at line 1428 of file Item.php.

1429  {
1430  return $this->getData(OrderItemInterface::QUOTE_ITEM_ID);
1431  }

◆ getRealProductType()

getRealProductType ( )

Return real product type of item or NULL if item is not composite

Returns
string | null

Definition at line 509 of file Item.php.

510  {
511  $productType = $this->getProductOptionByCode('real_product_type');
512  if ($productType) {
513  return $productType;
514  }
515  return null;
516  }
Magento\Sales\Model\Order\Item\getProductOptionByCode
getProductOptionByCode($code=null)
Definition: Item.php:492

◆ getRowInvoiced()

getRowInvoiced ( )

Return row_invoiced

Returns
float|null

Implements OrderItemInterface.

Definition at line 1438 of file Item.php.

1439  {
1440  return $this->getData(OrderItemInterface::ROW_INVOICED);
1441  }

◆ getRowTotal()

getRowTotal ( )

Return row_total

Returns
float|null

Implements OrderItemInterface.

Definition at line 1448 of file Item.php.

1449  {
1450  return $this->getData(OrderItemInterface::ROW_TOTAL);
1451  }

◆ getRowTotalInclTax()

getRowTotalInclTax ( )

Return row_total_incl_tax

Returns
float|null

Implements OrderItemInterface.

Definition at line 1458 of file Item.php.

1459  {
1460  return $this->getData(OrderItemInterface::ROW_TOTAL_INCL_TAX);
1461  }

◆ getRowWeight()

getRowWeight ( )

Return row_weight

Returns
float|null

Implements OrderItemInterface.

Definition at line 1468 of file Item.php.

1469  {
1470  return $this->getData(OrderItemInterface::ROW_WEIGHT);
1471  }

◆ getSimpleQtyToShip()

getSimpleQtyToShip ( )

Retrieve item qty available for ship

Returns
float|integer

Definition at line 233 of file Item.php.

234  {
235  $qty = $this->getQtyOrdered() - $this->getQtyShipped() - $this->getQtyRefunded() - $this->getQtyCanceled();
236  return max(round($qty, 8), 0);
237  }

◆ getSku()

getSku ( )

Return sku

Returns
string

Implements OrderItemInterface.

Definition at line 1478 of file Item.php.

1479  {
1480  return $this->getData(OrderItemInterface::SKU);
1481  }

◆ getStatus()

getStatus ( )

Retrieve status

Returns
string

Definition at line 378 of file Item.php.

379  {
380  return $this->getStatusName($this->getStatusId());
381  }
Magento\Sales\Model\Order\Item\getStatusName
static getStatusName($statusId)
Definition: Item.php:389

◆ getStatuses()

static getStatuses ( )
static

Retrieve order item statuses array

Returns
array

Definition at line 426 of file Item.php.

427  {
428  if (self::$_statuses === null) {
429  self::$_statuses = [
430  self::STATUS_PENDING => __('Ordered'),
431  self::STATUS_SHIPPED => __('Shipped'),
432  self::STATUS_INVOICED => __('Invoiced'),
433  self::STATUS_BACKORDERED => __('Backordered'),
434  self::STATUS_RETURNED => __('Returned'),
435  self::STATUS_REFUNDED => __('Refunded'),
436  self::STATUS_CANCELED => __('Canceled'),
437  self::STATUS_PARTIAL => __('Partial'),
438  self::STATUS_MIXED => __('Mixed'),
439  ];
440  }
441  return self::$_statuses;
442  }
__
__()
Definition: __.php:13

◆ getStatusId()

getStatusId ( )

Retrieve item status identifier

Returns
int @SuppressWarnings(PHPMD.CyclomaticComplexity) @SuppressWarnings(PHPMD.NPathComplexity)

Definition at line 314 of file Item.php.

315  {
316  $backordered = (double)$this->getQtyBackordered();
317  if (!$backordered && $this->getHasChildren()) {
318  $backordered = (double)$this->_getQtyChildrenBackordered();
319  }
320  $canceled = (double)$this->getQtyCanceled();
321  $invoiced = (double)$this->getQtyInvoiced();
322  $ordered = (double)$this->getQtyOrdered();
323  $refunded = (double)$this->getQtyRefunded();
324  $shipped = (double)$this->getQtyShipped();
325 
326  $actuallyOrdered = $ordered - $canceled - $refunded;
327 
328  if (!$invoiced && !$shipped && !$refunded && !$canceled && !$backordered) {
329  return self::STATUS_PENDING;
330  }
331  if ($shipped && $invoiced && $actuallyOrdered == $shipped) {
332  return self::STATUS_SHIPPED;
333  }
334 
335  if ($invoiced && !$shipped && $actuallyOrdered == $invoiced) {
336  return self::STATUS_INVOICED;
337  }
338 
339  if ($backordered && $actuallyOrdered == $backordered) {
340  return self::STATUS_BACKORDERED;
341  }
342 
343  if ($refunded && $ordered == $refunded) {
344  return self::STATUS_REFUNDED;
345  }
346 
347  if ($canceled && $ordered == $canceled) {
348  return self::STATUS_CANCELED;
349  }
350 
351  if (max($shipped, $invoiced) < $actuallyOrdered) {
352  return self::STATUS_PARTIAL;
353  }
354 
355  return self::STATUS_MIXED;
356  }

◆ getStatusName()

static getStatusName (   $statusId)
static

Retrieve status name

Parameters
string$statusId
Returns
\Magento\Framework\Phrase

Definition at line 389 of file Item.php.

390  {
391  if (self::$_statuses === null) {
392  self::getStatuses();
393  }
394  if (isset(self::$_statuses[$statusId])) {
395  return self::$_statuses[$statusId];
396  }
397  return __('Unknown Status');
398  }
__
__()
Definition: __.php:13

◆ getStore()

getStore ( )

Retrieve store model instance

Returns
\Magento\Store\Model\Store

Definition at line 694 of file Item.php.

695  {
696  $storeId = $this->getStoreId();
697  if ($storeId) {
698  return $this->_storeManager->getStore($storeId);
699  }
700  return $this->_storeManager->getStore();
701  }
$storeId
$storeId
Definition: customer_review_with_rating.php:14

◆ getStoreId()

getStoreId ( )

Return store_id

Returns
int|null

Implements OrderItemInterface.

Definition at line 1488 of file Item.php.

1489  {
1490  return $this->getData(OrderItemInterface::STORE_ID);
1491  }

◆ getTaxAmount()

getTaxAmount ( )

Return tax_amount

Returns
float|null

Implements OrderItemInterface.

Definition at line 1498 of file Item.php.

1499  {
1500  return $this->getData(OrderItemInterface::TAX_AMOUNT);
1501  }

◆ getTaxBeforeDiscount()

getTaxBeforeDiscount ( )

Return tax_before_discount

Returns
float|null

Implements OrderItemInterface.

Definition at line 1508 of file Item.php.

1509  {
1510  return $this->getData(OrderItemInterface::TAX_BEFORE_DISCOUNT);
1511  }

◆ getTaxCanceled()

getTaxCanceled ( )

Return tax_canceled

Returns
float|null

Implements OrderItemInterface.

Definition at line 1518 of file Item.php.

1519  {
1520  return $this->getData(OrderItemInterface::TAX_CANCELED);
1521  }

◆ getTaxInvoiced()

getTaxInvoiced ( )

Return tax_invoiced

Returns
float|null

Implements OrderItemInterface.

Definition at line 1528 of file Item.php.

1529  {
1530  return $this->getData(OrderItemInterface::TAX_INVOICED);
1531  }

◆ getTaxPercent()

getTaxPercent ( )

Return tax_percent

Returns
float|null

Implements OrderItemInterface.

Definition at line 1538 of file Item.php.

1539  {
1540  return $this->getData(OrderItemInterface::TAX_PERCENT);
1541  }

◆ getTaxRefunded()

getTaxRefunded ( )

Return tax_refunded

Returns
float|null

Implements OrderItemInterface.

Definition at line 1548 of file Item.php.

1549  {
1550  return $this->getData(OrderItemInterface::TAX_REFUNDED);
1551  }

◆ getUpdatedAt()

getUpdatedAt ( )

Return updated_at

Returns
string|null

Implements OrderItemInterface.

Definition at line 1558 of file Item.php.

1559  {
1560  return $this->getData(OrderItemInterface::UPDATED_AT);
1561  }

◆ getWeeeTaxApplied()

getWeeeTaxApplied ( )

Return weee_tax_applied

Returns
string|null

Implements OrderItemInterface.

Definition at line 1568 of file Item.php.

1569  {
1570  return $this->getData(OrderItemInterface::WEEE_TAX_APPLIED);
1571  }

◆ getWeeeTaxAppliedAmount()

getWeeeTaxAppliedAmount ( )

Return weee_tax_applied_amount

Returns
float|null

Implements OrderItemInterface.

Definition at line 1578 of file Item.php.

1579  {
1580  return $this->getData(OrderItemInterface::WEEE_TAX_APPLIED_AMOUNT);
1581  }

◆ getWeeeTaxAppliedRowAmount()

getWeeeTaxAppliedRowAmount ( )

Return weee_tax_applied_row_amount

Returns
float|null

Implements OrderItemInterface.

Definition at line 1588 of file Item.php.

1589  {
1590  return $this->getData(OrderItemInterface::WEEE_TAX_APPLIED_ROW_AMOUNT);
1591  }

◆ getWeeeTaxDisposition()

getWeeeTaxDisposition ( )

Return weee_tax_disposition

Returns
float|null

Implements OrderItemInterface.

Definition at line 1598 of file Item.php.

1599  {
1600  return $this->getData(OrderItemInterface::WEEE_TAX_DISPOSITION);
1601  }

◆ getWeeeTaxRowDisposition()

getWeeeTaxRowDisposition ( )

Return weee_tax_row_disposition

Returns
float|null

Implements OrderItemInterface.

Definition at line 1608 of file Item.php.

1609  {
1610  return $this->getData(OrderItemInterface::WEEE_TAX_ROW_DISPOSITION);
1611  }

◆ getWeight()

getWeight ( )

Return weight

Returns
float|null

Implements OrderItemInterface.

Definition at line 1618 of file Item.php.

1619  {
1620  return $this->getData(OrderItemInterface::WEIGHT);
1621  }

◆ isChildrenCalculated()

isChildrenCalculated ( )

Return checking of what calculation type was for this product

Returns
bool

Definition at line 548 of file Item.php.

549  {
550  $parentItem = $this->getParentItem();
551  if ($parentItem) {
552  $options = $parentItem->getProductOptions();
553  } else {
554  $options = $this->getProductOptions();
555  }
556 
557  if (isset(
558  $options['product_calculations']
559  ) && $options['product_calculations'] == \Magento\Catalog\Model\Product\Type\AbstractType::CALCULATE_CHILD
560  ) {
561  return true;
562  }
563  return false;
564  }
$options
$options
Definition: multiple_mixed_products.php:29

◆ isDummy()

isDummy (   $shipment = false)

This is Dummy item or not.

If $shipment is true then we checking this for shipping situation if not, we checking this for calculation.

Parameters
bool$shipment
Returns
bool @SuppressWarnings(PHPMD.CyclomaticComplexity)

Definition at line 615 of file Item.php.

616  {
617  if ($shipment) {
618  if ($this->getHasChildren() && $this->isShipSeparately()) {
619  return true;
620  }
621 
622  if ($this->getHasChildren() && !$this->isShipSeparately()) {
623  return false;
624  }
625 
626  if ($this->getParentItem() && $this->isShipSeparately()) {
627  return false;
628  }
629 
630  if ($this->getParentItem() && !$this->isShipSeparately()) {
631  return true;
632  }
633  } else {
634  if ($this->getHasChildren() && $this->isChildrenCalculated()) {
635  return true;
636  }
637 
638  if ($this->getHasChildren() && !$this->isChildrenCalculated()) {
639  return false;
640  }
641 
642  if ($this->getParentItem() && $this->isChildrenCalculated()) {
643  return false;
644  }
645 
646  if ($this->getParentItem() && !$this->isChildrenCalculated()) {
647  return true;
648  }
649  }
650  return false;
651  }
$shipment
foreach($order->getItems() as $orderItem) $shipment
Definition: order_with_shipping_and_invoice.php:46

◆ isProcessingAvailable()

isProcessingAvailable ( )

Check if it is possible to process item after cancellation

Returns
bool
Since
101.0.0

Definition at line 2402 of file Item.php.

2403  {
2404  return $this->getQtyToShip() > $this->getQtyToCancel();
2405  }

◆ isShipSeparately()

isShipSeparately ( )

Return checking of what shipment type was for this product

Returns
bool

Definition at line 588 of file Item.php.

589  {
590  $parentItem = $this->getParentItem();
591  if ($parentItem) {
592  $options = $parentItem->getProductOptions();
593  } else {
594  $options = $this->getProductOptions();
595  }
596 
597  if (isset(
598  $options['shipment_type']
599  ) && $options['shipment_type'] == \Magento\Catalog\Model\Product\Type\AbstractType::SHIPMENT_SEPARATELY
600  ) {
601  return true;
602  }
603  return false;
604  }
$options
$options
Definition: multiple_mixed_products.php:29

◆ setAdditionalData()

setAdditionalData (   $additionalData)

Sets the additional data for the order item.

Parameters
string$additionalData
Returns
$this

Implements OrderItemInterface.

Definition at line 1738 of file Item.php.

1739  {
1740  return $this->setData(OrderItemInterface::ADDITIONAL_DATA, $additionalData);
1741  }

◆ setAmountRefunded()

setAmountRefunded (   $amountRefunded)

Sets the amount refunded for the order item.

Parameters
float$amountRefunded
Returns
$this

Implements OrderItemInterface.

Definition at line 1930 of file Item.php.

1931  {
1932  return $this->setData(OrderItemInterface::AMOUNT_REFUNDED, $amountRefunded);
1933  }

◆ setAppliedRuleIds()

setAppliedRuleIds (   $appliedRuleIds)

Sets the applied rule IDs for the order item.

Parameters
string$appliedRuleIds
Returns
$this

Implements OrderItemInterface.

Definition at line 1730 of file Item.php.

1731  {
1732  return $this->setData(OrderItemInterface::APPLIED_RULE_IDS, $appliedRuleIds);
1733  }

◆ setBaseAmountRefunded()

setBaseAmountRefunded (   $baseAmountRefunded)

Sets the base amount refunded for the order item.

Parameters
float$baseAmountRefunded
Returns
$this

Implements OrderItemInterface.

Definition at line 1938 of file Item.php.

1939  {
1940  return $this->setData(OrderItemInterface::BASE_AMOUNT_REFUNDED, $baseAmountRefunded);
1941  }

◆ setBaseCost()

setBaseCost (   $baseCost)

Sets the base cost for the order item.

Parameters
float$baseCost
Returns
$this

Implements OrderItemInterface.

Definition at line 1810 of file Item.php.

1811  {
1812  return $this->setData(OrderItemInterface::BASE_COST, $baseCost);
1813  }

◆ setBaseDiscountAmount()

setBaseDiscountAmount (   $amount)

Sets the base discount amount for the order item.

Parameters
float$amount
Returns
$this

Implements OrderItemInterface.

Definition at line 1906 of file Item.php.

1907  {
1908  return $this->setData(OrderItemInterface::BASE_DISCOUNT_AMOUNT, $amount);
1909  }
$amount
$amount
Definition: order.php:14

◆ setBaseDiscountInvoiced()

setBaseDiscountInvoiced (   $baseDiscountInvoiced)

Sets the base discount invoiced for the order item.

Parameters
float$baseDiscountInvoiced
Returns
$this

Implements OrderItemInterface.

Definition at line 1922 of file Item.php.

1923  {
1924  return $this->setData(OrderItemInterface::BASE_DISCOUNT_INVOICED, $baseDiscountInvoiced);
1925  }

◆ setBaseDiscountRefunded()

setBaseDiscountRefunded (   $baseDiscountRefunded)

Sets the base discount refunded for the order item.

Parameters
float$baseDiscountRefunded
Returns
$this

Implements OrderItemInterface.

Definition at line 2152 of file Item.php.

2153  {
2154  return $this->setData(OrderItemInterface::BASE_DISCOUNT_REFUNDED, $baseDiscountRefunded);
2155  }

◆ setBaseDiscountTaxCompensationAmount()

setBaseDiscountTaxCompensationAmount (   $amount)

Sets the base discount tax compensation amount for the order item.

Parameters
float$amount
Returns
$this

Implements OrderItemInterface.

Definition at line 2066 of file Item.php.

2067  {
2068  return $this->setData(OrderItemInterface::BASE_DISCOUNT_TAX_COMPENSATION_AMOUNT, $amount);
2069  }
$amount
$amount
Definition: order.php:14

◆ setBaseDiscountTaxCompensationInvoiced()

setBaseDiscountTaxCompensationInvoiced (   $baseDiscountTaxCompensationInvoiced)

Sets the base discount tax compensation invoiced for the order item.

Parameters
float$baseDiscountTaxCompensationInvoiced
Returns
$this

Implements OrderItemInterface.

Definition at line 2082 of file Item.php.

2083  {
2084  return $this->setData(
2085  OrderItemInterface::BASE_DISCOUNT_TAX_COMPENSATION_INVOICED,
2086  $baseDiscountTaxCompensationInvoiced
2087  );
2088  }

◆ setBaseDiscountTaxCompensationRefunded()

setBaseDiscountTaxCompensationRefunded (   $baseDiscountTaxCompensationRefunded)

Sets the base discount tax compensation refunded for the order item.

Parameters
float$baseDiscountTaxCompensationRefunded
Returns
$this

Implements OrderItemInterface.

Definition at line 2101 of file Item.php.

2102  {
2103  return $this->setData(
2104  OrderItemInterface::BASE_DISCOUNT_TAX_COMPENSATION_REFUNDED,
2105  $baseDiscountTaxCompensationRefunded
2106  );
2107  }

◆ setBaseOriginalPrice()

setBaseOriginalPrice (   $price)

Sets the base original price for the order item.

Parameters
float$price
Returns
$this

Implements OrderItemInterface.

Definition at line 1842 of file Item.php.

1843  {
1844  return $this->setData(OrderItemInterface::BASE_ORIGINAL_PRICE, $price);
1845  }
$price
$price
Definition: product_alert.php:10

◆ setBasePrice()

setBasePrice (   $price)

Sets the base price for the order item.

Parameters
float$price
Returns
$this

Implements OrderItemInterface.

Definition at line 1826 of file Item.php.

1827  {
1828  return $this->setData(OrderItemInterface::BASE_PRICE, $price);
1829  }
$price
$price
Definition: product_alert.php:10

◆ setBasePriceInclTax()

setBasePriceInclTax (   $amount)

Sets the base price including tax for the order item.

Parameters
float$amount
Returns
$this

Implements OrderItemInterface.

Definition at line 2034 of file Item.php.

2035  {
2036  return $this->setData(OrderItemInterface::BASE_PRICE_INCL_TAX, $amount);
2037  }
$amount
$amount
Definition: order.php:14

◆ setBaseRowInvoiced()

setBaseRowInvoiced (   $baseRowInvoiced)

Sets the base row invoiced for the order item.

Parameters
float$baseRowInvoiced
Returns
$this

Implements OrderItemInterface.

Definition at line 1970 of file Item.php.

1971  {
1972  return $this->setData(OrderItemInterface::BASE_ROW_INVOICED, $baseRowInvoiced);
1973  }

◆ setBaseRowTotal()

setBaseRowTotal (   $amount)

Sets the base row total for the order item.

Parameters
float$amount
Returns
$this

Implements OrderItemInterface.

Definition at line 1954 of file Item.php.

1955  {
1956  return $this->setData(OrderItemInterface::BASE_ROW_TOTAL, $amount);
1957  }
$amount
$amount
Definition: order.php:14

◆ setBaseRowTotalInclTax()

setBaseRowTotalInclTax (   $amount)

Sets the base row total including tax for the order item.

Parameters
float$amount
Returns
$this

Implements OrderItemInterface.

Definition at line 2050 of file Item.php.

2051  {
2052  return $this->setData(OrderItemInterface::BASE_ROW_TOTAL_INCL_TAX, $amount);
2053  }
$amount
$amount
Definition: order.php:14

◆ setBaseTaxAmount()

setBaseTaxAmount (   $amount)

Sets the base tax amount for the order item.

Parameters
float$amount
Returns
$this

Implements OrderItemInterface.

Definition at line 1866 of file Item.php.

1867  {
1868  return $this->setData(OrderItemInterface::BASE_TAX_AMOUNT, $amount);
1869  }
$amount
$amount
Definition: order.php:14

◆ setBaseTaxBeforeDiscount()

setBaseTaxBeforeDiscount (   $baseTaxBeforeDiscount)

Sets the base tax before discount for the order item.

Parameters
float$baseTaxBeforeDiscount
Returns
$this

Implements OrderItemInterface.

Definition at line 1986 of file Item.php.

1987  {
1988  return $this->setData(OrderItemInterface::BASE_TAX_BEFORE_DISCOUNT, $baseTaxBeforeDiscount);
1989  }

◆ setBaseTaxInvoiced()

setBaseTaxInvoiced (   $baseTaxInvoiced)

Sets the base tax invoiced for the order item.

Parameters
float$baseTaxInvoiced
Returns
$this

Implements OrderItemInterface.

Definition at line 1882 of file Item.php.

1883  {
1884  return $this->setData(OrderItemInterface::BASE_TAX_INVOICED, $baseTaxInvoiced);
1885  }

◆ setBaseTaxRefunded()

setBaseTaxRefunded (   $baseTaxRefunded)

Sets the base tax refunded for the order item.

Parameters
float$baseTaxRefunded
Returns
$this

Implements OrderItemInterface.

Definition at line 2136 of file Item.php.

2137  {
2138  return $this->setData(OrderItemInterface::BASE_TAX_REFUNDED, $baseTaxRefunded);
2139  }

◆ setBaseWeeeTaxAppliedAmount()

setBaseWeeeTaxAppliedAmount (   $amount)

Sets the base WEEE tax applied amount for the order item.

Parameters
float$amount
Returns
$this

Implements OrderItemInterface.

Definition at line 2288 of file Item.php.

2289  {
2290  return $this->setData(OrderItemInterface::BASE_WEEE_TAX_APPLIED_AMOUNT, $amount);
2291  }
$amount
$amount
Definition: order.php:14

◆ setBaseWeeeTaxAppliedRowAmnt()

setBaseWeeeTaxAppliedRowAmnt (   $amnt)

Sets the base WEEE tax applied row amount for the order item.

Parameters
float$amnt
Returns
$this

Implements OrderItemInterface.

Definition at line 2296 of file Item.php.

2297  {
2298  return $this->setData(OrderItemInterface::BASE_WEEE_TAX_APPLIED_ROW_AMNT, $amnt);
2299  }

◆ setBaseWeeeTaxDisposition()

setBaseWeeeTaxDisposition (   $baseWeeeTaxDisposition)

Sets the base WEEE tax disposition for the order item.

Parameters
float$baseWeeeTaxDisposition
Returns
$this

Implements OrderItemInterface.

Definition at line 2344 of file Item.php.

2345  {
2346  return $this->setData(OrderItemInterface::BASE_WEEE_TAX_DISPOSITION, $baseWeeeTaxDisposition);
2347  }

◆ setBaseWeeeTaxRowDisposition()

setBaseWeeeTaxRowDisposition (   $baseWeeeTaxRowDisposition)

Sets the base WEEE tax row disposition for the order item.

Parameters
float$baseWeeeTaxRowDisposition
Returns
$this

Implements OrderItemInterface.

Definition at line 2352 of file Item.php.

2353  {
2354  return $this->setData(OrderItemInterface::BASE_WEEE_TAX_ROW_DISPOSITION, $baseWeeeTaxRowDisposition);
2355  }

◆ setCreatedAt()

setCreatedAt (   $createdAt)

Sets the created-at timestamp for the order item.

Parameters
string$createdAttimestamp
Returns
$this

Implements OrderItemInterface.

Definition at line 968 of file Item.php.

969  {
970  return $this->setData(OrderItemInterface::CREATED_AT, $createdAt);
971  }

◆ setDescription()

setDescription (   $description)

Sets the description for the order item.

Parameters
string$description
Returns
$this

Implements OrderItemInterface.

Definition at line 1722 of file Item.php.

1723  {
1724  return $this->setData(OrderItemInterface::DESCRIPTION, $description);
1725  }
$description
$description
Definition: pre_composer_update_2.3.php:162

◆ setDiscountAmount()

setDiscountAmount (   $amount)

Sets the discount amount for the order item.

Parameters
float$amount
Returns
$this

Implements OrderItemInterface.

Definition at line 1898 of file Item.php.

1899  {
1900  return $this->setData(OrderItemInterface::DISCOUNT_AMOUNT, $amount);
1901  }
$amount
$amount
Definition: order.php:14

◆ setDiscountInvoiced()

setDiscountInvoiced (   $discountInvoiced)

Sets the discount invoiced for the order item.

Parameters
float$discountInvoiced
Returns
$this

Implements OrderItemInterface.

Definition at line 1914 of file Item.php.

1915  {
1916  return $this->setData(OrderItemInterface::DISCOUNT_INVOICED, $discountInvoiced);
1917  }

◆ setDiscountPercent()

setDiscountPercent (   $discountPercent)

Sets the discount percent for the order item.

Parameters
float$discountPercent
Returns
$this

Implements OrderItemInterface.

Definition at line 1890 of file Item.php.

1891  {
1892  return $this->setData(OrderItemInterface::DISCOUNT_PERCENT, $discountPercent);
1893  }

◆ setDiscountRefunded()

setDiscountRefunded (   $discountRefunded)

Sets the discount refunded for the order item.

Parameters
float$discountRefunded
Returns
$this

Implements OrderItemInterface.

Definition at line 2144 of file Item.php.

2145  {
2146  return $this->setData(OrderItemInterface::DISCOUNT_REFUNDED, $discountRefunded);
2147  }

◆ setDiscountTaxCompensationAmount()

setDiscountTaxCompensationAmount (   $amount)

Sets the discount tax compensation amount for the order item.

Parameters
float$amount
Returns
$this

Implements OrderItemInterface.

Definition at line 2058 of file Item.php.

2059  {
2060  return $this->setData(OrderItemInterface::DISCOUNT_TAX_COMPENSATION_AMOUNT, $amount);
2061  }
$amount
$amount
Definition: order.php:14

◆ setDiscountTaxCompensationCanceled()

setDiscountTaxCompensationCanceled (   $discountTaxCompensationCanceled)

Sets the discount tax compensation canceled for the order item.

Parameters
float$discountTaxCompensationCanceled
Returns
$this

Implements OrderItemInterface.

Definition at line 2120 of file Item.php.

2121  {
2122  return $this->setData(OrderItemInterface::DISCOUNT_TAX_COMPENSATION_CANCELED, $discountTaxCompensationCanceled);
2123  }

◆ setDiscountTaxCompensationInvoiced()

setDiscountTaxCompensationInvoiced (   $discountTaxCompensationInvoiced)

Sets the discount tax compensation invoiced for the order item.

Parameters
float$discountTaxCompensationInvoiced
Returns
$this

Implements OrderItemInterface.

Definition at line 2074 of file Item.php.

2075  {
2076  return $this->setData(OrderItemInterface::DISCOUNT_TAX_COMPENSATION_INVOICED, $discountTaxCompensationInvoiced);
2077  }

◆ setDiscountTaxCompensationRefunded()

setDiscountTaxCompensationRefunded (   $discountTaxCompensationRefunded)

Sets the discount tax compensation refunded for the order item.

Parameters
float$discountTaxCompensationRefunded
Returns
$this

Implements OrderItemInterface.

Definition at line 2093 of file Item.php.

2094  {
2095  return $this->setData(OrderItemInterface::DISCOUNT_TAX_COMPENSATION_REFUNDED, $discountTaxCompensationRefunded);
2096  }

◆ setEventId()

setEventId (   $id)

Sets the event ID for the order item.

Parameters
int$id
Returns
$this

Implements OrderItemInterface.

Definition at line 2280 of file Item.php.

2281  {
2282  return $this->setData(OrderItemInterface::EVENT_ID, $id);
2283  }
$id
$id
Definition: fieldset.phtml:14

◆ setExtensionAttributes()

setExtensionAttributes ( \Magento\Sales\Api\Data\OrderItemExtensionInterface  $extensionAttributes)
Parameters
\Magento\Sales\Api\Data\OrderItemExtensionInterface$extensionAttributes
Returns
$this

Definition at line 2389 of file Item.php.

2390  {
2391  return $this->_setExtensionAttributes($extensionAttributes);
2392  }
Magento\Framework\Model\AbstractExtensibleModel\_setExtensionAttributes
_setExtensionAttributes(\Magento\Framework\Api\ExtensionAttributesInterface $extensionAttributes)
Definition: AbstractExtensibleModel.php:329

◆ setExtOrderItemId()

setExtOrderItemId (   $id)

Sets the external order item ID for the order item.

Parameters
string$id
Returns
$this

Implements OrderItemInterface.

Definition at line 2002 of file Item.php.

2003  {
2004  return $this->setData(OrderItemInterface::EXT_ORDER_ITEM_ID, $id);
2005  }
$id
$id
Definition: fieldset.phtml:14

◆ setFreeShipping()

setFreeShipping (   $freeShipping)

Sets the free-shipping flag value for the order item.

Parameters
int$freeShipping
Returns
$this

Implements OrderItemInterface.

Definition at line 2264 of file Item.php.

2265  {
2266  return $this->setData(OrderItemInterface::FREE_SHIPPING, $freeShipping);
2267  }

◆ setGwBasePrice()

setGwBasePrice (   $price)

Sets the GW base price for the order item.

Parameters
float$price
Returns
$this

Implements OrderItemInterface.

Definition at line 2168 of file Item.php.

2169  {
2170  return $this->setData(OrderItemInterface::GW_BASE_PRICE, $price);
2171  }
$price
$price
Definition: product_alert.php:10

◆ setGwBasePriceInvoiced()

setGwBasePriceInvoiced (   $gwBasePriceInvoiced)

Sets the GW base price invoiced for the order item.

Parameters
float$gwBasePriceInvoiced
Returns
$this

Implements OrderItemInterface.

Definition at line 2200 of file Item.php.

2201  {
2202  return $this->setData(OrderItemInterface::GW_BASE_PRICE_INVOICED, $gwBasePriceInvoiced);
2203  }

◆ setGwBasePriceRefunded()

setGwBasePriceRefunded (   $gwBasePriceRefunded)

Sets the GW base price refunded for the order item.

Parameters
float$gwBasePriceRefunded
Returns
$this

Implements OrderItemInterface.

Definition at line 2232 of file Item.php.

2233  {
2234  return $this->setData(OrderItemInterface::GW_BASE_PRICE_REFUNDED, $gwBasePriceRefunded);
2235  }

◆ setGwBaseTaxAmount()

setGwBaseTaxAmount (   $amount)

Sets the GW base tax amount for the order item.

Parameters
float$amount
Returns
$this

Implements OrderItemInterface.

Definition at line 2184 of file Item.php.

2185  {
2186  return $this->setData(OrderItemInterface::GW_BASE_TAX_AMOUNT, $amount);
2187  }
$amount
$amount
Definition: order.php:14

◆ setGwBaseTaxAmountInvoiced()

setGwBaseTaxAmountInvoiced (   $gwBaseTaxAmountInvoiced)

Sets the GW base tax amount invoiced for the order item.

Parameters
float$gwBaseTaxAmountInvoiced
Returns
$this

Implements OrderItemInterface.

Definition at line 2216 of file Item.php.

2217  {
2218  return $this->setData(OrderItemInterface::GW_BASE_TAX_AMOUNT_INVOICED, $gwBaseTaxAmountInvoiced);
2219  }

◆ setGwBaseTaxAmountRefunded()

setGwBaseTaxAmountRefunded (   $gwBaseTaxAmountRefunded)

Sets the GW base tax amount refunded for the order item.

Parameters
float$gwBaseTaxAmountRefunded
Returns
$this

Implements OrderItemInterface.

Definition at line 2248 of file Item.php.

2249  {
2250  return $this->setData(OrderItemInterface::GW_BASE_TAX_AMOUNT_REFUNDED, $gwBaseTaxAmountRefunded);
2251  }

◆ setGwId()

setGwId (   $id)

Sets the GW ID for the order item.

Parameters
int$id
Returns
$this

Implements OrderItemInterface.

Definition at line 2160 of file Item.php.

2161  {
2162  return $this->setData(OrderItemInterface::GW_ID, $id);
2163  }
$id
$id
Definition: fieldset.phtml:14

◆ setGwPrice()

setGwPrice (   $price)

Sets the GW price for the order item.

Parameters
float$price
Returns
$this

Implements OrderItemInterface.

Definition at line 2176 of file Item.php.

2177  {
2178  return $this->setData(OrderItemInterface::GW_PRICE, $price);
2179  }
$price
$price
Definition: product_alert.php:10

◆ setGwPriceInvoiced()

setGwPriceInvoiced (   $gwPriceInvoiced)

Sets the GW price invoiced for the order item.

Parameters
float$gwPriceInvoiced
Returns
$this

Implements OrderItemInterface.

Definition at line 2208 of file Item.php.

2209  {
2210  return $this->setData(OrderItemInterface::GW_PRICE_INVOICED, $gwPriceInvoiced);
2211  }

◆ setGwPriceRefunded()

setGwPriceRefunded (   $gwPriceRefunded)

Sets the GW price refunded for the order item.

Parameters
float$gwPriceRefunded
Returns
$this

Implements OrderItemInterface.

Definition at line 2240 of file Item.php.

2241  {
2242  return $this->setData(OrderItemInterface::GW_PRICE_REFUNDED, $gwPriceRefunded);
2243  }

◆ setGwTaxAmount()

setGwTaxAmount (   $amount)

Sets the GW tax amount for the order item.

Parameters
float$amount
Returns
$this

Implements OrderItemInterface.

Definition at line 2192 of file Item.php.

2193  {
2194  return $this->setData(OrderItemInterface::GW_TAX_AMOUNT, $amount);
2195  }
$amount
$amount
Definition: order.php:14

◆ setGwTaxAmountInvoiced()

setGwTaxAmountInvoiced (   $gwTaxAmountInvoiced)

Sets the GW tax amount invoiced for the order item.

Parameters
float$gwTaxAmountInvoiced
Returns
$this

Implements OrderItemInterface.

Definition at line 2224 of file Item.php.

2225  {
2226  return $this->setData(OrderItemInterface::GW_TAX_AMOUNT_INVOICED, $gwTaxAmountInvoiced);
2227  }

◆ setGwTaxAmountRefunded()

setGwTaxAmountRefunded (   $gwTaxAmountRefunded)

Sets the GW tax amount refunded for the order item.

Parameters
float$gwTaxAmountRefunded
Returns
$this

Implements OrderItemInterface.

Definition at line 2256 of file Item.php.

2257  {
2258  return $this->setData(OrderItemInterface::GW_TAX_AMOUNT_REFUNDED, $gwTaxAmountRefunded);
2259  }

◆ setIsQtyDecimal()

setIsQtyDecimal (   $isQtyDecimal)

Sets the is-quantity-decimal flag value for the order item.

Parameters
int$isQtyDecimal
Returns
$this

Implements OrderItemInterface.

Definition at line 1746 of file Item.php.

1747  {
1748  return $this->setData(OrderItemInterface::IS_QTY_DECIMAL, $isQtyDecimal);
1749  }

◆ setIsVirtual()

setIsVirtual (   $isVirtual)

Sets the is-virtual flag value for the order item.

Parameters
int$isVirtual
Returns
$this

Implements OrderItemInterface.

Definition at line 1698 of file Item.php.

1699  {
1700  return $this->setData(OrderItemInterface::IS_VIRTUAL, $isVirtual);
1701  }

◆ setItemId()

setItemId (   $id)

Sets the item ID for the order item.

Parameters
int$id
Returns
$this

Implements OrderItemInterface.

Definition at line 1634 of file Item.php.

1635  {
1636  return $this->setData(OrderItemInterface::ITEM_ID, $id);
1637  }
$id
$id
Definition: fieldset.phtml:14

◆ setLockedDoInvoice()

setLockedDoInvoice (   $flag)

Sets the locked DO invoice flag value for the order item.

Parameters
int$flag
Returns
$this

Implements OrderItemInterface.

Definition at line 2010 of file Item.php.

2011  {
2012  return $this->setData(OrderItemInterface::LOCKED_DO_INVOICE, $flag);
2013  }

◆ setLockedDoShip()

setLockedDoShip (   $flag)

Sets the locked DO ship flag value for the order item.

Parameters
int$flag
Returns
$this

Implements OrderItemInterface.

Definition at line 2018 of file Item.php.

2019  {
2020  return $this->setData(OrderItemInterface::LOCKED_DO_SHIP, $flag);
2021  }

◆ setName()

setName (   $name)

Sets the name for the order item.

Parameters
string$name
Returns
$this

Implements OrderItemInterface.

Definition at line 1714 of file Item.php.

1715  {
1716  return $this->setData(OrderItemInterface::NAME, $name);
1717  }
$name
if(!isset($_GET['name'])) $name
Definition: log.php:14

◆ setNoDiscount()

setNoDiscount (   $noDiscount)

Sets the no discount flag value for the order item.

Parameters
int$noDiscount
Returns
$this

Implements OrderItemInterface.

Definition at line 1754 of file Item.php.

1755  {
1756  return $this->setData(OrderItemInterface::NO_DISCOUNT, $noDiscount);
1757  }

◆ setOrder()

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

Declare order

Parameters
\Magento\Sales\Model\Order$order
Returns
$this

Definition at line 285 of file Item.php.

286  {
287  $this->_order = $order;
288  $this->setOrderId($order->getId());
289  return $this;
290  }
$order
$order
Definition: order.php:55

◆ setOrderId()

setOrderId (   $id)

Sets the order ID for the order item.

Parameters
int$id
Returns
$this

Implements OrderItemInterface.

Definition at line 1642 of file Item.php.

1643  {
1644  return $this->setData(OrderItemInterface::ORDER_ID, $id);
1645  }
$id
$id
Definition: fieldset.phtml:14

◆ setOriginalPrice()

setOriginalPrice (   $price)

Sets the original price for the order item.

Parameters
float$price
Returns
$this

Implements OrderItemInterface.

Definition at line 1834 of file Item.php.

1835  {
1836  return $this->setData(OrderItemInterface::ORIGINAL_PRICE, $price);
1837  }
$price
$price
Definition: product_alert.php:10

◆ setParentItem()

setParentItem (   $item)

Set parent item

Parameters
Item$item
Returns
$this

Implements OrderItemInterface.

Definition at line 164 of file Item.php.

165  {
166  if ($item) {
167  $this->setData(OrderItemInterface::PARENT_ITEM, $item);
168  $item->setHasChildren(true);
169  $item->addChildItem($this);
170  }
171  return $this;
172  }
$item
$item
Definition: partial_invoice.php:27

◆ setParentItemId()

setParentItemId (   $id)

Sets the parent item ID for the order item.

Parameters
int$id
Returns
$this

Implements OrderItemInterface.

Definition at line 1650 of file Item.php.

1651  {
1652  return $this->setData(OrderItemInterface::PARENT_ITEM_ID, $id);
1653  }
$id
$id
Definition: fieldset.phtml:14

◆ setPrice()

setPrice (   $price)

Sets the price for the order item.

Parameters
float$price
Returns
$this

Implements OrderItemInterface.

Definition at line 1818 of file Item.php.

1819  {
1820  return $this->setData(OrderItemInterface::PRICE, $price);
1821  }
$price
$price
Definition: product_alert.php:10

◆ setPriceInclTax()

setPriceInclTax (   $amount)

Sets the price including tax for the order item.

Parameters
float$amount
Returns
$this

Implements OrderItemInterface.

Definition at line 2026 of file Item.php.

2027  {
2028  return $this->setData(OrderItemInterface::PRICE_INCL_TAX, $amount);
2029  }
$amount
$amount
Definition: order.php:14

◆ setProductId()

setProductId (   $id)

Sets the product ID for the order item.

Parameters
int$id
Returns
$this

Implements OrderItemInterface.

Definition at line 1674 of file Item.php.

1675  {
1676  return $this->setData(OrderItemInterface::PRODUCT_ID, $id);
1677  }
$id
$id
Definition: fieldset.phtml:14

◆ setProductOption()

setProductOption ( \Magento\Catalog\Api\Data\ProductOptionInterface  $productOption)

Definition at line 2368 of file Item.php.

2369  {
2370  return $this->setData(self::KEY_PRODUCT_OPTION, $productOption);
2371  }
$productOption
$productOption
Definition: quote_with_product_and_custom_options.php:37

◆ setProductOptions()

setProductOptions ( array  $options = null)

Set product options

Parameters
array$options
Returns
$this

Definition at line 464 of file Item.php.

465  {
466  $this->setData('product_options', $options);
467  return $this;
468  }
$options
$options
Definition: multiple_mixed_products.php:29

◆ setProductType()

setProductType (   $productType)

Sets the product type for the order item.

Parameters
string$productType
Returns
$this

Implements OrderItemInterface.

Definition at line 1682 of file Item.php.

1683  {
1684  return $this->setData(OrderItemInterface::PRODUCT_TYPE, $productType);
1685  }

◆ setQtyBackordered()

setQtyBackordered (   $qtyBackordered)

Sets the quantity backordered for the order item.

Parameters
float$qtyBackordered
Returns
$this

Implements OrderItemInterface.

Definition at line 1762 of file Item.php.

1763  {
1764  return $this->setData(OrderItemInterface::QTY_BACKORDERED, $qtyBackordered);
1765  }

◆ setQtyCanceled()

setQtyCanceled (   $qtyCanceled)

Sets the quantity canceled for the order item.

Parameters
float$qtyCanceled
Returns
$this

Implements OrderItemInterface.

Definition at line 1770 of file Item.php.

1771  {
1772  return $this->setData(OrderItemInterface::QTY_CANCELED, $qtyCanceled);
1773  }

◆ setQtyInvoiced()

setQtyInvoiced (   $qtyInvoiced)

Sets the quantity invoiced for the order item.

Parameters
float$qtyInvoiced
Returns
$this

Implements OrderItemInterface.

Definition at line 1778 of file Item.php.

1779  {
1780  return $this->setData(OrderItemInterface::QTY_INVOICED, $qtyInvoiced);
1781  }

◆ setQtyOrdered()

setQtyOrdered (   $qtyOrdered)

Sets the quantity ordered for the order item.

Parameters
float$qtyOrdered
Returns
$this

Implements OrderItemInterface.

Definition at line 1786 of file Item.php.

1787  {
1788  return $this->setData(OrderItemInterface::QTY_ORDERED, $qtyOrdered);
1789  }
$qtyOrdered
$qtyOrdered
Definition: order_configurable_product.php:53

◆ setQtyRefunded()

setQtyRefunded (   $qtyRefunded)

Sets the quantity refunded for the order item.

Parameters
float$qtyRefunded
Returns
$this

Implements OrderItemInterface.

Definition at line 1794 of file Item.php.

1795  {
1796  return $this->setData(OrderItemInterface::QTY_REFUNDED, $qtyRefunded);
1797  }

◆ setQtyReturned()

setQtyReturned (   $qtyReturned)

Sets the quantity returned for the order item.

Parameters
float$qtyReturned
Returns
$this

Implements OrderItemInterface.

Definition at line 2272 of file Item.php.

2273  {
2274  return $this->setData(OrderItemInterface::QTY_RETURNED, $qtyReturned);
2275  }

◆ setQtyShipped()

setQtyShipped (   $qtyShipped)

Sets the quantity shipped for the order item.

Parameters
float$qtyShipped
Returns
$this

Implements OrderItemInterface.

Definition at line 1802 of file Item.php.

1803  {
1804  return $this->setData(OrderItemInterface::QTY_SHIPPED, $qtyShipped);
1805  }

◆ setQuoteItemId()

setQuoteItemId (   $id)

Sets the quote item ID for the order item.

Parameters
int$id
Returns
$this

Implements OrderItemInterface.

Definition at line 1658 of file Item.php.

1659  {
1660  return $this->setData(OrderItemInterface::QUOTE_ITEM_ID, $id);
1661  }
$id
$id
Definition: fieldset.phtml:14

◆ setRowInvoiced()

setRowInvoiced (   $rowInvoiced)

Sets the row invoiced for the order item.

Parameters
float$rowInvoiced
Returns
$this

Implements OrderItemInterface.

Definition at line 1962 of file Item.php.

1963  {
1964  return $this->setData(OrderItemInterface::ROW_INVOICED, $rowInvoiced);
1965  }

◆ setRowTotal()

setRowTotal (   $amount)

Sets the row total for the order item.

Parameters
float$amount
Returns
$this

Implements OrderItemInterface.

Definition at line 1946 of file Item.php.

1947  {
1948  return $this->setData(OrderItemInterface::ROW_TOTAL, $amount);
1949  }
$amount
$amount
Definition: order.php:14

◆ setRowTotalInclTax()

setRowTotalInclTax (   $amount)

Sets the row total including tax for the order item.

Parameters
float$amount
Returns
$this

Implements OrderItemInterface.

Definition at line 2042 of file Item.php.

2043  {
2044  return $this->setData(OrderItemInterface::ROW_TOTAL_INCL_TAX, $amount);
2045  }
$amount
$amount
Definition: order.php:14

◆ setRowWeight()

setRowWeight (   $rowWeight)

Sets the row weight for the order item.

Parameters
float$rowWeight
Returns
$this

Implements OrderItemInterface.

Definition at line 1978 of file Item.php.

1979  {
1980  return $this->setData(OrderItemInterface::ROW_WEIGHT, $rowWeight);
1981  }

◆ setSku()

setSku (   $sku)

Sets the SKU for the order item.

Parameters
string$sku
Returns
$this

Implements OrderItemInterface.

Definition at line 1706 of file Item.php.

1707  {
1708  return $this->setData(OrderItemInterface::SKU, $sku);
1709  }

◆ setStoreId()

setStoreId (   $id)

Sets the store ID for the order item.

Parameters
int$id
Returns
$this

Implements OrderItemInterface.

Definition at line 1666 of file Item.php.

1667  {
1668  return $this->setData(OrderItemInterface::STORE_ID, $id);
1669  }
$id
$id
Definition: fieldset.phtml:14

◆ setTaxAmount()

setTaxAmount (   $amount)

Sets the tax amount for the order item.

Parameters
float$amount
Returns
$this

Implements OrderItemInterface.

Definition at line 1858 of file Item.php.

1859  {
1860  return $this->setData(OrderItemInterface::TAX_AMOUNT, $amount);
1861  }
$amount
$amount
Definition: order.php:14

◆ setTaxBeforeDiscount()

setTaxBeforeDiscount (   $taxBeforeDiscount)

Sets the tax before discount for the order item.

Parameters
float$taxBeforeDiscount
Returns
$this

Implements OrderItemInterface.

Definition at line 1994 of file Item.php.

1995  {
1996  return $this->setData(OrderItemInterface::TAX_BEFORE_DISCOUNT, $taxBeforeDiscount);
1997  }

◆ setTaxCanceled()

setTaxCanceled (   $taxCanceled)

Sets the tax canceled for the order item.

Parameters
float$taxCanceled
Returns
$this

Implements OrderItemInterface.

Definition at line 2112 of file Item.php.

2113  {
2114  return $this->setData(OrderItemInterface::TAX_CANCELED, $taxCanceled);
2115  }

◆ setTaxInvoiced()

setTaxInvoiced (   $taxInvoiced)

Sets the tax invoiced for the order item.

Parameters
float$taxInvoiced
Returns
$this

Implements OrderItemInterface.

Definition at line 1874 of file Item.php.

1875  {
1876  return $this->setData(OrderItemInterface::TAX_INVOICED, $taxInvoiced);
1877  }

◆ setTaxPercent()

setTaxPercent (   $taxPercent)

Sets the tax percent for the order item.

Parameters
float$taxPercent
Returns
$this

Implements OrderItemInterface.

Definition at line 1850 of file Item.php.

1851  {
1852  return $this->setData(OrderItemInterface::TAX_PERCENT, $taxPercent);
1853  }

◆ setTaxRefunded()

setTaxRefunded (   $taxRefunded)

Sets the tax refunded for the order item.

Parameters
float$taxRefunded
Returns
$this

Implements OrderItemInterface.

Definition at line 2128 of file Item.php.

2129  {
2130  return $this->setData(OrderItemInterface::TAX_REFUNDED, $taxRefunded);
2131  }

◆ setUpdatedAt()

setUpdatedAt (   $timestamp)

Sets the updated-at timestamp for the order item.

Parameters
string$timestamp
Returns
$this

Implements OrderItemInterface.

Definition at line 1626 of file Item.php.

1627  {
1628  return $this->setData(OrderItemInterface::UPDATED_AT, $timestamp);
1629  }

◆ setWeeeTaxApplied()

setWeeeTaxApplied (   $weeeTaxApplied)

Sets the WEEE tax applied for the order item.

Parameters
string$weeeTaxApplied
Returns
$this

Implements OrderItemInterface.

Definition at line 2320 of file Item.php.

2321  {
2322  return $this->setData(OrderItemInterface::WEEE_TAX_APPLIED, $weeeTaxApplied);
2323  }

◆ setWeeeTaxAppliedAmount()

setWeeeTaxAppliedAmount (   $amount)

Sets the WEEE tax applied amount for the order item.

Parameters
float$amount
Returns
$this

Implements OrderItemInterface.

Definition at line 2304 of file Item.php.

2305  {
2306  return $this->setData(OrderItemInterface::WEEE_TAX_APPLIED_AMOUNT, $amount);
2307  }
$amount
$amount
Definition: order.php:14

◆ setWeeeTaxAppliedRowAmount()

setWeeeTaxAppliedRowAmount (   $amount)

Sets the WEEE tax applied row amount for the order item.

Parameters
float$amount
Returns
$this

Implements OrderItemInterface.

Definition at line 2312 of file Item.php.

2313  {
2314  return $this->setData(OrderItemInterface::WEEE_TAX_APPLIED_ROW_AMOUNT, $amount);
2315  }
$amount
$amount
Definition: order.php:14

◆ setWeeeTaxDisposition()

setWeeeTaxDisposition (   $weeeTaxDisposition)

Sets the WEEE tax disposition for the order item.

Parameters
float$weeeTaxDisposition
Returns
$this

Implements OrderItemInterface.

Definition at line 2328 of file Item.php.

2329  {
2330  return $this->setData(OrderItemInterface::WEEE_TAX_DISPOSITION, $weeeTaxDisposition);
2331  }

◆ setWeeeTaxRowDisposition()

setWeeeTaxRowDisposition (   $weeeTaxRowDisposition)

Sets the WEEE tax row disposition for the order item.

Parameters
float$weeeTaxRowDisposition
Returns
$this

Implements OrderItemInterface.

Definition at line 2336 of file Item.php.

2337  {
2338  return $this->setData(OrderItemInterface::WEEE_TAX_ROW_DISPOSITION, $weeeTaxRowDisposition);
2339  }

◆ setWeight()

setWeight (   $weight)

Sets the weight for the order item.

Parameters
float$weight
Returns
$this

Implements OrderItemInterface.

Definition at line 1690 of file Item.php.

1691  {
1692  return $this->setData(OrderItemInterface::WEIGHT, $weight);
1693  }

Field Documentation

◆ $_children

$_children = []
protected

Definition at line 79 of file Item.php.

◆ $_eventObject

$_eventObject = 'item'
protected

Definition at line 62 of file Item.php.

◆ $_eventPrefix

$_eventPrefix = 'sales_order_item'
protected

Definition at line 57 of file Item.php.

◆ $_order

$_order = null
protected

Definition at line 74 of file Item.php.

◆ $_orderFactory

$_orderFactory
protected

Definition at line 84 of file Item.php.

◆ $_statuses

$_statuses = null
staticprotected

Definition at line 67 of file Item.php.

◆ $_storeManager

$_storeManager
protected

Definition at line 94 of file Item.php.

◆ $productRepository

$productRepository
protected

Definition at line 89 of file Item.php.

◆ STATUS_BACKORDERED

const STATUS_BACKORDERED = 3

Definition at line 36 of file Item.php.

◆ STATUS_CANCELED

const STATUS_CANCELED = 5

Definition at line 39 of file Item.php.

◆ STATUS_INVOICED

const STATUS_INVOICED = 9

Definition at line 33 of file Item.php.

◆ STATUS_MIXED

const STATUS_MIXED = 7

Definition at line 46 of file Item.php.

◆ STATUS_PARTIAL

const STATUS_PARTIAL = 6

Definition at line 42 of file Item.php.

◆ STATUS_PENDING

const STATUS_PENDING = 1

Definition at line 27 of file Item.php.

◆ STATUS_REFUNDED

const STATUS_REFUNDED = 8

Definition at line 49 of file Item.php.

◆ STATUS_RETURNED

const STATUS_RETURNED = 4

Definition at line 52 of file Item.php.

◆ STATUS_SHIPPED

const STATUS_SHIPPED = 2

Definition at line 30 of file Item.php.

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