Inheritance diagram for Order:

Public Member Functions
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Framework\Api\ExtensionAttributesFactory $extensionFactory, AttributeValueFactory $customAttributeFactory, \Magento\Framework\Stdlib\DateTime\TimezoneInterface $timezone, \Magento\Store\Model\StoreManagerInterface $storeManager, \Magento\Sales\Model\Order\Config $orderConfig, \Magento\Catalog\Api\ProductRepositoryInterface $productRepository, \Magento\Sales\Model\ResourceModel\Order\Item\CollectionFactory $orderItemCollectionFactory, \Magento\Catalog\Model\Product\Visibility $productVisibility, \Magento\Sales\Api\InvoiceManagementInterface $invoiceManagement, \Magento\Directory\Model\CurrencyFactory $currencyFactory, \Magento\Eav\Model\Config $eavConfig, \Magento\Sales\Model\Order\Status\HistoryFactory $orderHistoryFactory, \Magento\Sales\Model\ResourceModel\Order\Address\CollectionFactory $addressCollectionFactory, \Magento\Sales\Model\ResourceModel\Order\Payment\CollectionFactory $paymentCollectionFactory, \Magento\Sales\Model\ResourceModel\Order\Status\History\CollectionFactory $historyCollectionFactory, \Magento\Sales\Model\ResourceModel\Order\Invoice\CollectionFactory $invoiceCollectionFactory, \Magento\Sales\Model\ResourceModel\Order\Shipment\CollectionFactory $shipmentCollectionFactory, \Magento\Sales\Model\ResourceModel\Order\Creditmemo\CollectionFactory $memoCollectionFactory, \Magento\Sales\Model\ResourceModel\Order\Shipment\Track\CollectionFactory $trackCollectionFactory, \Magento\Sales\Model\ResourceModel\Order\CollectionFactory $salesOrderCollectionFactory, PriceCurrencyInterface $priceCurrency, \Magento\Catalog\Model\ResourceModel\Product\CollectionFactory $productListFactory, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[], ResolverInterface $localeResolver=null)

	unsetData ($key=null)

	getActionFlag ($action)

	setActionFlag ($action, $flag)

	getCanSendNewEmailFlag ()

	setCanSendNewEmailFlag ($flag)

	loadByIncrementId ($incrementId)

	loadByIncrementIdAndStoreId ($incrementId, $storeId)

	loadByAttribute ($attribute, $value)

	getStore ()

	canCancel ()

	canVoidPayment ()

	canInvoice ()

	canCreditmemo ()

	canHold ()

	canUnhold ()

	canComment ()

	canShip ()

	canEdit ()

	canReorder ()

	canReorderIgnoreSalable ()

	isPaymentReview ()

	canReviewPayment ()

	canFetchPaymentReviewUpdate ()

	getConfig ()

	getPayment ()

	setBillingAddress (\Magento\Sales\Api\Data\OrderAddressInterface $address=null)

	setShippingAddress (\Magento\Sales\Api\Data\OrderAddressInterface $address=null)

	getBillingAddress ()

	getShippingAddress ()

	setState ($state)

	getStatusLabel ()

	addStatusToHistory ($status, $comment='', $isCustomerNotified=false)

	addStatusHistoryComment ($comment, $status=false)

	addCommentToStatusHistory ($comment, $status=false, $isVisibleOnFront=false)

	setHistoryEntityName ($entityName)

	getEntityType ()

	place ()

	hold ()

	unhold ()

	cancel ()

	isFraudDetected ()

	registerCancellation ($comment='', $graceful=true)

	getTrackingNumbers ()

	getShippingMethod ($asObject=false)

	getAddressesCollection ()

	getAddressById ($addressId)

	addAddress (\Magento\Sales\Model\Order\Address $address)

	getItemsCollection ($filterByTypes=[], $nonChildrenOnly=false)

	getParentItemsRandomCollection ($limit=1)

	getAllItems ()

	getAllVisibleItems ()

	getItemById ($itemId)

	getItemByQuoteItemId ($quoteItemId)

	addItem (\Magento\Sales\Model\Order\Item $item)

	getPaymentsCollection ()

	getAllPayments ()

	getPaymentById ($paymentId)

	setPayment (\Magento\Sales\Api\Data\OrderPaymentInterface $payment=null)

	getStatusHistoryCollection ()

	getAllStatusHistory ()

	getVisibleStatusHistory ()

	getStatusHistoryById ($statusId)

	addStatusHistory (\Magento\Sales\Model\Order\Status\History $history)

	getRealOrderId ()

	getOrderCurrency ()

	formatPrice ($price, $addBrackets=false)

	formatPricePrecision ($price, $precision, $addBrackets=false)

	formatPriceTxt ($price)

	getBaseCurrency ()

	formatBasePrice ($price)

	formatBasePricePrecision ($price, $precision)

	isCurrencyDifferent ()

	getTotalDue ()

	getBaseTotalDue ()

	getData ($key='', $index=null)

	getInvoiceCollection ()

	setInvoiceCollection (InvoiceCollection $invoices)

	getShipmentsCollection ()

	getCreditmemosCollection ()

	getTracksCollection ()

	hasInvoices ()

	hasShipments ()

	hasCreditmemos ()

	getRelatedObjects ()

	getCustomerName ()

	addRelatedObject (\Magento\Framework\Model\AbstractModel $object)

	getCreatedAtFormatted ($format)

	getEmailCustomerNote ()

	getStoreGroupName ()

	reset ()

	getIsNotVirtual ()

	prepareInvoice ($qtys=[])

	isCanceled ()

	getIncrementId ()

	getItems ()

	setItems ($items)

	getAddresses ()

	getStatusHistories ()

	getExtensionAttributes ()

	setExtensionAttributes (\Magento\Sales\Api\Data\OrderExtensionInterface $extensionAttributes)

	getAdjustmentNegative ()

	getAdjustmentPositive ()

	getAppliedRuleIds ()

	getBaseAdjustmentNegative ()

	getBaseAdjustmentPositive ()

	getBaseCurrencyCode ()

	getBaseDiscountAmount ()

	getBaseDiscountCanceled ()

	getBaseDiscountInvoiced ()

	getBaseDiscountRefunded ()

	getBaseGrandTotal ()

	getBaseDiscountTaxCompensationAmount ()

	getBaseDiscountTaxCompensationInvoiced ()

	getBaseDiscountTaxCompensationRefunded ()

	getBaseShippingAmount ()

	getBaseShippingCanceled ()

	getBaseShippingDiscountAmount ()

	getBaseShippingDiscountTaxCompensationAmnt ()

	getBaseShippingInclTax ()

	getBaseShippingInvoiced ()

	getBaseShippingRefunded ()

	getBaseShippingTaxAmount ()

	getBaseShippingTaxRefunded ()

	getBaseSubtotal ()

	getBaseSubtotalCanceled ()

	getBaseSubtotalInclTax ()

	getBaseSubtotalInvoiced ()

	getBaseSubtotalRefunded ()

	getBaseTaxAmount ()

	getBaseTaxCanceled ()

	getBaseTaxInvoiced ()

	getBaseTaxRefunded ()

	getBaseTotalCanceled ()

	getBaseTotalInvoiced ()

	getBaseTotalInvoicedCost ()

	getBaseTotalOfflineRefunded ()

	getBaseTotalOnlineRefunded ()

	getBaseTotalPaid ()

	getBaseTotalQtyOrdered ()

	getBaseTotalRefunded ()

	getBaseToGlobalRate ()

	getBaseToOrderRate ()

	getBillingAddressId ()

	getCanShipPartially ()

	getCanShipPartiallyItem ()

	getCouponCode ()

	getCreatedAt ()

	setCreatedAt ($createdAt)

	getCustomerDob ()

	getCustomerEmail ()

	getCustomerFirstname ()

	getCustomerGender ()

	getCustomerGroupId ()

	getCustomerId ()

	getCustomerIsGuest ()

	getCustomerLastname ()

	getCustomerMiddlename ()

	getCustomerNote ()

	getCustomerNoteNotify ()

	getCustomerPrefix ()

	getCustomerSuffix ()

	getCustomerTaxvat ()

	getDiscountAmount ()

	getDiscountCanceled ()

	getDiscountDescription ()

	getDiscountInvoiced ()

	getDiscountRefunded ()

	getEditIncrement ()

	getEmailSent ()

	getExtCustomerId ()

	getExtOrderId ()

	getForcedShipmentWithInvoice ()

	getGlobalCurrencyCode ()

	getGrandTotal ()

	getDiscountTaxCompensationAmount ()

	getDiscountTaxCompensationInvoiced ()

	getDiscountTaxCompensationRefunded ()

	getHoldBeforeState ()

	getHoldBeforeStatus ()

	getIsVirtual ()

	getOrderCurrencyCode ()

	getOriginalIncrementId ()

	getPaymentAuthorizationAmount ()

	getPaymentAuthExpiration ()

	getProtectCode ()

	getQuoteAddressId ()

	getQuoteId ()

	getRelationChildId ()

	getRelationChildRealId ()

	getRelationParentId ()

	getRelationParentRealId ()

	getRemoteIp ()

	getShippingAmount ()

	getShippingCanceled ()

	getShippingDescription ()

	getShippingDiscountAmount ()

	getShippingDiscountTaxCompensationAmount ()

	getShippingInclTax ()

	getShippingInvoiced ()

	getShippingRefunded ()

	getShippingTaxAmount ()

	getShippingTaxRefunded ()

	getState ()

	getStatus ()

	getStoreCurrencyCode ()

	getStoreId ()

	getStoreName ()

	getStoreToBaseRate ()

	getStoreToOrderRate ()

	getSubtotal ()

	getSubtotalCanceled ()

	getSubtotalInclTax ()

	getSubtotalInvoiced ()

	getSubtotalRefunded ()

	getTaxAmount ()

	getTaxCanceled ()

	getTaxInvoiced ()

	getTaxRefunded ()

	getTotalCanceled ()

	getTotalInvoiced ()

	getTotalItemCount ()

	getTotalOfflineRefunded ()

	getTotalOnlineRefunded ()

	getTotalPaid ()

	getTotalQtyOrdered ()

	getTotalRefunded ()

	getUpdatedAt ()

	getWeight ()

	getXForwardedFor ()

	setStatusHistories (array $statusHistories=null)

	setStatus ($status)

	setCouponCode ($code)

	setProtectCode ($code)

	setShippingDescription ($description)

	setIsVirtual ($isVirtual)

	setStoreId ($id)

	setCustomerId ($id)

	setBaseDiscountAmount ($amount)

	setBaseDiscountCanceled ($baseDiscountCanceled)

	setBaseDiscountInvoiced ($baseDiscountInvoiced)

	setBaseDiscountRefunded ($baseDiscountRefunded)

	setBaseGrandTotal ($amount)

	setBaseShippingAmount ($amount)

	setBaseShippingCanceled ($baseShippingCanceled)

	setBaseShippingInvoiced ($baseShippingInvoiced)

	setBaseShippingRefunded ($baseShippingRefunded)

	setBaseShippingTaxAmount ($amount)

	setBaseShippingTaxRefunded ($baseShippingTaxRefunded)

	setBaseSubtotal ($amount)

	setBaseSubtotalCanceled ($baseSubtotalCanceled)

	setBaseSubtotalInvoiced ($baseSubtotalInvoiced)

	setBaseSubtotalRefunded ($baseSubtotalRefunded)

	setBaseTaxAmount ($amount)

	setBaseTaxCanceled ($baseTaxCanceled)

	setBaseTaxInvoiced ($baseTaxInvoiced)

	setBaseTaxRefunded ($baseTaxRefunded)

	setBaseToGlobalRate ($rate)

	setBaseToOrderRate ($rate)

	setBaseTotalCanceled ($baseTotalCanceled)

	setBaseTotalInvoiced ($baseTotalInvoiced)

	setBaseTotalInvoicedCost ($baseTotalInvoicedCost)

	setBaseTotalOfflineRefunded ($baseTotalOfflineRefunded)

	setBaseTotalOnlineRefunded ($baseTotalOnlineRefunded)

	setBaseTotalPaid ($baseTotalPaid)

	setBaseTotalQtyOrdered ($baseTotalQtyOrdered)

	setBaseTotalRefunded ($baseTotalRefunded)

	setDiscountAmount ($amount)

	setDiscountCanceled ($discountCanceled)

	setDiscountInvoiced ($discountInvoiced)

	setDiscountRefunded ($discountRefunded)

	setGrandTotal ($amount)

	setShippingAmount ($amount)

	setShippingCanceled ($shippingCanceled)

	setShippingInvoiced ($shippingInvoiced)

	setShippingRefunded ($shippingRefunded)

	setShippingTaxAmount ($amount)

	setShippingTaxRefunded ($shippingTaxRefunded)

	setStoreToBaseRate ($rate)

	setStoreToOrderRate ($rate)

	setSubtotal ($amount)

	setSubtotalCanceled ($subtotalCanceled)

	setSubtotalInvoiced ($subtotalInvoiced)

	setSubtotalRefunded ($subtotalRefunded)

	setTaxAmount ($amount)

	setTaxCanceled ($taxCanceled)

	setTaxInvoiced ($taxInvoiced)

	setTaxRefunded ($taxRefunded)

	setTotalCanceled ($totalCanceled)

	setTotalInvoiced ($totalInvoiced)

	setTotalOfflineRefunded ($totalOfflineRefunded)

	setTotalOnlineRefunded ($totalOnlineRefunded)

	setTotalPaid ($totalPaid)

	setTotalQtyOrdered ($totalQtyOrdered)

	setTotalRefunded ($totalRefunded)

	setCanShipPartially ($flag)

	setCanShipPartiallyItem ($flag)

	setCustomerIsGuest ($customerIsGuest)

	setCustomerNoteNotify ($customerNoteNotify)

	setBillingAddressId ($id)

	setCustomerGroupId ($id)

	setEditIncrement ($editIncrement)

	setEmailSent ($emailSent)

	setForcedShipmentWithInvoice ($forcedShipmentWithInvoice)

	setPaymentAuthExpiration ($paymentAuthExpiration)

	setQuoteAddressId ($id)

	setQuoteId ($id)

	setAdjustmentNegative ($adjustmentNegative)

	setAdjustmentPositive ($adjustmentPositive)

	setBaseAdjustmentNegative ($baseAdjustmentNegative)

	setBaseAdjustmentPositive ($baseAdjustmentPositive)

	setBaseShippingDiscountAmount ($amount)

	setBaseSubtotalInclTax ($amount)

	setBaseTotalDue ($baseTotalDue)

	setPaymentAuthorizationAmount ($amount)

	setShippingDiscountAmount ($amount)

	setSubtotalInclTax ($amount)

	setTotalDue ($totalDue)

	setWeight ($weight)

	setCustomerDob ($customerDob)

	setIncrementId ($id)

	setAppliedRuleIds ($appliedRuleIds)

	setBaseCurrencyCode ($code)

	setCustomerEmail ($customerEmail)

	setCustomerFirstname ($customerFirstname)

	setCustomerLastname ($customerLastname)

	setCustomerMiddlename ($customerMiddlename)

	setCustomerPrefix ($customerPrefix)

	setCustomerSuffix ($customerSuffix)

	setCustomerTaxvat ($customerTaxvat)

	setDiscountDescription ($description)

	setExtCustomerId ($id)

	setExtOrderId ($id)

	setGlobalCurrencyCode ($code)

	setHoldBeforeState ($holdBeforeState)

	setHoldBeforeStatus ($holdBeforeStatus)

	setOrderCurrencyCode ($code)

	setOriginalIncrementId ($id)

	setRelationChildId ($id)

	setRelationChildRealId ($realId)

	setRelationParentId ($id)

	setRelationParentRealId ($realId)

	setRemoteIp ($remoteIp)

	setStoreCurrencyCode ($code)

	setStoreName ($storeName)

	setXForwardedFor ($xForwardedFor)

	setCustomerNote ($customerNote)

	setUpdatedAt ($timestamp)

	setTotalItemCount ($totalItemCount)

	setCustomerGender ($customerGender)

	setDiscountTaxCompensationAmount ($amount)

	setBaseDiscountTaxCompensationAmount ($amount)

	setShippingDiscountTaxCompensationAmount ($amount)

	setBaseShippingDiscountTaxCompensationAmnt ($amnt)

	setDiscountTaxCompensationInvoiced ($discountTaxCompensationInvoiced)

	setBaseDiscountTaxCompensationInvoiced ($baseDiscountTaxCompensationInvoiced)

	setDiscountTaxCompensationRefunded ($discountTaxCompensationRefunded)

	setBaseDiscountTaxCompensationRefunded ($baseDiscountTaxCompensationRefunded)

	setShippingInclTax ($amount)

	setBaseShippingInclTax ($amount)

	setShippingMethod ($shippingMethod)

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 OrderInterface
	getEntityId ()

	setEntityId ($entityId)

	setBillingAddress (\Magento\Sales\Api\Data\OrderAddressInterface $billingAddress=null)

	setPayment (\Magento\Sales\Api\Data\OrderPaymentInterface $payment=null)

