Class Mage_Sales_Model_Order

Order model

Supported events: sales_order_load_after sales_order_save_before sales_order_save_after sales_order_delete_before sales_order_delete_after

Varien_Object

Mage_Core_Model_Abstract

Mage_Sales_Model_Abstract

Mage_Sales_Model_Order

Package: Mage\Sales
Category: Mage
Copyright: Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)
License: Open Software License (OSL 3.0)
Author: Magento Core Team <core@magentocommerce.com>
Located at code/core/Mage/Sales/Model/Order.php

Methods summary
`protected`	# `_construct( )` Initialize resource model Initialize resource model
`protected Varien_Object`	# `_initOldFieldsMap( )` Init mapping array of short fields to its full names Init mapping array of short fields to its full names Returns `Varien_Object`
`public Mage_Sales_Model_Order`	# `unsetData( string $key = null )` Clear order object data Clear order object data Parameters `$key` `string` $key data key Returns `Mage_Sales_Model_Order`
`public boolean\|null`	# `getActionFlag( string $action )` Retrieve can flag for action (edit, unhold, etc..) Retrieve can flag for action (edit, unhold, etc..) Parameters `$action` `string` $action Returns `boolean\|null`
`public Mage_Sales_Model_Order`	# `setActionFlag( string $action, boolean $flag )` Set can flag value for action (edit, unhold, etc...) Set can flag value for action (edit, unhold, etc...) Parameters `$action` `string` $action `$flag` `boolean` $flag Returns `Mage_Sales_Model_Order`
`public boolean`	# `getCanSendNewEmailFlag( )` Return flag for order if it can sends new email to customer. Return flag for order if it can sends new email to customer. Returns `boolean`
`public Mage_Sales_Model_Order`	# `setCanSendNewEmailFlag( boolean $flag )` Set flag for order if it can sends new email to customer. Set flag for order if it can sends new email to customer. Parameters `$flag` `boolean` $flag Returns `Mage_Sales_Model_Order`
`public Mage_Sales_Model_Order`	# `loadByIncrementId( string $incrementId )` Load order by system increment identifier Load order by system increment identifier Parameters `$incrementId` `string` $incrementId Returns `Mage_Sales_Model_Order`
`public Mage_Sales_Model_Order`	# `loadByAttribute( string $attribute, string $value )` Load order by custom attribute value. Attribute value should be unique Load order by custom attribute value. Attribute value should be unique Parameters `$attribute` `string` $attribute `$value` `string` $value Returns `Mage_Sales_Model_Order`
`public Mage_Core_Model_Store`	# `getStore( )` Retrieve store model instance Retrieve store model instance Returns `Mage_Core_Model_Store`
`public boolean`	# `canCancel( )` Retrieve order cancel availability Retrieve order cancel availability Returns `boolean`
`public boolean`	# `canVoidPayment( )` Getter whether the payment can be voided Getter whether the payment can be voided Returns `boolean`
`public boolean`	# `canInvoice( )` Retrieve order invoice availability Retrieve order invoice availability Returns `boolean`
`public boolean`	# `canCreditmemo( )` Retrieve order credit memo (refund) availability Retrieve order credit memo (refund) availability Returns `boolean`
`public boolean`	# `canHold( )` Retrieve order hold availability Retrieve order hold availability Returns `boolean`
`public boolean`	# `canUnhold( )` Retrieve order unhold availability Retrieve order unhold availability Returns `boolean`
`public boolean`	# `canComment( )` Check if comment can be added to order history Check if comment can be added to order history Returns `boolean`
`public boolean`	# `canShip( )` Retrieve order shipment availability Retrieve order shipment availability Returns `boolean`
`public boolean`	# `canEdit( )` Retrieve order edit availability Retrieve order edit availability Returns `boolean`
`public boolean`	# `canReorder( )` Retrieve order reorder availability Retrieve order reorder availability Returns `boolean`
`public boolean`	# `canReorderIgnoreSalable( )` Check the ability to reorder ignoring the availability in stock or status of the ordered products Check the ability to reorder ignoring the availability in stock or status of the ordered products Returns `boolean`
`protected boolean`	# `_canReorder( boolean $ignoreSalable = false )` Retrieve order reorder availability Retrieve order reorder availability Parameters `$ignoreSalable` `boolean` $ignoreSalable Returns `boolean`
`public boolean`	# `isPaymentReview( )` 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 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 Returns `boolean`
`public boolean`	# `canReviewPayment( )` Check whether payment can be accepted or denied Check whether payment can be accepted or denied Returns `boolean`
`public boolean`	# `canFetchPaymentReviewUpdate( )` Check whether there can be a transaction update fetched for payment in review state Check whether there can be a transaction update fetched for payment in review state Returns `boolean`
`public Mage_Sales_Model_Order_Config`	# `getConfig( )` Retrieve order configuration model Retrieve order configuration model Returns `Mage_Sales_Model_Order_Config`
`protected Mage_Sales_Model_Order`	# `_placePayment( )` Place order payments Place order payments Returns `Mage_Sales_Model_Order`
`public Mage_Sales_Model_Order_Payment`	# `getPayment( )` Retrieve order payment model object Retrieve order payment model object Returns `Mage_Sales_Model_Order_Payment`
`public Mage_Sales_Model_Order`	# `setBillingAddress( Mage_Sales_Model_Order_Address $address )` Declare order billing address Declare order billing address Parameters `$address` `Mage_Sales_Model_Order_Address` $address Returns `Mage_Sales_Model_Order`
`public Mage_Sales_Model_Order`	# `setShippingAddress( Mage_Sales_Model_Order_Address $address )` Declare order shipping address Declare order shipping address Parameters `$address` `Mage_Sales_Model_Order_Address` $address Returns `Mage_Sales_Model_Order`
`public Mage_Sales_Model_Order_Address`	# `getBillingAddress( )` Retrieve order billing address Retrieve order billing address Returns `Mage_Sales_Model_Order_Address`
`public Mage_Sales_Model_Order_Address`	# `getShippingAddress( )` Retrieve order shipping address Retrieve order shipping address Returns `Mage_Sales_Model_Order_Address`
`public Mage_Sales_Model_Order`	# `setState( string $state, string\|boolean $status = false, string $comment = '', boolean $isCustomerNotified = null )` Order state setter. If status is specified, will add order status history with specified comment the setData() cannot be overriden because of compatibility issues with resource model Order state setter. If status is specified, will add order status history with specified comment the setData() cannot be overriden because of compatibility issues with resource model Parameters `$state` `string` $state `$status` `string\|boolean` $status `$comment` `string` $comment `$isCustomerNotified` `boolean` $isCustomerNotified Returns `Mage_Sales_Model_Order`
`protected Mage_Sales_Model_Order`	# `_setState( string $state, string\|boolean $status = false, string $comment = '', boolean $isCustomerNotified = null, mixed $shouldProtectState = false )` Order state protected setter. By default allows to set any state. Can also update status to default or specified value Сomplete and closed states are encapsulated intentionally, see the _checkState() Order state protected setter. By default allows to set any state. Can also update status to default or specified value Сomplete and closed states are encapsulated intentionally, see the _checkState() Parameters `$state` `string` $state `$status` `string\|boolean` $status `$comment` `string` $comment `$isCustomerNotified` `boolean` $isCustomerNotified `$shouldProtectState` `mixed` $shouldProtectState Returns `Mage_Sales_Model_Order`
`public boolean`	# `isStateProtected( mixed $state )` Whether specified state can be set from outside Whether specified state can be set from outside Parameters `$state` `mixed` $state Returns `boolean`
`public string`	# `getStatusLabel( )` Retrieve label of order status Retrieve label of order status Returns `string`
`public`	# `addStatusHistoryComment( mixed $comment, mixed $status = false )`
`public Mage_Sales_Model_Order`	# `setHistoryEntityName( string $entityName )` Overrides entity id, which will be saved to comments history status Overrides entity id, which will be saved to comments history status Parameters `$entityName` `string` $status Returns `Mage_Sales_Model_Order`
`public Mage_Sales_Model_Order`	# `place( )` Place order Place order Returns `Mage_Sales_Model_Order`
`public`	# `hold( )`
`public Mage_Sales_Model_Order`	# `unhold( )` Attempt to unhold the order Attempt to unhold the order Returns `Mage_Sales_Model_Order` Throws `Mage_Core_Exception`
`public Mage_Sales_Model_Order`	# `cancel( )` Cancel order Cancel order Returns `Mage_Sales_Model_Order`
`public Mage_Sales_Model_Order`	# `registerCancellation( string $comment = '', boolean $graceful = true )` Prepare order totals to cancellation Prepare order totals to cancellation Parameters `$comment` `string` $comment `$graceful` `boolean` $graceful Returns `Mage_Sales_Model_Order` Throws `Mage_Core_Exception`
`public array`	# `getTrackingNumbers( )` Retrieve tracking numbers Retrieve tracking numbers Returns `array`
`public boolean\|float\|Mage_Shipping_Model_Carrier_Abstract`	# `getShippingCarrier( )` Return model of shipping carrier Return model of shipping carrier Returns `boolean\|float\|Mage_Shipping_Model_Carrier_Abstract`
`public string\|Varien_Object`	# `getShippingMethod( boolean $asObject = false )` Retrieve shipping method Retrieve shipping method Parameters `$asObject` `boolean` $asObject return carrier code and shipping method data as object Returns `string\|Varien_Object`
`public Mage_Sales_Model_Order`	# `sendNewOrderEmail( )` Send email with order data Send email with order data Returns `Mage_Sales_Model_Order`
`public Mage_Sales_Model_Order`	# `sendOrderUpdateEmail( boolean $notifyCustomer = true, string $comment = '' )` Send email with order update information Send email with order update information Parameters `$notifyCustomer` `boolean` $notifyCustomer `$comment` `string` $comment Returns `Mage_Sales_Model_Order`
`protected`	# `_getEmails( mixed $configPath )`
`public`	# `getAddressesCollection( )`
`public`	# `getAddressById( mixed $addressId )`
`public`	# `addAddress( Mage_Sales_Model_Order_Address $address )`
`public`	# `getItemsCollection( mixed $filterByTypes = array(), mixed $nonChildrenOnly = false )`
`public Mage_Sales_Model_Mysql4_Order_Item_Collection`	# `getItemsRandomCollection( integer $limit = 1 )` Get random items collection with related children Get random items collection with related children Parameters `$limit` `integer` $limit Returns `Mage_Sales_Model_Mysql4_Order_Item_Collection`
`public Mage_Sales_Model_Mysql4_Order_Item_Collection`	# `getParentItemsRandomCollection( integer $limit = 1 )` Get random items collection without related children Get random items collection without related children Parameters `$limit` `integer` $limit Returns `Mage_Sales_Model_Mysql4_Order_Item_Collection`
`protected Mage_Sales_Model_Mysql4_Order_Item_Collection`	# `_getItemsRandomCollection( integer $limit, boolean $nonChildrenOnly = false )` Get random items collection with or without related children Get random items collection with or without related children Parameters `$limit` `integer` $limit `$nonChildrenOnly` `boolean` $nonChildrenOnly Returns `Mage_Sales_Model_Mysql4_Order_Item_Collection`
`public`	# `getAllItems( )`
`public`	# `getAllVisibleItems( )`
`public`	# `getItemById( mixed $itemId )`
`public`	# `getItemByQuoteItemId( mixed $quoteItemId )`
`public`	# `addItem( Mage_Sales_Model_Order_Item $item )`
`public boolean`	# `isNominal( )` Whether the order has nominal items only Whether the order has nominal items only Returns `boolean`
`public`	# `getPaymentsCollection( )`
`public`	# `getAllPayments( )`
`public`	# `getPaymentById( mixed $paymentId )`
`public`	# `addPayment( Mage_Sales_Model_Order_Payment $payment )`
`public`	# `setPayment( Mage_Sales_Model_Order_Payment $payment )`
`public Mage_Sales_Model_Entity_Order_Status_History_Collection`	# `getStatusHistoryCollection( mixed $reload = false )` Enter description here... Enter description here... Returns `Mage_Sales_Model_Entity_Order_Status_History_Collection`
`public array`	# `getAllStatusHistory( )` Return collection of order status history items. Return collection of order status history items. Returns `array`
`public array`	# `getVisibleStatusHistory( )` Return collection of visible on frontend order status history items. Return collection of visible on frontend order status history items. Returns `array`
`public`	# `getStatusHistoryById( mixed $statusId )`
`public Mage_Sales_Model_Order`	# `addStatusHistory( Mage_Sales_Model_Order_Status_History $history )` 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. See the entity_id attribute backend model. Or the history record can be saved standalone after 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. See the entity_id attribute backend model. Or the history record can be saved standalone after this. Parameters `$history` `Mage_Sales_Model_Order_Status_History` $status Returns `Mage_Sales_Model_Order`
`public string`	# `getRealOrderId( )` Enter description here... Enter description here... Returns `string`
`public Mage_Directory_Model_Currency`	# `getOrderCurrency( )` Get currency model instance. Will be used currency with which order placed Get currency model instance. Will be used currency with which order placed Returns `Mage_Directory_Model_Currency`
`public string`	# `formatPrice( float $price, boolean $addBrackets = false )` Get formated price value including order currency rate to order website currency Get formated price value including order currency rate to order website currency Parameters `$price` `float` $price `$addBrackets` `boolean` $addBrackets Returns `string`
`public`	# `formatPricePrecision( mixed $price, mixed $precision, mixed $addBrackets = false )`
`public string`	# `formatPriceTxt( float $price )` Retrieve text formated price value includeing order rate Retrieve text formated price value includeing order rate Parameters `$price` `float` $price Returns `string`
`public Mage_Directory_Model_Currency`	# `getBaseCurrency( )` Retrieve order website currency for working with base prices Retrieve order website currency for working with base prices Returns `Mage_Directory_Model_Currency`
`public`	# `formatBasePrice( mixed $price )`
`public`	# `formatBasePricePrecision( mixed $price, mixed $precision )`
`public`	# `isCurrencyDifferent( )`
`public float`	# `getTotalDue( )` Retrieve order total due value Retrieve order total due value Returns `float`
`public float`	# `getBaseTotalDue( )` Retrieve order total due value Retrieve order total due value Returns `float`
`public`	# `getData( mixed $key = '', mixed $index = null )`
`public unknown`	# `getInvoiceCollection( )` Retrieve order invoices collection Retrieve order invoices collection Returns `unknown`
`public unknown`	# `getShipmentsCollection( )` Retrieve order shipments collection Retrieve order shipments collection Returns `unknown`
`public unknown`	# `getCreditmemosCollection( )` Retrieve order creditmemos collection Retrieve order creditmemos collection Returns `unknown`
`public unknown`	# `getTracksCollection( )` Retrieve order tracking numbers collection Retrieve order tracking numbers collection Returns `unknown`
`public boolean`	# `hasInvoices( )` Check order invoices availability Check order invoices availability Returns `boolean`
`public boolean`	# `hasShipments( )` Check order shipments availability Check order shipments availability Returns `boolean`
`public boolean`	# `hasCreditmemos( )` Check order creditmemos availability Check order creditmemos availability Returns `boolean`
`public array`	# `getRelatedObjects( )` Retrieve array of related objects Retrieve array of related objects Used for order saving Returns `array`
`public`	# `getCustomerName( )`
`public Mage_Sales_Model_Order`	# `addRelatedObject( Mage_Core_Model_Abstract $object )` Add New object to related array Add New object to related array Parameters `$object` `Mage_Core_Model_Abstract` $object Returns `Mage_Sales_Model_Order`
`public string`	# `getCreatedAtFormated( string $format )` Get formated order created date in store timezone Get formated order created date in store timezone Parameters `$format` `string` $format date format type (short\|medium\|long\|full) Returns `string`
`public`	# `getEmailCustomerNote( )`
`protected Mage_Core_Model_Abstract`	# `_beforeSave( )` Processing object before save data Processing object before save data Returns `Mage_Core_Model_Abstract` Overrides `Mage_Core_Model_Abstract::_beforeSave()`
`protected`	# `_checkState( )` Check order state before saving Check order state before saving
`protected Mage_Sales_Model_Order`	# `_afterSave( )` Save order related objects Save order related objects Returns `Mage_Sales_Model_Order` Overrides `Mage_Sales_Model_Abstract::_afterSave()`
`public`	# `getStoreGroupName( )`
`public Mage_Sales_Model_Order`	# `reset( )` Resets all data in object so after another load it will be complete new object Resets all data in object so after another load it will be complete new object Returns `Mage_Sales_Model_Order`
`public`	# `getIsNotVirtual( )`
`public`	# `getFullTaxInfo( )`
`public Mage_Sales_Model_Order_Invoice`	# `prepareInvoice( mixed $qtys = array() )` Create new invoice with maximum qty for invoice for each item Create new invoice with maximum qty for invoice for each item Returns `Mage_Sales_Model_Order_Invoice`
`public Mage_Sales_Model_Order_Shipment`	# `prepareShipment( mixed $qtys = array() )` Create new shipment with maximum qty for shipping for each item Create new shipment with maximum qty for shipping for each item Returns `Mage_Sales_Model_Order_Shipment`
`public boolean`	# `isCanceled( )` Check whether order is canceled Check whether order is canceled Returns `boolean`
`protected Mage_Sales_Model_Order`	# `_beforeDelete( )` Protect order delete from not admin scope Protect order delete from not admin scope Returns `Mage_Sales_Model_Order` Overrides `Mage_Core_Model_Abstract::_beforeDelete()`

