Documentation

Mage_Sales_Model_Order extends Mage_Sales_Model_Abstract

in package

• Mage
• Sales

Order model

Table of Contents

Constants

ACTION_FLAG_CANCEL  : mixed = 'cancel'

Order flags

ACTION_FLAG_COMMENT  : mixed = 'comment'

ACTION_FLAG_CREDITMEMO  : mixed = 'creditmemo'

ACTION_FLAG_EDIT  : mixed = 'edit'

ACTION_FLAG_HOLD  : mixed = 'hold'

ACTION_FLAG_INVOICE  : mixed = 'invoice'

ACTION_FLAG_PRODUCTS_PERMISSION_DENIED  : mixed = 'product_permission_denied'

ACTION_FLAG_REORDER  : mixed = 'reorder'

ACTION_FLAG_SHIP  : mixed = 'ship'

ACTION_FLAG_UNHOLD  : mixed = 'unhold'

EMAIL_EVENT_NAME_NEW_ORDER  : mixed = 'new_order'

Event type names for order emails

EMAIL_EVENT_NAME_UPDATE_ORDER  : mixed = 'update_order'

ENTITY  : mixed = 'order'

Identifier for history item

HISTORY_ENTITY_NAME  : mixed = 'order'

Identifier for history item

REPORT_DATE_TYPE_CREATED  : mixed = 'created'

Report date types

REPORT_DATE_TYPE_UPDATED  : mixed = 'updated'

STATE_CANCELED  : mixed = 'canceled'

STATE_CLOSED  : mixed = 'closed'

STATE_COMPLETE  : mixed = 'complete'

STATE_HOLDED  : mixed = 'holded'

STATE_NEW  : mixed = 'new'

Order states

STATE_PAYMENT_REVIEW  : mixed = 'payment_review'

STATE_PENDING_PAYMENT  : mixed = 'pending_payment'

STATE_PROCESSING  : mixed = 'processing'

STATUS_FRAUD  : mixed = 'fraud'

Order statuses

XML_PATH_EMAIL_COPY_METHOD  : mixed = 'sales_email/order/copy_method'

XML_PATH_EMAIL_COPY_TO  : mixed = 'sales_email/order/copy_to'

XML_PATH_EMAIL_ENABLED  : mixed = 'sales_email/order/enabled'

XML_PATH_EMAIL_GUEST_TEMPLATE  : mixed = 'sales_email/order/guest_template'

XML_PATH_EMAIL_IDENTITY  : mixed = 'sales_email/order/identity'

XML_PATH_EMAIL_TEMPLATE  : mixed = 'sales_email/order/template'

XML configuration paths

XML_PATH_UPDATE_EMAIL_COPY_METHOD  : mixed = 'sales_email/order_comment/copy_method'

XML_PATH_UPDATE_EMAIL_COPY_TO  : mixed = 'sales_email/order_comment/copy_to'

XML_PATH_UPDATE_EMAIL_ENABLED  : mixed = 'sales_email/order_comment/enabled'

XML_PATH_UPDATE_EMAIL_GUEST_TEMPLATE  : mixed = 'sales_email/order_comment/guest_template'

XML_PATH_UPDATE_EMAIL_IDENTITY  : mixed = 'sales_email/order_comment/identity'

XML_PATH_UPDATE_EMAIL_TEMPLATE  : mixed = 'sales_email/order_comment/template'

Properties

$_actionFlag  : array<string|int, mixed>

Array of action flags for canUnhold, canEdit, etc.

$_addresses  : Mage_Sales_Model_Resource_Order_Address_Collection|array<string|int, Mage_Sales_Model_Order_Address>|null

$_baseCurrency  : mixed

$_cacheTag  : string|bool|array<string|int, mixed>

Model cache tag for clear cache in after save and after delete

$_canSendNewEmailFlag  : bool

Flag: if after order placing we can send new email to the customer.

$_creditmemos  : Mage_Sales_Model_Resource_Order_Creditmemo_Collection|array<string|int, Mage_Sales_Model_Order_Creditmemo>|false|null