Data Fields
const	ENTITY = 'order'

const	STATE_NEW = 'new'

const	STATE_PENDING_PAYMENT = 'pending_payment'

const	STATE_PROCESSING = 'processing'

const	STATE_COMPLETE = 'complete'

const	STATE_CLOSED = 'closed'

const	STATE_CANCELED = 'canceled'

const	STATE_HOLDED = 'holded'

const	STATE_PAYMENT_REVIEW = 'payment_review'

const	STATUS_FRAUD = 'fraud'

const	ACTION_FLAG_CANCEL = 'cancel'

const	ACTION_FLAG_HOLD = 'hold'

const	ACTION_FLAG_UNHOLD = 'unhold'

const	ACTION_FLAG_EDIT = 'edit'

const	ACTION_FLAG_CREDITMEMO = 'creditmemo'

const	ACTION_FLAG_INVOICE = 'invoice'

const	ACTION_FLAG_REORDER = 'reorder'

const	ACTION_FLAG_SHIP = 'ship'

const	ACTION_FLAG_COMMENT = 'comment'

const	REPORT_DATE_TYPE_CREATED = 'created'

const	REPORT_DATE_TYPE_UPDATED = 'updated'

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 OrderInterface
const	ENTITY_ID = 'entity_id'

const	STATE = 'state'