Methods inherited from Mage_Sales_Model_Abstract
`getCreatedAtDate(), getCreatedAtStoreDate()`

Methods inherited from Mage_Core_Model_Abstract
`_afterDelete(), _afterDeleteCommit(), _afterLoad(), _beforeLoad(), _clearData(), _clearReferences(), _getEventData(), _getResource(), _hasModelChanged(), _init(), _protectFromNonAdmin(), _setResourceModel(), afterCommitCallback(), afterLoad(), cleanModelCache(), clearInstance(), delete(), getCacheIdTags(), getCacheTags(), getCollection(), getEntityId(), getId(), getIdFieldName(), getResource(), getResourceCollection(), getResourceName(), isObjectNew(), load(), save(), setId()`

Constants summary
`string`	`ENTITY`	`'order'`	#
`string`	`XML_PATH_EMAIL_TEMPLATE`	`'sales_email/order/template'`	# XML configuration paths XML configuration paths
`string`	`XML_PATH_EMAIL_GUEST_TEMPLATE`	`'sales_email/order/guest_template'`	#
`string`	`XML_PATH_EMAIL_IDENTITY`	`'sales_email/order/identity'`	#
`string`	`XML_PATH_EMAIL_COPY_TO`	`'sales_email/order/copy_to'`	#
`string`	`XML_PATH_EMAIL_COPY_METHOD`	`'sales_email/order/copy_method'`	#
`string`	`XML_PATH_EMAIL_ENABLED`	`'sales_email/order/enabled'`	#
`string`	`XML_PATH_UPDATE_EMAIL_TEMPLATE`	`'sales_email/order_comment/template'`	#
`string`	`XML_PATH_UPDATE_EMAIL_GUEST_TEMPLATE`	`'sales_email/order_comment/guest_template'`	#
`string`	`XML_PATH_UPDATE_EMAIL_IDENTITY`	`'sales_email/order_comment/identity'`	#
`string`	`XML_PATH_UPDATE_EMAIL_COPY_TO`	`'sales_email/order_comment/copy_to'`	#
`string`	`XML_PATH_UPDATE_EMAIL_COPY_METHOD`	`'sales_email/order_comment/copy_method'`	#
`string`	`XML_PATH_UPDATE_EMAIL_ENABLED`	`'sales_email/order_comment/enabled'`	#
`string`	`STATE_NEW`	`'new'`	# Order states Order states
`string`	`STATE_PENDING_PAYMENT`	`'pending_payment'`	#
`string`	`STATE_PROCESSING`	`'processing'`	#
`string`	`STATE_COMPLETE`	`'complete'`	#
`string`	`STATE_CLOSED`	`'closed'`	#
`string`	`STATE_CANCELED`	`'canceled'`	#
`string`	`STATE_HOLDED`	`'holded'`	#
`string`	`STATE_PAYMENT_REVIEW`	`'payment_review'`	#
`string`	`STATUS_FRAUD`	`'fraud'`	# Order statuses Order statuses
`string`	`ACTION_FLAG_CANCEL`	`'cancel'`	# Order flags Order flags
`string`	`ACTION_FLAG_HOLD`	`'hold'`	#
`string`	`ACTION_FLAG_UNHOLD`	`'unhold'`	#
`string`	`ACTION_FLAG_EDIT`	`'edit'`	#
`string`	`ACTION_FLAG_CREDITMEMO`	`'creditmemo'`	#
`string`	`ACTION_FLAG_INVOICE`	`'invoice'`	#
`string`	`ACTION_FLAG_REORDER`	`'reorder'`	#
`string`	`ACTION_FLAG_SHIP`	`'ship'`	#
`string`	`ACTION_FLAG_COMMENT`	`'comment'`	#
`string`	`REPORT_DATE_TYPE_CREATED`	`'created'`	# Report date types Report date types
`string`	`REPORT_DATE_TYPE_UPDATED`	`'updated'`	#
`string`	`HISTORY_ENTITY_NAME`	`'order'`	#