$_data  : array<string|int, mixed>|null

Object attributes

$_dataSaveAllowed  : bool

Flag which can stop data saving after before save Can be used for next sequence: we check data in _beforeSave, if data are not valid - we can set this flag to false value and save process will be stopped

$_dirty  : array<string|int, mixed>

$_eventObject  : mixed

$_eventPrefix  : mixed

$_hasDataChanges  : bool

Data changes flag (true after setData|unsetData call)

$_historyEntityName  : string

Identifier for history item

$_idFieldName  : string

Name of object id field

$_invoices  : Mage_Sales_Model_Resource_Order_Invoice_Collection|null

$_isDeleted  : bool

Object delete flag

$_isObjectNew  : bool|null

Flag which allow detect object state: is it new object (without id) or existing one (with id)

$_items  : Mage_Sales_Model_Resource_Order_Item_Collection|array<string|int, Mage_Sales_Model_Order_Item>|null

$_oldFieldsMap  : array<string|int, mixed>

Map short fields names to its full names

$_orderCurrency  : mixed

$_origData  : array<string|int, mixed>|null

Original data that was loaded

$_payments  : Mage_Sales_Model_Resource_Order_Payment_Collection|array<string|int, Mage_Sales_Model_Order_Payment>|null

$_relatedObjects  : mixed

$_resource  : Mage_Core_Model_Resource_Db_Abstract

Resource model instance

$_resourceCollectionName  : string

Name of the resource collection model

$_resourceName  : string

Name of the resource model

$_shipments  : Mage_Sales_Model_Resource_Order_Shipment_Collection|false|null

$_statusHistory  : Mage_Sales_Model_Resource_Order_Status_History_Collection|array<string|int, Mage_Sales_Model_Order_Status_History>|null

$_syncFieldsMap  : mixed

Map of fields to sync to other fields upon changing their data

$_tracks  : Mage_Sales_Model_Resource_Order_Shipment_Track_Collection|null

$_underscoreCache  : array<string|int, mixed>

Setter/Getter underscore transformation cache

Methods

__call()  : mixed

Set/Get attribute wrapper

__construct()  : mixed

Constructor

__get()  : mixed

Attribute getter (deprecated)

__set()  : mixed

Attribute setter (deprecated)

__toArray()  : array<string|int, mixed>

Convert object attributes to array

_getResource()  : Mage_Sales_Model_Resource_Order

Get resource instance

addAddress()  : $this

addData()  : $this

Add data to the object.

addItem()  : $this

addPayment()  : $this

addRelatedObject()  : $this

Add New object to related array

addStatusHistory()  : $this

Set the order status history object and the order object to each other Adds the object to the status history collection, which is automatically saved when the order is saved.

addStatusHistoryComment()  : Mage_Sales_Model_Order_Status_History

Add a comment to order Different or default status may be specified

afterCommitCallback()  : Mage_Core_Model_Abstract

Processing object after save data Updates relevant grid table records.

afterLoad()  : $this

Object after load processing. Implemented as public interface for supporting objects after load in collections

canCancel()  : bool

Retrieve order cancel availability

cancel()  : $this

Cancel order

canComment()  : bool

Check if comment can be added to order history

canCreditmemo()  : bool

Retrieve order credit memo (refund) availability

canEdit()  : bool

Retrieve order edit availability

canFetchPaymentReviewUpdate()  : bool

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

canHold()  : bool

Retrieve order hold availability

canInvoice()  : bool

Retrieve order invoice availability

canReorder()  : bool

Retrieve order reorder availability

canReorderIgnoreSalable()  : bool

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

canReviewPayment()  : bool

Check whether payment can be accepted or denied

canShip()  : bool

Retrieve order shipment availability

canUnhold()  : bool

Retrieve order unhold availability

canVoidPayment()  : bool

Getter whether the payment can be voided

cleanModelCache()  : $this

Remove model object related cache

clearInstance()  : $this

Clearing object for correct deleting by garbage collector

dataHasChangedFor()  : bool

Compare object data with original data