const	STATUS = 'status'

const	COUPON_CODE = 'coupon_code'

const	PROTECT_CODE = 'protect_code'

const	SHIPPING_DESCRIPTION = 'shipping_description'

const	IS_VIRTUAL = 'is_virtual'

const	STORE_ID = 'store_id'

const	CUSTOMER_ID = 'customer_id'

const	BASE_DISCOUNT_AMOUNT = 'base_discount_amount'

const	BASE_DISCOUNT_CANCELED = 'base_discount_canceled'

const	BASE_DISCOUNT_INVOICED = 'base_discount_invoiced'

const	BASE_DISCOUNT_REFUNDED = 'base_discount_refunded'

const	BASE_GRAND_TOTAL = 'base_grand_total'

const	BASE_SHIPPING_AMOUNT = 'base_shipping_amount'

const	BASE_SHIPPING_CANCELED = 'base_shipping_canceled'

const	BASE_SHIPPING_INVOICED = 'base_shipping_invoiced'

const	BASE_SHIPPING_REFUNDED = 'base_shipping_refunded'

const	BASE_SHIPPING_TAX_AMOUNT = 'base_shipping_tax_amount'

const	BASE_SHIPPING_TAX_REFUNDED = 'base_shipping_tax_refunded'

const	BASE_SUBTOTAL = 'base_subtotal'

const	BASE_SUBTOTAL_CANCELED = 'base_subtotal_canceled'

const	BASE_SUBTOTAL_INVOICED = 'base_subtotal_invoiced'

const	BASE_SUBTOTAL_REFUNDED = 'base_subtotal_refunded'

const	BASE_TAX_AMOUNT = 'base_tax_amount'

const	BASE_TAX_CANCELED = 'base_tax_canceled'

const	BASE_TAX_INVOICED = 'base_tax_invoiced'

const	BASE_TAX_REFUNDED = 'base_tax_refunded'

const	BASE_TO_GLOBAL_RATE = 'base_to_global_rate'

const	BASE_TO_ORDER_RATE = 'base_to_order_rate'

const	BASE_TOTAL_CANCELED = 'base_total_canceled'

const	BASE_TOTAL_INVOICED = 'base_total_invoiced'