Properties summary
`protected string`	`$_eventPrefix`	`'sales_order'`	# Prefix of model events names Prefix of model events names
`protected string`	`$_eventObject`	`'order'`	# Parameter name in event Parameter name in event In observe method you can use $observer->getEvent()->getObject() in this case
`protected mixed`	`$_addresses`	`null`	#
`protected mixed`	`$_items`	`null`	#
`protected mixed`	`$_payments`	`null`	#
`protected mixed`	`$_statusHistory`	`null`	#
`protected mixed`	`$_invoices`		#
`protected mixed`	`$_tracks`		#
`protected mixed`	`$_shipments`		#
`protected mixed`	`$_creditmemos`		#
`protected array`	`$_relatedObjects`	`array()`	#
`protected mixed`	`$_orderCurrency`	`null`	#
`protected mixed`	`$_baseCurrency`	`null`	#
`protected array`	`$_actionFlag`	`array()`	# Array of action flags for canUnhold, canEdit, etc. Array of action flags for canUnhold, canEdit, etc.
`protected boolean`	`$_canSendNewEmailFlag`	`true`	# Flag: if after order placing we can send new email to the customer. Flag: if after order placing we can send new email to the customer.
`protected string`	`$_historyEntityName`	`Mage_Sales_Model_Order::HISTORY_ENTITY_NAME`	#

Properties inherited from Mage_Core_Model_Abstract
`$_cacheTag, $_dataSaveAllowed, $_isObjectNew, $_resource, $_resourceCollectionName, $_resourceName`

Packages

Classes

Interfaces

Class Mage_Sales_Model_Order

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Returns

Throws

Returns

Parameters

Returns

Throws

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Returns