debug()  : string|array<string|int, mixed>

Present object data as string in debug mode

delete()  : $this

Delete object from database

flagDirty()  : $this

formatBasePrice()  : string

formatBasePricePrecision()  : string

formatPrice()  : string

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

formatPricePrecision()  : string

formatPriceTxt()  : string

Retrieve currency formatted string.

getActionFlag()  : bool|null

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

getAddressById()  : false|Mage_Sales_Model_Order_Address

getAddressesCollection()  : Mage_Sales_Model_Resource_Order_Address_Collection

getAdjustmentNegative()  : float|null

getAdjustmentPositive()  : float|null

getAllItems()  : array<string|int, Mage_Sales_Model_Order_Item>

getAllPayments()  : array<string|int, Mage_Sales_Model_Order_Payment>

getAllStatusHistory()  : array<string|int, Mage_Sales_Model_Order_Status_History>

Return collection of order status history items.

getAllVisibleItems()  : array<string|int, mixed>

getAppliedRuleIds()  : string|null

getAppliedTaxes()  : array<string|int, mixed>|null

getAppliedTaxIsSaved()  : bool|null

getBackUrl()  : string|null

getBaseAdjustmentNegative()  : float|null

getBaseAdjustmentPositive()  : float|null

getBaseCurrency()  : Mage_Directory_Model_Currency

Retrieve order website currency for working with base prices

getBaseCurrencyCode()  : string|null

getBaseDiscountAmount()  : float|null

getBaseDiscountCanceled()  : float|null

getBaseDiscountInvoiced()  : float|null

getBaseDiscountRefunded()  : float|null

getBaseGrandTotal()  : float|null

getBaseHiddenTaxAmount()  : float|null

getBaseHiddenTaxInvoiced()  : float|null

getBaseHiddenTaxRefunded()  : float|null

getBaseShippingAmount()  : float|null

getBaseShippingCanceled()  : float|null

getBaseShippingDiscountAmount()  : float|null

getBaseShippingHiddenTaxAmount()  : float|null

getBaseShippingHiddenTaxInvoiced()  : float|null

getBaseShippingHiddenTaxRefunded()  : float|null

getBaseShippingInclTax()  : float|null

getBaseShippingInvoiced()  : float|null

getBaseShippingRefunded()  : float|null

getBaseShippingTaxAmount()  : float|null

getBaseShippingTaxInvoiced()  : float|null

getBaseShippingTaxRefunded()  : float|null

getBaseSubtotal()  : float|null

getBaseSubtotalCanceled()  : float|null

getBaseSubtotalInclTax()  : float|null

getBaseSubtotalInvoiced()  : float|null

getBaseSubtotalRefunded()  : float|null

getBaseTaxAmount()  : float|null

getBaseTaxCanceled()  : float|null

getBaseTaxInvoiced()  : float|null

getBaseTaxRefunded()  : float|null

getBaseToGlobalRate()  : float|null

getBaseToOrderRate()  : float|null

getBaseTotalCanceled()  : float|null

getBaseTotalDue()  : float

Retrieve order total due value

getBaseTotalInvoiced()  : float|null

getBaseTotalInvoicedCost()  : float|null

getBaseTotalOfflineRefunded()  : float|null

getBaseTotalOnlineRefunded()  : float|null

getBaseTotalPaid()  : float|null

getBaseTotalQtyOrdered()  : float|null

getBaseTotalRefunded()  : float|null

getBillingAddress()  : Mage_Sales_Model_Order_Address|null

Retrieve order billing address

getBillingAddressId()  : int|null

getBillingFirstname()  : string|null

getBillingLastname()  : string|null

getCacheIdTags()  : array<string|int, mixed>|false

Get cache tags associated with object id

getCacheTags()  : array<string|int, mixed>|false

Get list of cache tags applied to model object.

getCanReturnToStock()  : bool|null

getCanSendNewEmailFlag()  : bool

Return flag for order if it can sends new email to customer.

getCanShipPartially()  : bool|null

getCanShipPartiallyItem()  : bool|null