const	BASE_TOTAL_INVOICED_COST = 'base_total_invoiced_cost'

const	BASE_TOTAL_OFFLINE_REFUNDED = 'base_total_offline_refunded'

const	BASE_TOTAL_ONLINE_REFUNDED = 'base_total_online_refunded'

const	BASE_TOTAL_PAID = 'base_total_paid'

const	BASE_TOTAL_QTY_ORDERED = 'base_total_qty_ordered'

const	BASE_TOTAL_REFUNDED = 'base_total_refunded'

const	DISCOUNT_AMOUNT = 'discount_amount'

const	DISCOUNT_CANCELED = 'discount_canceled'

const	DISCOUNT_INVOICED = 'discount_invoiced'

const	DISCOUNT_REFUNDED = 'discount_refunded'

const	GRAND_TOTAL = 'grand_total'

const	SHIPPING_AMOUNT = 'shipping_amount'

const	SHIPPING_CANCELED = 'shipping_canceled'

const	SHIPPING_INVOICED = 'shipping_invoiced'

const	SHIPPING_REFUNDED = 'shipping_refunded'

const	SHIPPING_TAX_AMOUNT = 'shipping_tax_amount'

const	SHIPPING_TAX_REFUNDED = 'shipping_tax_refunded'

const	STORE_TO_BASE_RATE = 'store_to_base_rate'

const	STORE_TO_ORDER_RATE = 'store_to_order_rate'

const	SUBTOTAL = 'subtotal'

const	SUBTOTAL_CANCELED = 'subtotal_canceled'

const	SUBTOTAL_INVOICED = 'subtotal_invoiced'

const	SUBTOTAL_REFUNDED = 'subtotal_refunded'

const	TAX_AMOUNT = 'tax_amount'

const	TAX_CANCELED = 'tax_canceled'

const	TAX_INVOICED = 'tax_invoiced'

const	TAX_REFUNDED = 'tax_refunded'

const	TOTAL_CANCELED = 'total_canceled'

const	TOTAL_INVOICED = 'total_invoiced'

const	TOTAL_OFFLINE_REFUNDED = 'total_offline_refunded'

const	TOTAL_ONLINE_REFUNDED = 'total_online_refunded'

const	TOTAL_PAID = 'total_paid'

const	TOTAL_QTY_ORDERED = 'total_qty_ordered'

const	TOTAL_REFUNDED = 'total_refunded'

const	CAN_SHIP_PARTIALLY = 'can_ship_partially'

const	CAN_SHIP_PARTIALLY_ITEM = 'can_ship_partially_item'

const	CUSTOMER_IS_GUEST = 'customer_is_guest'

const	CUSTOMER_NOTE_NOTIFY = 'customer_note_notify'

const	BILLING_ADDRESS_ID = 'billing_address_id'

const	CUSTOMER_GROUP_ID = 'customer_group_id'

const	EDIT_INCREMENT = 'edit_increment'

const	EMAIL_SENT = 'email_sent'

const	FORCED_SHIPMENT_WITH_INVOICE = 'forced_shipment_with_invoice'

const	PAYMENT_AUTH_EXPIRATION = 'payment_auth_expiration'

const	QUOTE_ADDRESS_ID = 'quote_address_id'

const	QUOTE_ID = 'quote_id'

const	ADJUSTMENT_NEGATIVE = 'adjustment_negative'

const	ADJUSTMENT_POSITIVE = 'adjustment_positive'

const	BASE_ADJUSTMENT_NEGATIVE = 'base_adjustment_negative'

const	BASE_ADJUSTMENT_POSITIVE = 'base_adjustment_positive'

const	BASE_SHIPPING_DISCOUNT_AMOUNT = 'base_shipping_discount_amount'

const	BASE_SUBTOTAL_INCL_TAX = 'base_subtotal_incl_tax'

const	BASE_TOTAL_DUE = 'base_total_due'

const	PAYMENT_AUTHORIZATION_AMOUNT = 'payment_authorization_amount'

const	SHIPPING_DISCOUNT_AMOUNT = 'shipping_discount_amount'

const	SUBTOTAL_INCL_TAX = 'subtotal_incl_tax'

const	TOTAL_DUE = 'total_due'

const	WEIGHT = 'weight'

const	CUSTOMER_DOB = 'customer_dob'

const	INCREMENT_ID = 'increment_id'

const	APPLIED_RULE_IDS = 'applied_rule_ids'

const	BASE_CURRENCY_CODE = 'base_currency_code'

const	CUSTOMER_EMAIL = 'customer_email'

const	CUSTOMER_FIRSTNAME = 'customer_firstname'

const	CUSTOMER_LASTNAME = 'customer_lastname'

const	CUSTOMER_MIDDLENAME = 'customer_middlename'

const	CUSTOMER_PREFIX = 'customer_prefix'

const	CUSTOMER_SUFFIX = 'customer_suffix'

const	CUSTOMER_TAXVAT = 'customer_taxvat'

const	DISCOUNT_DESCRIPTION = 'discount_description'

const	EXT_CUSTOMER_ID = 'ext_customer_id'

const	EXT_ORDER_ID = 'ext_order_id'

const	GLOBAL_CURRENCY_CODE = 'global_currency_code'

const	HOLD_BEFORE_STATE = 'hold_before_state'

const	HOLD_BEFORE_STATUS = 'hold_before_status'

const	ORDER_CURRENCY_CODE = 'order_currency_code'

const	ORIGINAL_INCREMENT_ID = 'original_increment_id'

const	RELATION_CHILD_ID = 'relation_child_id'

const	RELATION_CHILD_REAL_ID = 'relation_child_real_id'

const	RELATION_PARENT_ID = 'relation_parent_id'

const	RELATION_PARENT_REAL_ID = 'relation_parent_real_id'

const	REMOTE_IP = 'remote_ip'

const	STORE_CURRENCY_CODE = 'store_currency_code'

const	STORE_NAME = 'store_name'

const	X_FORWARDED_FOR = 'x_forwarded_for'

const	CUSTOMER_NOTE = 'customer_note'

const	CREATED_AT = 'created_at'

const	UPDATED_AT = 'updated_at'

const	TOTAL_ITEM_COUNT = 'total_item_count'

const	CUSTOMER_GENDER = 'customer_gender'

const	DISCOUNT_TAX_COMPENSATION_AMOUNT = 'discount_tax_compensation_amount'

const	BASE_DISCOUNT_TAX_COMPENSATION_AMOUNT = 'base_discount_tax_compensation_amount'

const	SHIPPING_DISCOUNT_TAX_COMPENSATION_AMOUNT = 'shipping_discount_tax_compensation_amount'

const	BASE_SHIPPING_DISCOUNT_TAX_COMPENSATION_AMNT = 'base_shipping_discount_tax_compensation_amnt'

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	SHIPPING_INCL_TAX = 'shipping_incl_tax'