getCollection()  : Mage_Sales_Model_Resource_Order_Collection

getConfig()  : Mage_Sales_Model_Order_Config

Retrieve order configuration model

getConvertingFromQuote()  : bool|null

getCouponCode()  : string|null

getCreatedAt()  : string|null

getCreatedAtDate()  : DateTimeImmutable

Get object created at date affected current active store timezone

getCreatedAtFormated()  : string

Get formatted order created date in store timezone

getCreatedAtStoreDate()  : DateTimeImmutable

Get object created at date affected with object store timezone

getCreditmemosCollection()  : Mage_Sales_Model_Resource_Order_Creditmemo_Collection|array<string|int, Mage_Sales_Model_Order_Creditmemo>|false

Retrieve order creditmemos collection

getCurrentCustomerEmail()  : string

Get the current customer email.

getCustomer()  : Mage_Customer_Model_Customer|null

getCustomerDob()  : string|null

getCustomerEmail()  : string|null

getCustomerFirstname()  : string|null

getCustomerGender()  : int|null

getCustomerGroupId()  : int|null

getCustomerId()  : int|null

getCustomerIsGuest()  : bool|null

getCustomerLastname()  : string|null

getCustomerMiddlename()  : string|null

getCustomerName()  : string

Retrieve customer name

getCustomerNote()  : string|null

getCustomerNoteNotify()  : bool|null

getCustomerPrefix()  : string|null

getCustomerSuffix()  : string|null

getCustomerTaxvat()  : string|null

getData()  : float|mixed

Object data getter

getDataByKey()  : mixed

Get object data by particular key

getDataByPath()  : mixed

Get object data by path

getDataSetDefault()  : mixed

Fast get data or set default if value is not available

getDataUsingMethod()  : mixed

Get object data by key with calling getter method

getDiscountAmount()  : float|null

getDiscountCanceled()  : float|null

getDiscountDescription()  : string|null

getDiscountInvoiced()  : float|null

getDiscountRefunded()  : float|null

getEditIncrement()  : int|null

getEmailCustomerNote()  : string

getEmailSent()  : bool|null

getEntityId()  : int

getExtCustomerId()  : string|null

getExtOrderId()  : string|null

getForcedCanCreditmemo()  : bool|null

getForcedDoShipmentWithInvoice()  : int|null

getForceUpdateGridRecords()  : bool|null

getFullTaxInfo()  : mixed

getGiftMessageId()  : int|null

getGlobalCurrencyCode()  : string|null

getGrandTotal()  : float|null

getHiddenTaxAmount()  : float|null

getHiddenTaxInvoiced()  : float|null

getHiddenTaxRefunded()  : float|null

getHoldBeforeState()  : string|null

getHoldBeforeStatus()  : string|null

getId()  : int|string|null

Retrieve model object identifier

getIdFieldName()  : string

Retrieve identifier field name for model

getIncrementId()  : string|null

getInvoiceCollection()  : Mage_Sales_Model_Resource_Order_Invoice_Collection

Retrieve order invoices collection

getInvoicesCollection()  : Mage_Sales_Model_Resource_Order_Invoice_Collection

Retrieve order invoices collection

getIsInProcess()  : bool|null

getIsMultiPayment()  : bool|null

getIsNotVirtual()  : bool

getIsVirtual()  : bool|null

getItemById()  : Mage_Sales_Model_Order_Item|null

getItemByQuoteItemId()  : Mage_Sales_Model_Order_Item|null

getItemsCollection()  : Mage_Sales_Model_Resource_Order_Item_Collection

getItemsRandomCollection()  : Mage_Sales_Model_Resource_Order_Item_Collection

Get random items collection with related children

getOrderCurrency()  : Mage_Directory_Model_Currency

Get currency model instance. Will be used currency with which order placed

getOrderCurrencyCode()  : string|null

getOrigData()  : mixed

Get object loaded data (original data)

getOriginalIncrementId()  : string|null

getParentItemsRandomCollection()  : Mage_Sales_Model_Resource_Order_Item_Collection

Get random items collection without related children

getPayment()  : Mage_Sales_Model_Order_Payment|false

Retrieve order payment model object

getPaymentAuthorizationAmount()  : float|null

getPaymentAuthorizationExpiration()  : int|null

getPaymentById()  : bool|Mage_Sales_Model_Order_Payment

getPaymentsCollection()  : Mage_Sales_Model_Resource_Order_Payment_Collection

getPaypalIpnCustomerNotified()  : int|null

getProtectCode()  : string|null

getQuantity()  : float|null

getQuote()  : Mage_Sales_Model_Quote|null

getQuoteAddressId()  : int|null

getQuoteBaseGrandTotal()  : float|null

getQuoteId()  : int|null

getRealOrderId()  : string

getRelatedObjects()  : array<string|int, mixed>

Retrieve array of related objects

getRelationChildId()  : string|null

getRelationChildRealId()  : string|null

getRelationParentId()  : string|null

getRelationParentRealId()  : string|null

getRemoteIp()  : string|null

getReordered()  : bool|null

getResource()  : Mage_Sales_Model_Resource_Order

Retrieve model resource

getResourceCollection()  : Mage_Core_Model_Resource_Db_Collection_Abstract

Get collection instance

getResourceName()  : string

Retrieve model resource name

getRevenue()  : float|null

getRowTaxDisplayPrecision()  : int|null

getShipmentsCollection()  : Mage_Sales_Model_Resource_Order_Shipment_Collection|false

Retrieve order shipments collection

getShipping()  : float|null

getShippingAddress()  : Mage_Sales_Model_Order_Address|null

Retrieve order shipping address

getShippingAddressId()  : int|null

getShippingAmount()  : float|null

getShippingCanceled()  : float|null

getShippingCarrier()  : Mage_Shipping_Model_Carrier_Abstract

Return model of shipping carrier

getShippingDescription()  : string|null

getShippingDiscountAmount()  : float|null

getShippingHiddenTaxAmount()  : float|null

getShippingHiddenTaxInvoiced()  : float|null

getShippingHiddenTaxRefunded()  : float|null

getShippingInclTax()  : float|null

getShippingInvoiced()  : float|null

getShippingMethod()  : string|DataObject

Retrieve shipping method

getShippingRefunded()  : float|null

getShippingTaxAmount()  : float|null

getShippingTaxInvoiced()  : float|null

getShippingTaxRefunded()  : float|null

getState()  : string|null

getStatus()  : string|null

getStatusHistoryById()  : false|Mage_Sales_Model_Order_Status_History

getStatusHistoryCollection()  : Mage_Sales_Model_Resource_Order_Status_History_Collection

getStatusLabel()  : string

Retrieve label of order status

getStore()  : Mage_Core_Model_Store

Retrieve store model instance

getStoreCurrencyCode()  : string|null

getStoreGroupName()  : string|null

getStoreId()  : int|null

getStoreName()  : string|null

getStoreToBaseRate()  : float|null

getStoreToOrderRate()  : float|null

getSubtotal()  : float|null

getSubtotalCanceled()  : float|null

getSubtotalInclTax()  : float|null

getSubtotalInvoiced()  : float|null

getSubtotalRefunded()  : float|null

getTax()  : float|null

getTaxAmount()  : float|null

getTaxCanceled()  : float|null

getTaxInvoiced()  : float|null

getTaxRefunded()  : float|null

getTotalCanceled()  : float|null

getTotalDue()  : float

Retrieve order total due value

getTotalInvoiced()  : float|null

getTotalItemCount()  : int|null

getTotalOfflineRefunded()  : float|null

getTotalOnlineRefunded()  : float|null

getTotalPaid()  : float|null

getTotalQtyOrdered()  : float|null

getTotalRefunded()  : float|null

getTrackingNumbers()  : array<string|int, mixed>

Retrieve tracking numbers

getTracksCollection()  : Mage_Sales_Model_Resource_Order_Shipment_Track_Collection

Retrieve order tracking numbers collection

getUpdatedAt()  : string|null