const	BASE_SHIPPING_INCL_TAX = 'base_shipping_incl_tax'

const	ITEMS = 'items'

const	BILLING_ADDRESS = 'billing_address'

const	PAYMENT = 'payment'

const	STATUS_HISTORIES = 'status_histories'

Protected Member Functions
	_construct ()

	_canVoidOrder ()

	_canReorder ($ignoreSalable=false)

	_placePayment ()

	_getItemsRandomCollection ($limit, $nonChildrenOnly=false)

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'

	$_eventObject = 'order'

	$_invoices

	$_tracks

	$_shipments

	$_creditmemos

	$_relatedObjects = []

	$_orderCurrency = null

	$_baseCurrency = null

	$_actionFlag = []

	$_canSendNewEmailFlag = true

	$entityType = 'order'

	$_storeManager

	$_orderConfig

	$productRepository

	$productListFactory

	$_orderItemCollectionFactory

	$_productVisibility

	$invoiceManagement

	$_currencyFactory

	$_orderHistoryFactory

	$_addressCollectionFactory

	$_paymentCollectionFactory

	$_historyCollectionFactory

	$_invoiceCollectionFactory

	$_shipmentCollectionFactory

	$_memoCollectionFactory

	$_trackCollectionFactory

	$salesOrderCollectionFactory

	$priceCurrency

	$timezone

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

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

Detailed Description

Order model

Supported events: sales_order_load_after sales_order_save_before sales_order_save_after sales_order_delete_before sales_order_delete_after

@api @method int getGiftMessageId() @method \Magento\Sales\Model\Order setGiftMessageId(int $value) @method bool hasBillingAddressId() @method \Magento\Sales\Model\Order unsBillingAddressId() @method bool hasShippingAddressId() @method \Magento\Sales\Model\Order unsShippingAddressId() @method int getShippigAddressId() @method bool hasCustomerNoteNotify() @method bool hasForcedCanCreditmemo() @method bool getIsInProcess() @method \Magento\Customer\Model\Customer getCustomer() @method \Magento\Sales\Model\Order setSendEmail(bool $value) @SuppressWarnings(PHPMD.ExcessivePublicCount) @SuppressWarnings(PHPMD.TooManyFields) @SuppressWarnings(PHPMD.ExcessiveClassComplexity) @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Since: 100.0.2

Definition at line 54 of file Order.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Framework\Model\Context	$context,
		\Magento\Framework\Registry	$registry,
		\Magento\Framework\Api\ExtensionAttributesFactory	$extensionFactory,
		AttributeValueFactory	$customAttributeFactory,
		\Magento\Framework\Stdlib\DateTime\TimezoneInterface	$timezone,
		\Magento\Store\Model\StoreManagerInterface	$storeManager,
		\Magento\Sales\Model\Order\Config	$orderConfig,
		\Magento\Catalog\Api\ProductRepositoryInterface	$productRepository,
		\Magento\Sales\Model\ResourceModel\Order\Item\CollectionFactory	$orderItemCollectionFactory,
		\Magento\Catalog\Model\Product\Visibility	$productVisibility,
		\Magento\Sales\Api\InvoiceManagementInterface	$invoiceManagement,
		\Magento\Directory\Model\CurrencyFactory	$currencyFactory,
		\Magento\Eav\Model\Config	$eavConfig,
		\Magento\Sales\Model\Order\Status\HistoryFactory	$orderHistoryFactory,
		\Magento\Sales\Model\ResourceModel\Order\Address\CollectionFactory	$addressCollectionFactory,
		\Magento\Sales\Model\ResourceModel\Order\Payment\CollectionFactory	$paymentCollectionFactory,
		\Magento\Sales\Model\ResourceModel\Order\Status\History\CollectionFactory	$historyCollectionFactory,
		\Magento\Sales\Model\ResourceModel\Order\Invoice\CollectionFactory	$invoiceCollectionFactory,
		\Magento\Sales\Model\ResourceModel\Order\Shipment\CollectionFactory	$shipmentCollectionFactory,
		\Magento\Sales\Model\ResourceModel\Order\Creditmemo\CollectionFactory	$memoCollectionFactory,
		\Magento\Sales\Model\ResourceModel\Order\Shipment\Track\CollectionFactory	$trackCollectionFactory,
		\Magento\Sales\Model\ResourceModel\Order\CollectionFactory	$salesOrderCollectionFactory,
		PriceCurrencyInterface	$priceCurrency,
		\Magento\Catalog\Model\ResourceModel\Product\CollectionFactory	$productListFactory,
		\Magento\Framework\Model\ResourceModel\AbstractResource	$resource = `null`,
		\Magento\Framework\Data\Collection\AbstractDb	$resourceCollection = `null`,
		array	$data = `[]`,
		ResolverInterface	$localeResolver = `null`
	)

Parameters

\Magento\Framework\Model\Context	$context
\Magento\Framework\Registry	$registry
\Magento\Framework\Api\ExtensionAttributesFactory	$extensionFactory
AttributeValueFactory	$customAttributeFactory
\Magento\Framework\Stdlib\DateTime\TimezoneInterface	$timezone
\Magento\Store\Model\StoreManagerInterface	$storeManager
Order\Config	$orderConfig
\Magento\Catalog\Api\ProductRepositoryInterface	$productRepository
\Magento\Sales\Model\ResourceModel\Order\Item\CollectionFactory	$orderItemCollectionFactory
\Magento\Catalog\Model\Product\Visibility	$productVisibility
\Magento\Sales\Api\InvoiceManagementInterface	$invoiceManagement
\Magento\Directory\Model\CurrencyFactory	$currencyFactory
\Magento\Eav\Model\Config	$eavConfig
Order\Status\HistoryFactory	$orderHistoryFactory
\Magento\Sales\Model\ResourceModel\Order\Address\CollectionFactory	$addressCollectionFactory
\Magento\Sales\Model\ResourceModel\Order\Payment\CollectionFactory	$paymentCollectionFactory
\Magento\Sales\Model\ResourceModel\Order\Status\History\CollectionFactory	$historyCollectionFactory
\Magento\Sales\Model\ResourceModel\Order\Invoice\CollectionFactory	$invoiceCollectionFactory
\Magento\Sales\Model\ResourceModel\Order\Shipment\CollectionFactory	$shipmentCollectionFactory
\Magento\Sales\Model\ResourceModel\Order\Creditmemo\CollectionFactory	$memoCollectionFactory
\Magento\Sales\Model\ResourceModel\Order\Shipment\Track\CollectionFactory	$trackCollectionFactory
ResourceModel\Order\CollectionFactory	$salesOrderCollectionFactory
PriceCurrencyInterface	$priceCurrency
\Magento\Catalog\Model\ResourceModel\Product\CollectionFactory	$productListFactory
\Magento\Framework\Model\ResourceModel\AbstractResource	$resource
\Magento\Framework\Data\Collection\AbstractDb	$resourceCollection
array	$data
ResolverInterface	$localeResolver	@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 313 of file Order.php.

       {
         $this->_storeManager = $storeManager;
         $this->_orderConfig = $orderConfig;
         $this->productRepository = $productRepository;
         $this->productListFactory = $productListFactory;
         $this->timezone = $timezone;
         $this->_orderItemCollectionFactory = $orderItemCollectionFactory;
         $this->_productVisibility = $productVisibility;
         $this->invoiceManagement = $invoiceManagement;
         $this->_currencyFactory = $currencyFactory;
         $this->_eavConfig = $eavConfig;
         $this->_orderHistoryFactory = $orderHistoryFactory;
         $this->_addressCollectionFactory = $addressCollectionFactory;
         $this->_paymentCollectionFactory = $paymentCollectionFactory;
         $this->_historyCollectionFactory = $historyCollectionFactory;
         $this->_invoiceCollectionFactory = $invoiceCollectionFactory;
         $this->_shipmentCollectionFactory = $shipmentCollectionFactory;
         $this->_memoCollectionFactory = $memoCollectionFactory;
         $this->_trackCollectionFactory = $trackCollectionFactory;
         $this->salesOrderCollectionFactory = $salesOrderCollectionFactory;
         $this->priceCurrency = $priceCurrency;
         $this->localeResolver = $localeResolver ?: ObjectManager::getInstance()->get(ResolverInterface::class);
 
         parent::__construct(
             $context,
             $registry,
             $extensionFactory,
             $customAttributeFactory,
             $resource,
             $resourceCollection,
             $data
         );
     }

Member Function Documentation

◆ _canReorder()

_canReorder ( $ignoreSalable = false )

protected

Retrieve order reorder availability

Parameters

bool $ignoreSalable

Returns: bool @SuppressWarnings(PHPMD.CyclomaticComplexity)

Definition at line 793 of file Order.php.

     {
         if ($this->canUnhold() || $this->isPaymentReview()) {
             return false;
         }
 
         if ($this->getActionFlag(self::ACTION_FLAG_REORDER) === false) {
             return false;
         }
 
         $products = [];
         $itemsCollection = $this->getItemsCollection();
         foreach ($itemsCollection as $item) {
             $products[] = $item->getProductId();
         }
 
         if (!empty($products)) {
             $productsCollection = $this->productListFactory->create()
                 ->setStoreId($this->getStoreId())
                 ->addIdFilter($products)
                 ->addAttributeToSelect('status')
                 ->load();
 
             foreach ($itemsCollection as $item) {
                 $product = $productsCollection->getItemById($item->getProductId());
                 if (!$product) {
                     return false;
                 }
                 if (!$ignoreSalable && !$product->isSalable()) {
                     return false;
                 }
             }
         }
 
         return true;
     }

◆ _canVoidOrder()

_canVoidOrder ( )

protected

Check whether order could be canceled by states and flags

Returns: bool

Definition at line 581 of file Order.php.

     {
         return !($this->isCanceled() || $this->canUnhold() || $this->isPaymentReview());
     }

◆ _construct()

_construct ( )

protected

Initialize resource model

Returns: void

Definition at line 381 of file Order.php.

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

◆ _getItemsRandomCollection()

_getItemsRandomCollection	(	$limit,
		$nonChildrenOnly = `false`
	)

protected

Get random items collection with or without related children

Parameters

int	$limit
bool	$nonChildrenOnly

Returns: ImportCollection

Definition at line 1334 of file Order.php.

     {
         $collection = $this->_orderItemCollectionFactory->create()
             ->setOrderFilter($this)
             ->setRandomOrder()
             ->setPageSize($limit);
 
         if ($nonChildrenOnly) {
             $collection->filterByParent();
         }
         $products = [];
         foreach ($collection as $item) {
             $products[] = $item->getProductId();
         }
 
         $productsCollection = $this->productListFactory->create()->addIdFilter(
             $products
         )->setVisibility(
             $this->_productVisibility->getVisibleInSiteIds()
         )->addPriceData()->load();
 
         foreach ($collection as $item) {
             $product = $productsCollection->getItemById($item->getProductId());
             if ($product) {
                 $item->setProduct($product);
             }
         }
 
         return $collection;
     }

◆ _placePayment()

_placePayment ( )

protected

Place order payments

Returns: $this

Definition at line 878 of file Order.php.

     {
         $this->getPayment()->place();
         return $this;
     }

◆ addAddress()

addAddress ( \Magento\Sales\Model\Order\Address $address )

Add address

Parameters

\Magento\Sales\Model\Order\Address $address

Returns: $this

Definition at line 1280 of file Order.php.

     {
         $address->setOrder($this)->setParentId($this->getId());
         if (!$address->getId()) {
             $this->setAddresses(array_merge($this->getAddresses(), [$address]));
             $this->setDataChanges(true);
         }
         return $this;
     }

◆ addCommentToStatusHistory()

addCommentToStatusHistory	(	$comment,
		$status = `false`,
		$isVisibleOnFront = `false`
	)

Add a comment to order status history.

Different or default status may be specified.

Parameters

string	$comment
bool \| string	$status
bool	$isVisibleOnFront

Returns: OrderStatusHistoryInterface

Since: 101.0.5

Definition at line 1038 of file Order.php.

     {
         if (false === $status) {
             $status = $this->getStatus();
         } elseif (true === $status) {
             $status = $this->getConfig()->getStateDefaultStatus($this->getState());
         } else {
             $this->setStatus($status);
         }
         $history = $this->_orderHistoryFactory->create()->setStatus(
             $status
         )->setComment(
             $comment
         )->setEntityName(
             $this->entityType
         )->setIsVisibleOnFront(
             $isVisibleOnFront
         );
         $this->addStatusHistory($history);
         return $history;
     }

◆ addItem()

addItem ( \Magento\Sales\Model\Order\Item $item )

Add item

Parameters

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

Returns: $this

Definition at line 1436 of file Order.php.

     {
         $item->setOrder($this);
         if (!$item->getId()) {
             $this->setItems(array_merge($this->getItems(), [$item]));
         }
         return $this;
     }

◆ addRelatedObject()

addRelatedObject ( \Magento\Framework\Model\AbstractModel $object )

Add New object to related array

Parameters

\Magento\Framework\Model\AbstractModel $object

Returns: $this

Definition at line 1896 of file Order.php.

     {
         $this->_relatedObjects[] = $object;
         return $this;
     }

◆ addStatusHistory()

addStatusHistory ( \Magento\Sales\Model\Order\Status\History $history )

Adds the object to the status history collection, which is automatically saved when the order is saved. See the entity_id attribute backend model. Or the history record can be saved standalone after this.

Parameters

\Magento\Sales\Model\Order\Status\History $history

Returns: $this

Definition at line 1588 of file Order.php.

     {
         $history->setOrder($this);
         $this->setStatus($history->getStatus());
         if (!$history->getId()) {
             $this->setStatusHistories(array_merge($this->getStatusHistories(), [$history]));
             $this->setDataChanges(true);
         }
         return $this;
     }