getVisibleStatusHistory()  : array<string|int, mixed>

Return collection of visible on frontend order status history items.

getWeight()  : float|null

getXForwardedFor()  : string|null

hasBillingAddressId()  : bool

hasCanReturnToStock()  : bool

hasCreditmemos()  : bool

Check order creditmemos availability

hasCustomerNoteNotify()  : bool

hasData()  : bool

If $key is empty, checks whether there's any data in the object Otherwise checks if the specified attribute is set.

hasDataChanges()  : bool

Get data change status

hasErrors()  : bool

hasForcedCanCreditmemo()  : bool

hasInvoices()  : int

Check order invoices availability

hasShipments()  : bool

Check order shipments availability

hasShippingAddressId()  : bool

hold()  : $this

isCanceled()  : bool

Check whether order is canceled

isCurrencyDifferent()  : bool

isDeleted()  : bool

Set _isDeleted flag value (if $isDeleted param is defined) and return current flag value

isDirty()  : bool

isEmpty()  : bool

checks whether the object is empty

isModuleEnabled()  : bool

isNominal()  : bool

Whether the order has nominal items only

isObjectNew()  : bool

Check object state (true - if it is object without id on object just created) This method can help detect if object just created in _afterSave method problem is what in after save object has id and we can't detect what object was created in this transaction

isPaymentReview()  : bool

Check whether the payment is in payment review state In this state order cannot be normally processed. Possible actions can be: - accept or deny payment - fetch transaction information

isStateProtected()  : bool

Whether specified state can be set from outside

isStatusValidForState()  : bool