◆ addStatusHistoryComment()

addStatusHistoryComment	(	$comment,
		$status = `false`
	)

Add a comment to order.

Different or default status may be specified.

Parameters

string	$comment
bool \| string	$status

Returns: OrderStatusHistoryInterface

Deprecated:: 101.0.5

See also: addCommentToStatusHistory

Definition at line 1022 of file Order.php.

     {
         return $this->addCommentToStatusHistory($comment, $status, false);
     }

◆ addStatusToHistory()

addStatusToHistory	(	$status,
		$comment = `''`,
		$isCustomerNotified = `false`
	)

Add status change information to history

Parameters

string	$status
string	$comment
bool	$isCustomerNotified

Returns: $this

Definition at line 1005 of file Order.php.

     {
         $this->addStatusHistoryComment($comment, $status)->setIsCustomerNotified($isCustomerNotified);
         return $this;
     }

◆ canCancel()

canCancel ( )

Retrieve order cancel availability

Returns: bool @SuppressWarnings(PHPMD.CyclomaticComplexity) @SuppressWarnings(PHPMD.NPathComplexity)

Definition at line 530 of file Order.php.

     {
         if (!$this->_canVoidOrder()) {
             return false;
         }
         if ($this->canUnhold()) {
             return false;
         }
         if (!$this->canReviewPayment() && $this->canFetchPaymentReviewUpdate()) {
             return false;
         }
 
         $allInvoiced = true;
         foreach ($this->getAllItems() as $item) {
             if ($item->getQtyToInvoice()) {
                 $allInvoiced = false;
                 break;
             }
         }
 
         if ($allInvoiced) {
             return false;
         }
 
         $state = $this->getState();
         if ($this->isCanceled() || $state === self::STATE_COMPLETE || $state === self::STATE_CLOSED) {
             return false;
         }
 
         if ($this->getActionFlag(self::ACTION_FLAG_CANCEL) === false) {
             return false;
         }
 
         return true;
     }

◆ cancel()

cancel ( )

Cancel order

Returns: $this

Definition at line 1137 of file Order.php.

     {
         if ($this->canCancel()) {
             $this->getPayment()->cancel();
             $this->registerCancellation();
 
             $this->_eventManager->dispatch('order_cancel_after', ['order' => $this]);
         }
 
         return $this;
     }

◆ canComment()

canComment ( )

Check if comment can be added to order history

Returns: bool

Definition at line 695 of file Order.php.

     {
         if ($this->getActionFlag(self::ACTION_FLAG_COMMENT) === false) {
             return false;
         }
         return true;
     }

◆ canCreditmemo()

canCreditmemo ( )

Retrieve order credit memo (refund) availability

Returns: bool

We can have problem with float in php (on some server $a=762.73;$b=762.73; $a-$b!=0) for this we have additional diapason for 0 TotalPaid - contains amount, that were not rounded.

Definition at line 619 of file Order.php.

     {
         if ($this->hasForcedCanCreditmemo()) {
             return $this->getForcedCanCreditmemo();
         }
 
         if ($this->canUnhold() || $this->isPaymentReview()) {
             return false;
         }
 
         if ($this->isCanceled() || $this->getState() === self::STATE_CLOSED) {
             return false;
         }
 
         $totalRefunded = $this->priceCurrency->round($this->getTotalPaid()) - $this->getTotalRefunded();
         if (abs($totalRefunded) < .0001) {
             return false;
         }
         // Case when Adjustment Fee (adjustment_negative) has been used for first creditmemo
         if (abs($totalRefunded - $this->getAdjustmentNegative()) < .0001) {
             return false;
         }
 
         if ($this->getActionFlag(self::ACTION_FLAG_EDIT) === false) {
             return false;
         }
         return true;
     }

◆ canEdit()

canEdit ( )

Retrieve order edit availability

Returns: bool

Definition at line 736 of file Order.php.

     {
         if ($this->canUnhold()) {
             return false;
         }
 
         $state = $this->getState();
         if ($this->isCanceled() ||
             $this->isPaymentReview() ||
             $state === self::STATE_COMPLETE ||
             $state === self::STATE_CLOSED
         ) {
             return false;
         }
 
         if ($this->hasInvoices()) {
             return false;
         }
 
         if (!$this->getPayment()->getMethodInstance()->canEdit()) {
             return false;
         }
 
         if ($this->getActionFlag(self::ACTION_FLAG_EDIT) === false) {
             return false;
         }
 
         return true;
     }

◆ canFetchPaymentReviewUpdate()

canFetchPaymentReviewUpdate ( )

Check whether there can be a transaction update fetched for payment in review state

Returns: bool

Definition at line 858 of file Order.php.

     {
         return $this->isPaymentReview() && $this->getPayment()->canFetchTransactionInfo();
     }

◆ canHold()

canHold ( )

Retrieve order hold availability

Returns: bool

Definition at line 658 of file Order.php.

     {
         $notHoldableStates = [
             self::STATE_CANCELED,
             self::STATE_PAYMENT_REVIEW,
             self::STATE_COMPLETE,
             self::STATE_CLOSED,
             self::STATE_HOLDED
         ];
         if (in_array($this->getState(), $notHoldableStates)) {
             return false;
         }
 
         if ($this->getActionFlag(self::ACTION_FLAG_HOLD) === false) {
             return false;
         }
         return true;
     }

◆ canInvoice()

canInvoice ( )

Retrieve order invoice availability

Returns: bool @SuppressWarnings(PHPMD.CyclomaticComplexity)

Definition at line 592 of file Order.php.

     {
         if ($this->canUnhold() || $this->isPaymentReview()) {
             return false;
         }
         $state = $this->getState();
         if ($this->isCanceled() || $state === self::STATE_COMPLETE || $state === self::STATE_CLOSED) {
             return false;
         }
 
         if ($this->getActionFlag(self::ACTION_FLAG_INVOICE) === false) {
             return false;
         }
 
         foreach ($this->getAllItems() as $item) {
             if ($item->getQtyToInvoice() > 0 && !$item->getLockedDoInvoice()) {
                 return true;
             }
         }
         return false;
     }

◆ canReorder()

canReorder ( )

Retrieve order reorder availability

Returns: bool

Definition at line 771 of file Order.php.

     {
         return $this->_canReorder(false);
     }

◆ canReorderIgnoreSalable()

canReorderIgnoreSalable ( )

Check the ability to reorder ignoring the availability in stock or status of the ordered products

Returns: bool

Definition at line 781 of file Order.php.

     {
         return $this->_canReorder(true);
     }

◆ canReviewPayment()

canReviewPayment ( )

Check whether payment can be accepted or denied

Returns: bool

Definition at line 848 of file Order.php.

     {
         return $this->isPaymentReview() && $this->getPayment()->canReviewPayment();
     }

◆ canShip()

canShip ( )

Retrieve order shipment availability

Returns: bool @SuppressWarnings(PHPMD.CyclomaticComplexity)

Definition at line 709 of file Order.php.

     {
         if ($this->canUnhold() || $this->isPaymentReview()) {
             return false;
         }
 
         if ($this->getIsVirtual() || $this->isCanceled()) {
             return false;
         }
 
         if ($this->getActionFlag(self::ACTION_FLAG_SHIP) === false) {
             return false;
         }
 
         foreach ($this->getAllItems() as $item) {
             if ($item->getQtyToShip() > 0 && !$item->getIsVirtual() && !$item->getLockedDoShip()) {
                 return true;
             }
         }
         return false;
     }

◆ canUnhold()

canUnhold ( )

Retrieve order unhold availability

Returns: bool

Definition at line 682 of file Order.php.

     {
         if ($this->getActionFlag(self::ACTION_FLAG_UNHOLD) === false || $this->isPaymentReview()) {
             return false;
         }
         return $this->getState() === self::STATE_HOLDED;
     }

◆ canVoidPayment()

canVoidPayment ( )

Getter whether the payment can be voided

Returns: bool

Definition at line 571 of file Order.php.

     {
         return $this->_canVoidOrder() ? $this->getPayment()->canVoid() : false;
     }

◆ formatBasePrice()

formatBasePrice ( $price )

Format BasePrice

Parameters

float $price

Returns: string

Definition at line 1682 of file Order.php.

     {
         return $this->formatBasePricePrecision($price, 2);
     }

◆ formatBasePricePrecision()

formatBasePricePrecision	(	$price,
		$precision
	)

Format BasePrice Precision

Parameters

float	$price
int	$precision

Returns: string

Definition at line 1694 of file Order.php.

     {
         return $this->getBaseCurrency()->formatPrecision($price, $precision);
     }

◆ formatPrice()

formatPrice	(	$price,
		$addBrackets = `false`
	)

Get formatted price value including order currency rate to order website currency

Parameters

float	$price
bool	$addBrackets

Returns: string

Definition at line 1634 of file Order.php.

     {
         return $this->formatPricePrecision($price, 2, $addBrackets);
     }

◆ formatPricePrecision()

formatPricePrecision	(	$price,
		$precision,
		$addBrackets = `false`
	)

Format price precision

Parameters

float	$price
int	$precision
bool	$addBrackets

Returns: string

Definition at line 1647 of file Order.php.

     {
         return $this->getOrderCurrency()->formatPrecision($price, $precision, [], true, $addBrackets);
     }

◆ formatPriceTxt()

formatPriceTxt ( $price )

Retrieve text formatted price value including order rate

Parameters

float $price

Returns: string

Definition at line 1658 of file Order.php.

     {
         return $this->getOrderCurrency()->formatTxt($price);
     }

◆ getActionFlag()

getActionFlag ( $action )

Retrieve can flag for action (edit, unhold, etc..)

Parameters

string $action

Returns: boolean|null

Definition at line 407 of file Order.php.

     {
         if (isset($this->_actionFlag[$action])) {
             return $this->_actionFlag[$action];
         }
         return null;
     }

◆ getAddressById()

getAddressById ( $addressId )

Get address by id

Parameters

mixed $addressId

Returns: false

Definition at line 1264 of file Order.php.

     {
         foreach ($this->getAddressesCollection() as $address) {
             if ($address->getId() == $addressId) {
                 return $address;
             }
         }
         return false;
     }

◆ getAddresses()

getAddresses ( )

Get addresses

Returns: \Magento\Sales\Api\Data\OrderAddressInterface[]

Definition at line 2044 of file Order.php.

     {
         if ($this->getData('addresses') == null) {
             $this->setData(
                 'addresses',
                 $this->getAddressesCollection()->getItems()
             );
         }
         return $this->getData('addresses');
     }

◆ getAddressesCollection()

getAddressesCollection ( )

Get addresses collection

Returns: Collection

Definition at line 1247 of file Order.php.

     {
         $collection = $this->_addressCollectionFactory->create()->setOrderFilter($this);
         if ($this->getId()) {
             foreach ($collection as $address) {
                 $address->setOrder($this);
             }
         }
         return $collection;
     }

◆ getAdjustmentNegative()

getAdjustmentNegative ( )

Return adjustment_negative

Returns: float|null

getItemsCollection	(	$filterByTypes = `[]`,
		$nonChildrenOnly = `false`
	)

registerCancellation	(	$comment = `''`,
		$graceful = `true`
	)

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _canReorder()

◆ _canVoidOrder()

◆ _construct()

◆ _getItemsRandomCollection()

◆ _placePayment()

◆ addAddress()

◆ addCommentToStatusHistory()

◆ addItem()

◆ addRelatedObject()

◆ addStatusHistory()

◆ addStatusHistoryComment()

◆ addStatusToHistory()

◆ canCancel()

◆ cancel()

◆ canComment()

◆ canCreditmemo()

◆ canEdit()

◆ canFetchPaymentReviewUpdate()

◆ canHold()

◆ canInvoice()

◆ canReorder()

◆ canReorderIgnoreSalable()

◆ canReviewPayment()

◆ canShip()

◆ canUnhold()

◆ canVoidPayment()

◆ formatBasePrice()

◆ formatBasePricePrecision()

◆ formatPrice()

◆ formatPricePrecision()

◆ formatPriceTxt()

◆ getActionFlag()

◆ getAddressById()

◆ getAddresses()

◆ getAddressesCollection()

◆ getAdjustmentNegative()

◆ getAdjustmentPositive()

◆ getAllItems()

◆ getAllPayments()

◆ getAllStatusHistory()

◆ getAllVisibleItems()

◆ getAppliedRuleIds()

◆ getBaseAdjustmentNegative()

◆ getBaseAdjustmentPositive()

◆ getBaseCurrency()

◆ getBaseCurrencyCode()

◆ getBaseDiscountAmount()

◆ getBaseDiscountCanceled()

◆ getBaseDiscountInvoiced()

◆ getBaseDiscountRefunded()

◆ getBaseDiscountTaxCompensationAmount()

◆ getBaseDiscountTaxCompensationInvoiced()

◆ getBaseDiscountTaxCompensationRefunded()

◆ getBaseGrandTotal()

◆ getBaseShippingAmount()

◆ getBaseShippingCanceled()

◆ getBaseShippingDiscountAmount()

◆ getBaseShippingDiscountTaxCompensationAmnt()

◆ getBaseShippingInclTax()

◆ getBaseShippingInvoiced()

◆ getBaseShippingRefunded()

◆ getBaseShippingTaxAmount()

◆ getBaseShippingTaxRefunded()

◆ getBaseSubtotal()

◆ getBaseSubtotalCanceled()

◆ getBaseSubtotalInclTax()

◆ getBaseSubtotalInvoiced()

◆ getBaseSubtotalRefunded()

◆ getBaseTaxAmount()

◆ getBaseTaxCanceled()

◆ getBaseTaxInvoiced()