Whether the status is assigned to the given state (defaults to the order's current state)

jsonSerialize()  : array<string|int, mixed>

Implementation of JsonSerializable::jsonSerialize()

load()  : $this

Load object data

loadByAttribute()  : $this

Load order by custom attribute value. Attribute value should be unique

loadByIncrementId()  : $this

Load order by system increment identifier

offsetExists()  : bool

Implementation of ArrayAccess::offsetExists()

offsetGet()  : mixed

Implementation of ArrayAccess::offsetGet()

offsetSet()  : void

Implementation of ArrayAccess::offsetSet()

offsetUnset()  : void

Implementation of ArrayAccess::offsetUnset()

place()  : $this

Place order

prepareInvoice()  : Mage_Sales_Model_Order_Invoice

Create new invoice with maximum qty for invoice for each item

prepareShipment()  : Mage_Sales_Model_Order_Shipment

Create new shipment with maximum qty for shipping for each item

queueNewOrderEmail()  : $this

Queue email with new order data

queueOrderUpdateEmail()  : $this

Queue email with order update information

registerCancellation()  : $this

Prepare order totals to cancellation

reset()  : $this

Resets all data in object so after another load it will be complete new object

save()  : $this

Save object data

sendNewOrderEmail()  : $this

Send email with order data

sendOrderUpdateEmail()  : $this

Send email with order update information

serialize()  : string

serialize object attributes

setActionFlag()  : $this

Set can flag value for action (edit, unhold, etc...)

setAdjustmentNegative()  : static

setAdjustmentPositive()  : static

setAppliedRuleIds()  : static

setAppliedTaxes()  : static

setAppliedTaxIsSaved()  : static

setAttribute()  : $this

setBaseAdjustmentNegative()  : static

setBaseAdjustmentPositive()  : static

setBaseCurrencyCode()  : static

setBaseDiscountAmount()  : static

setBaseDiscountCanceled()  : static

setBaseDiscountInvoiced()  : static

setBaseDiscountRefunded()  : static

setBaseGrandTotal()  : static

setBaseHiddenTaxAmount()  : static

setBaseHiddenTaxInvoiced()  : static

setBaseHiddenTaxRefunded()  : static

setBaseShippingAmount()  : static

setBaseShippingCanceled()  : static

setBaseShippingDiscountAmount()  : static

setBaseShippingHiddenTaxAmount()  : static

setBaseShippingInclTax()  : static

setBaseShippingInvoiced()  : static

setBaseShippingRefunded()  : static

setBaseShippingTaxAmount()  : static

setBaseShippingTaxInvoiced()  : static

setBaseShippingTaxRefunded()  : static

setBaseSubtotal()  : static

setBaseSubtotalCanceled()  : static

setBaseSubtotalInclTax()  : static

setBaseSubtotalInvoiced()  : static

setBaseSubtotalRefunded()  : static

setBaseTaxAmount()  : static

setBaseTaxCanceled()  : static

setBaseTaxInvoiced()  : static

setBaseTaxRefunded()  : static

setBaseToGlobalRate()  : static

setBaseToOrderRate()  : static

setBaseTotalCanceled()  : static

setBaseTotalDue()  : static

setBaseTotalInvoiced()  : static

setBaseTotalInvoicedCost()  : static

setBaseTotalOfflineRefunded()  : static

setBaseTotalOnlineRefunded()  : static

setBaseTotalPaid()  : static

setBaseTotalQtyOrdered()  : static

setBaseTotalRefunded()  : static

setBillingAddress()  : $this

Declare order billing address

setBillingAddressId()  : static

setCanReturnToStock()  : static

setCanSendNewEmailFlag()  : $this

Set flag for order if it can sends new email to customer.

setCanShipPartially()  : static

setCanShipPartiallyItem()  : static

setConvertingFromQuote()  : static

setCouponCode()  : static

setCouponRuleName()  : static

setCreatedAt()  : static

setCustomer()  : static

setCustomerDob()  : static

setCustomerEmail()  : static

setCustomerFirstname()  : static

setCustomerGender()  : static

setCustomerGroupId()  : static

setCustomerId()  : static

setCustomerIsGuest()  : static

setCustomerLastname()  : static

setCustomerMiddlename()  : static

setCustomerNote()  : static

setCustomerNoteNotify()  : static

setCustomerPrefix()  : static

setCustomerSuffix()  : static

setCustomerTaxvat()  : static

setData()  : $this

Overwrite data in the object.

setDataChanges()  : $this

Clears data changes status

setDataUsingMethod()  : $this

Set object data with calling setter method

setDiscountAmount()  : static

setDiscountCanceled()  : static

setDiscountDescription()  : static

setDiscountInvoiced()  : static

setDiscountRefunded()  : static

setEditIncrement()  : static

setEmailSent()  : static

setExtCustomerId()  : static

setExtOrderId()  : static

setForcedCanCreditmemo()  : static

setForcedDoShipmentWithInvoice()  : static

setGiftMessage()  : static

setGiftMessageId()  : static

setGlobalCurrencyCode()  : static

setGrandTotal()  : static

setHiddenTaxAmount()  : static

setHiddenTaxInvoiced()  : static

setHiddenTaxRefunded()  : static

setHistoryEntityName()  : $this

Overrides entity id, which will be saved to comments history status

setHoldBeforeState()  : static

setHoldBeforeStatus()  : static

setId()  : $this

Declare model object identifier value

setIdFieldName()  : $this

set name of object id field

setIncrementId()  : static

setIsInProcess()  : static

setIsVirtual()  : static

setOrderCurrencyCode()  : static

setOrigData()  : $this

Initialize object original data

setOriginalIncrementId()  : static

setPayment()  : Mage_Sales_Model_Order_Payment

setPaymentAuthorizationAmount()  : static

setPaymentAuthorizationExpiration()  : static

setPaypalIpnCustomerNotified()  : static

setProtectCode()  : static

setQuote()  : static

setQuoteAddressId()  : static

setQuoteId()  : static

setRelationChildId()  : static

setRelationChildRealId()  : static

setRelationParentId()  : static

setRelationParentRealId()  : static

setRemoteIp()  : static

setShippingAddress()  : $this

Declare order shipping address

setShippingAddressId()  : static

setShippingAmount()  : static

setShippingCanceled()  : static

setShippingDescription()  : static

setShippingDiscountAmount()  : static

setShippingHiddenTaxAmount()  : static

setShippingInclTax()  : static

setShippingInvoiced()  : static

setShippingMethod()  : static

setShippingRefunded()  : static

setShippingTaxAmount()  : static

setShippingTaxInvoiced()  : static

setShippingTaxRefunded()  : static

setState()  : $this

Order state setter.

setStatus()  : static

setStoreCurrencyCode()  : static

setStoreId()  : static

setStoreName()  : static

setStoreToBaseRate()  : static

setStoreToOrderRate()  : static

setSubtotal()  : static

setSubtotalCanceled()  : static

setSubtotalInclTax()  : static

setSubtotalInvoiced()  : static

setSubtotalRefunded()  : static

setTaxAmount()  : static

setTaxCanceled()  : static

setTaxInvoiced()  : static

setTaxRefunded()  : static

setTotalCanceled()  : static

setTotalDue()  : static

setTotalInvoiced()  : static

setTotalItemCount()  : static

setTotalOfflineRefunded()  : static

setTotalOnlineRefunded()  : static

setTotalPaid()  : static

setTotalQtyOrdered()  : static

setTotalRefunded()  : static

setTransactionId()  : static

setUpdatedAt()  : static

setWeight()  : static

setXForwardedFor()  : static

toArray()  : array<string|int, mixed>

Public wrapper for __toArray

toJson()  : string

Public wrapper for __toJson

toString()  : string

Public wrapper for __toString

toXml()  : string

Public wrapper for __toXml

unhold()  : $this

Attempt to unhold the order

unsBillingAddressId()  : $this

unsetData()  : $this

Clear order object data

unsetOldData()  : $this

Unset old fields data from the object.

unsShippingAddressId()  : $this

__toJson()  : string

Convert object attributes to JSON

__toXml()  : string

Convert object attributes to XML

_addFullNames()  : mixed

_addPdfAttachment()  : void

Attach a PDF copy of this document to the given email info, if it has a PDF form

_afterDelete()  : $this

Processing object after delete data

_afterDeleteCommit()  : $this

Processing manipulation after main transaction commit

_afterLoad()  : $this

Processing object after load data

_afterSave()  : $this

Save order related objects

_assertStatusValidForState()  : void

_beforeDelete()  : $this

Protect order delete from not admin scope

_beforeLoad()  : $this

Processing object before load data

_beforeSave()  : Mage_Core_Model_Abstract

Processing object before save data

_camelize()  : string

_canReorder()  : bool

Retrieve order reorder availability

_canVoidOrder()  : bool

Check whether order could be canceled by states and flags

_checkState()  : mixed

Check order state before saving

_checkStatus()  : void

Safety net for status writes that bypass setState() and addStatusHistoryComment().

_clearData()  : $this

Clearing object's data

_clearReferences()  : $this

Clearing cyclic references

_construct()  : void

Internal constructor not depended on params. Can be used for object initialization

_getData()  : mixed

Get value from _data array without parse key

_getEmails()  : array<string|int, mixed>|false

_getEventData()  : array<string|int, mixed>

Get array of objects transferred to default events processing

_getItemsRandomCollection()  : Mage_Sales_Model_Resource_Order_Item_Collection

Get random items collection with or without related children

_getPdfAttachmentInfo()  : array{source_model: string, entity_model: string, filename_prefix: string}|null

Descriptor for attaching this document as a PDF to an email, or null when the document has no printable PDF form. Overridden by invoice/shipment/creditmemo.

_hasModelChanged()  : bool

Check whether model has changed data.

_init()  : mixed

Standard model initialization

_initOldFieldsMap()  : DataObject

Init mapping array of short fields to its full names

_placePayment()  : $this

Place order payments

_prepareArray()  : array<string|int, mixed>

Set required array elements

_prepareSyncFieldsMap()  : $this

Called after old fields are inited. Forms synchronization map to sync old fields and new fields between each other.

_protectFromNonAdmin()  : mixed

Safeguard func that will check, if we are in admin area

_setResourceModel()  : mixed

Set resource names

_setState()  : $this

Order state protected setter.

_underscore()  : string

Converts field names for setters and getters