Class Order

Class represents an order

XLite\Model\Order

Direct known subclasses

Namespace: XLite\Model
Since: 1.0.0
See: ____class_see____
DiscriminatorColumn: (name="is_order", type="integer", length="1")
DiscriminatorMap: ({"1" = "XLite\Model\Order", "0" = "XLite\Model\Cart"})
Entity: (repositoryClass="\XLite\Model\Repo\Order")
HasLifecycleCallbacks
Index: (name="date", columns={"date"}),
Index: (name="total", columns={"total"}),
Index: (name="subtotal", columns={"subtotal"}),
Index: (name="tracking", columns={"tracking"}),
Index: (name="status", columns={"status"}),
Index: (name="shipping_id", columns={"shipping_id"}) } )
InheritanceType: ("SINGLE_TABLE")
Table: (name="orders", indexes={
Located at XLite/Model/Order.php

Methods summary
`public static array`	# `getAllowedStatuses( string $status = null )` Return list of all aloowed order statuses Return list of all aloowed order statuses Parameters `$status` `string` Status to get OPTIONAL Returns `array` \| string Since 1.0.0 See ____func_see____
`public boolean`	# `addItem( XLite\Model\OrderItem $newItem )` Add item to order Add item to order Parameters `$newItem` `XLite\Model\OrderItem` Item to add Returns `boolean` Since 1.0.0 See ____func_see____
`public string\|`	# `getAddItemError( )` Get 'Add item' error code Get 'Add item' error code Returns `string\|` Since 1.0.0 See ____func_see____
`public XLite\Model\OrderItem\|`	# `getItemByItem( XLite\Model\OrderItem $item )` Get item from order by another item Get item from order by another item Parameters `$item` `XLite\Model\OrderItem` Another item Returns `XLite\Model\OrderItem\|` Since 1.0.0 See ____func_see____
`public XLite\Model\OrderItem\|`	# `getItemByItemId( integer $itemId )` Get item from order by item id Get item from order by item id Parameters `$itemId` `integer` Item id Returns `XLite\Model\OrderItem\|` Since 1.0.0 See ____func_see____
`public array`	# `getItemsByProductId( integer $productId )` Find items by product ID Find items by product ID Parameters `$productId` `integer` Product ID to use Returns `array` Since 1.0.0 See ____func_see____
`public`	# `normalizeItems( )` Normalize items Normalize items Since 1.0.0 See ____func_see____
`public integer`	# `countItems( )` Return items number Return items number Returns `integer` Since 1.0.0 See ____func_see____
`public integer`	# `countQuantity( )` Return order items total quantity Return order items total quantity Returns `integer` Since 1.0.0 See ____func_see____
`public boolean`	# `isEmpty( )` Checks whether the shopping cart/order is empty Checks whether the shopping cart/order is empty Returns `boolean` Since 1.0.0 See ____func_see____
`public boolean`	# `isMinOrderAmountError( )` Check order subtotal Check order subtotal Returns `boolean` Since 1.0.0 See ____func_see____
`public boolean`	# `isMaxOrderAmountError( )` Check order subtotal Check order subtotal Returns `boolean` Since 1.0.0 See ____func_see____
`public boolean`	# `isProcessed( )` Check - is order processed or not Check - is order processed or not Returns `boolean` Since 1.0.0 See ____func_see____
`public boolean`	# `isQueued( )` Check - os order queued or not Check - os order queued or not Returns `boolean` Since 1.0.0 See ____func_see____
`public array`	# `getItemsWithWrongAmounts( )` Check item amounts Check item amounts Returns `array` Since 1.0.0 See ____func_see____
`public XLite\Model\Currency`	# `getCurrency( )` Get order currency Get order currency Returns `XLite\Model\Currency` Since 1.0.8 See ____func_see____
`public XLite\Model\Profile`	# `getOrigProfile( )` Get original profile Get original profile Returns `XLite\Model\Profile` Since 1.0.0 See ____func_see____
`public`	# `setProfile( XLite\Model\Profile $profile = null )` Set profile Set profile Parameters `$profile` `XLite\Model\Profile` Profile OPTIONAL Since 1.0.0 See ____func_see____
`public`	# `setOrigProfile( XLite\Model\Profile $profile = null )` Set original profile FIXME: is it really needed? Set original profile FIXME: is it really needed? Parameters `$profile` `XLite\Model\Profile` Profile OPTIONAL Since 1.0.0 See ____func_see____
`public`	# `setProfileCopy( XLite\Model\Profile $profile )` Set profile copy Set profile copy Parameters `$profile` `XLite\Model\Profile` Profile Since 1.0.0 See ____func_see____
`public string`	# `getItemsFingerprint( )` Get items list fingerprint Get items list fingerprint Returns `string` Since 1.0.0 See ____func_see____
`public string`	# `getDescription( )` Generate a string representation of the order to send to a payment service Generate a string representation of the order to send to a payment service Returns `string` Since 1.0.0 See ____func_see____
`public array`	# `getEventFingerprint( )` Get order fingerprint for event subsystem Get order fingerprint for event subsystem Returns `array` Since 1.0.0 See ____func_see____
`public mixed`	# `getDetail( string $name )` Get detail Get detail Parameters `$name` `string` Details cell name Returns `mixed` Since 1.0.0 See ____func_see____
`public`	# `setDetail( string $name, mixed $value, string $label = null )` Set detail cell Set detail cell Parameters `$name` `string` Cell code `$value` `mixed` Cell value `$label` `string` Cell label OPTIONAL Since 1.0.0 See ____func_see____
`public array`	# `getMeaningDetails( )` Get meaning order details Get meaning order details Returns `array` Since 1.0.0 See ____func_see____
`public`	# `processSucceed( )` Called when an order successfully placed by a client Called when an order successfully placed by a client Since 1.0.0 See ____func_see____
`public`	# `markAsOrder( )` Mark cart as order Mark cart as order Since 1.0.0 See ____func_see____
`public`	# `refreshItems( )` Refresh order items TODO - rework after tax subsystem rework Refresh order items TODO - rework after tax subsystem rework Since 1.0.0 See ____func_see____
`public`	# `__construct( array $data = array() )` Constructor Constructor Parameters `$data` `array` Entity properties OPTIONAL Since 1.0.0 See ____func_see____
`public array`	# `getPaymentMethods( )` Return list of available payment methods Return list of available payment methods Returns `array` Since 1.0.0 See ____func_see____
`public`	# `renewPaymentMethod( )` Renew payment method Renew payment method Since 1.0.0 See ____func_see____
`public XLite\Model\Payment\Method\|`	# `getPaymentMethod( )` Get payment method Get payment method Returns `XLite\Model\Payment\Method\|` Since 1.0.0 See ____func_see____
`public boolean`	# `checkItemKeyEqual( XLite\Model\OrderItem $item, string $key )` Check item key equal Check item key equal Parameters `$item` `XLite\Model\OrderItem` Item `$key` `string` Key Returns `boolean` Since 1.0.0 See ____func_see____
`public boolean`	# `checkItemIdEqual( XLite\Model\OrderItem $item, integer $itemId )` Check item id equal Check item id equal Parameters `$item` `XLite\Model\OrderItem` Item `$itemId` `integer` Item id Returns `boolean` Since 1.0.0 See ____func_see____
`public boolean`	# `checkDetailName( XLite\Model\OrderDetail $detail, string $name )` Check order detail name Check order detail name Parameters `$detail` `XLite\Model\OrderDetail` Detail `$name` `string` Name Returns `boolean` Since 1.0.0 See ____func_see____
`public`	# `checkPaymentTransactionStatusEqual( XLite\Model\Payment\Transaction $transaction, string $status )` Check payment transaction status Check payment transaction status Parameters `$transaction` `XLite\Model\Payment\Transaction` Transaction `$status` `string` Status Since 1.0.0 See ____func_see____
`public boolean`	# `isItemProductIdEqual( XLite\Model\OrderItem $item, integer $productId )` Check - is item product id equal specified product id Check - is item product id equal specified product id Parameters `$item` `XLite\Model\OrderItem` Item `$productId` `integer` Product id Returns `boolean` Since 1.0.0 See ____func_see____
`public boolean`	# `checkLastPaymentMethod( XLite\Model\Payment\Method $pmethod, integer $lastPaymentId )` Check last payment method Check last payment method Parameters `$pmethod` `XLite\Model\Payment\Method` Payment method `$lastPaymentId` `integer` Last selected payment method id Returns `boolean` Since 1.0.0 See ____func_see____
`protected`	# `addNewItem( XLite\Model\OrderItem $item )` Create new cart item Create new cart item Parameters `$item` `XLite\Model\OrderItem` New item Since 1.0.0 See ____func_see____
`public`	# `setPaymentMethod( XLite\Model\Payment\Method $paymentMethod, float $value = null )` Set payment method Set payment method Parameters `$paymentMethod` `XLite\Model\Payment\Method` Payment method `$value` `float` Payment transaction value OPTIONAL Since 1.0.0 See ____func_see____
`public array`	# `getActivePaymentTransactions( )` Get active payment transactions Get active payment transactions Returns `array` Since 1.0.0 See ____func_see____
`public XLite\Model\Payment\Transaction\|`	# `getFirstOpenPaymentTransaction( )` Get first open (not payed) payment transaction Get first open (not payed) payment transaction Returns `XLite\Model\Payment\Transaction\|` Since 1.0.0 See ____func_see____
`public float`	# `getOpenTotal( )` Get open (not-payed) total Get open (not-payed) total Returns `float` Since 1.0.0 See ____func_see____
`public boolean`	# `isOpen( )` Check - order is open (has initialized transactions and has open total) or not Check - order is open (has initialized transactions and has open total) or not Returns `boolean` Since 1.0.0 See ____func_see____
`public boolean`	# `hasUnpaidTotal( )` Has unpaid total? Has unpaid total? Returns `boolean` Since 1.0.17 See ____func_see____
`public float`	# `getPayedTotal( )` Get totally payed total Get totally payed total Returns `float` Since 1.0.0 See ____func_see____
`public boolean`	# `isPayed( )` Check - order is payed or not Payed - order has not open total and all payment transactions are failed or completed Check - order is payed or not Payed - order has not open total and all payment transactions are failed or completed Returns `boolean` Since 1.0.0 See ____func_see____
`protected XLite\Model\Payment\Transaction\|`	# `assignLastPaymentMethod( )` Assign last used payment method Assign last used payment method Returns `XLite\Model\Payment\Transaction\|` Since 1.0.0 See ____func_see____
`protected`	# `addPaymentTransaction( XLite\Model\Payment\Method $method, float $value = null )` Add payment transaction FIXME: move logic into \XLite\Model\Payment\Transaction Add payment transaction FIXME: move logic into \XLite\Model\Payment\Transaction Parameters `$method` `XLite\Model\Payment\Method` Payment method `$value` `float` Value OPTIONAL Since 1.0.0 See ____func_see____
`protected`	# `sendProcessMail( )` Called when an order becomes processed, before saving it to the database Called when an order becomes processed, before saving it to the database Since 1.0.0 See ____func_see____
`protected`	# `sendFailMail( )` Called when the order status changed to failed Called when the order status changed to failed Since 1.0.0 See ____func_see____
`public XLite\DataSet\Collection\OrderModifier`	# `getModifiers( )` Get modifiers Get modifiers Returns `XLite\DataSet\Collection\OrderModifier` Since 1.0.0 See ____func_see____
`public XLite\Model\Order\Modifier`	# `getModifier( string $type, string $code )` Get modifier Get modifier Parameters `$type` `string` Modifier type `$code` `string` Modifier code Returns `XLite\Model\Order\Modifier` Since 1.0.0 See ____func_see____
`public boolean`	# `isModifierByType( string $type )` Check - modifier is exists or not (by type) Check - modifier is exists or not (by type) Parameters `$type` `string` Type Returns `boolean` Since 1.0.0 See ____func_see____
`public array`	# `getModifiersByType( string $type )` Get modifiers by type Get modifiers by type Parameters `$type` `string` Modifier type Returns `array` Since 1.0.0 See ____func_see____
`public array`	# `getItemsExcludeSurcharges( )` Get items exclude surcharges info Get items exclude surcharges info Returns `array` Since 1.0.0 See ____func_see____
`public array`	# `getItemsIncludeSurchargesTotals( )` Get items included surcharges totals Get items included surcharges totals Returns `array` Since 1.0.8 See ____func_see____
`public`	# `updateOrder( )` Common method to update cart/order Common method to update cart/order Since 1.0.11 See ____func_see____
`public`	# `calculate( )` Calculate order Calculate order Since 1.0.0 See ____func_see____
`public`	# `renew( )` Renew order Renew order Since 1.0.8 See ____func_see____
`protected`	# `resetSurcharges( )` Reset surcharges list Reset surcharges list Since 1.0.0 See ____func_see____
`protected`	# `calculateInitialValues( )` Calculate initial order values Calculate initial order values Since 1.0.0 See ____func_see____
`protected`	# `finalizeItemsCalculation( )` Finalize items calculation Finalize items calculation Since 1.0.0 See ____func_see____
`public array`	# `getSurchargesByType( string $type )` Get surcharges by type Get surcharges by type Parameters `$type` `string` Surcharge type Returns `array` Since 1.0.0 See ____func_see____
`public float`	# `getSurchargesSubtotal( string $type = null, boolean $include = null )` Get surcharges subtotal with specified type Get surcharges subtotal with specified type Parameters `$type` `string` Surcharge type OPTIONAL `$include` `boolean` Surcharge include flag OPTIONAL Returns `float` Since 1.0.0 See ____func_see____
`public float`	# `getSurchargesTotal( string $type = null )` Get surcharges total with specified type Get surcharges total with specified type Parameters `$type` `string` Surcharge type OPTIONAL Returns `float` Since 1.0.0 See ____func_see____
`public`	# `prepareBeforeSave( )` Prepare order before save data operation Prepare order before save data operation Since 1.0.0 See ____func_see____ PrePersist PreUpdate
`public`	# `prepareBeforeRemove( )` Prepare order before remove operation Prepare order before remove operation Since 1.0.0 See ____func_see____ PreRemove
`public`	# `prepareEntityBeforeCommit( string $type )` Since Doctrine lifecycle callbacks do not allow to modify associations, we've added this method Since Doctrine lifecycle callbacks do not allow to modify associations, we've added this method Parameters `$type` `string` Type of current operation Since 1.0.0 See ____func_see____
`public`	# `setStatus( string $value )` Set status Set status Parameters `$value` `string` Status code Since 1.0.0 See ____func_see____
`protected boolean`	# `isStatusChanged( )` Check if order status was changed Check if order status was changed Returns `boolean` Since 1.0.0 See ____func_see____
`protected string\|array`	# `getStatusHandlers( string $old, string $new )` Return base part of the certain "change status" handler name Return base part of the certain "change status" handler name Parameters `$old` `string` Old order status `$new` `string` New order status Returns `string\|array` Since 1.0.0 See ____func_see____
`protected`	# `changeStatusPostprocess( string $old, string $new )` Postprocess status changes Postprocess status changes Parameters `$old` `string` Old status `$new` `string` New status Since 1.0.0 See ____func_see____
`protected`	# `processCheckout( )` A "change status" handler A "change status" handler Since 1.0.0 See ____func_see____
`protected`	# `processUncheckout( )` A "change status" handler A "change status" handler Since 1.0.0 See ____func_see____
`protected`	# `processQueue( )` A "change status" handler A "change status" handler Since 1.0.0 See ____func_see____
`protected`	# `processProcess( )` A "change status" handler A "change status" handler Since 1.0.0 See ____func_see____
`protected`	# `processDecline( )` A "change status" handler A "change status" handler Since 1.0.0 See ____func_see____
`protected`	# `processFail( )` A "change status" handler A "change status" handler Since 1.0.0 See ____func_see____
`protected integer`	# `getItemInventoryAmount( XLite\Model\OrderItem $item, integer $sign )` Get item inventory delta Get item inventory delta Parameters `$item` `XLite\Model\OrderItem` Current item `$sign` `integer` Flag; "1" or "-1" Returns `integer` Since 1.0.0 See ____func_see____
`protected`	# `changeItemsInventory( integer $sign )` Increase / decrease item products inventory Increase / decrease item products inventory Parameters `$sign` `integer` Flag; "1" or "-1" Since 1.0.0 See ____func_see____
`protected`	# `decreaseInventory( )` Order processed: decrease products inventory Order processed: decrease products inventory Since 1.0.0 See ____func_see____
`protected`	# `increaseInventory( )` Order declined: increase products inventory Order declined: increase products inventory Since 1.0.0 See ____func_see____

Methods inherited from XLite\Model\Base\SurchargeOwner
`getExcludeSurcharges(), getExcludeSurchargesByType(), getIncludeSurcharges(), getSurchargeSum(), getSurchargeSumByType(), getSurchargeTotalByType(), getSurchargeTotals()`

Methods inherited from XLite\Model\AEntity
`__call(), __get(), __set(), __unset(), checkCache(), cloneEntity(), create(), delete(), detach(), getMethodName(), getRepository(), getUniqueIdentifier(), isPersistent(), map(), update()`

Constants summary
`string`	`STATUS_TEMPORARY`	`'T'`	# Order statuses Order statuses
`string`	`STATUS_INPROGRESS`	`'I'`	#
`string`	`STATUS_QUEUED`	`'Q'`	#
`string`	`STATUS_PROCESSED`	`'P'`	#
`string`	`STATUS_COMPLETED`	`'C'`	#
`string`	`STATUS_FAILED`	`'F'`	#
`string`	`STATUS_DECLINED`	`'D'`	#
`float`	`ORDER_ZERO`	`0.00001`	# Order total that is financially declared as zero (null) Order total that is financially declared as zero (null)
`string`	`NOT_VALID_ERROR`	`'notValid'`	# Add item error codes Add item error codes

Constants inherited from XLite\Model\AEntity
`ACTION_DELETE, ACTION_INSERT, ACTION_UPDATE`

Properties summary
`protected mixed`	`$order_id`		# Order unique id Order unique id Since 1.0.0 See ____var_see____ Column (type="integer") GeneratedValue (strategy="AUTO") Id
`protected XLite\Model\Profile`	`$profile`		# Order profile Order profile Since 1.0.0 See ____var_see____ JoinColumn (name="profile_id", referencedColumnName="profile_id") ManyToOne (targetEntity="XLite\Model\Profile", cascade={"persist"})
`protected XLite\Model\Profile`	`$orig_profile`		# Original profile Original profile Since 1.0.0 See ____var_see____ JoinColumn (name="orig_profile_id", referencedColumnName="profile_id") ManyToOne (targetEntity="XLite\Model\Profile")
`protected integer`	`$shipping_id`	`0`	# Shipping method unique id Shipping method unique id Since 1.0.0 See ____var_see____ Column (type="integer")
`protected integer`	`$shipping_method_name`	`''`	# Shipping method name Shipping method name Since 1.0.0 See ____var_see____ Column (type="string", nullable=true)
`protected string`	`$tracking`	`''`	# Shipping tracking code Shipping tracking code Since 1.0.0 See ____var_see____ Column (type="string", length="32")
`protected integer`	`$date`		# Order creation timestamp Order creation timestamp Since 1.0.0 See ____var_see____ Column (type="integer")
`protected integer`	`$lastRenewDate`	`0`	# Last order renew date Last order renew date Since 1.0.0 See ____var_see____ Column (type="integer")
`protected string`	`$status`	`XLite\Model\Order::STATUS_INPROGRESS`	# Status code Status code Since 1.0.0 See ____var_see____ Column (type="fixedstring", length="1")
`protected string`	`$notes`	`''`	# Customer notes Customer notes Since 1.0.0 See ____var_see____ Column (type="text")
`protected Doctrine\Common\Collections\Collection`	`$details`		# Order details Order details Since 1.0.0 See ____var_see____ OneToMany (targetEntity="XLite\Model\OrderDetail", mappedBy="order", cascade={"all"}) OrderBy ({"name" = "ASC"})
`protected Doctrine\Common\Collections\Collection`	`$items`		# Order items Order items Since 1.0.0 See ____var_see____ OneToMany (targetEntity="XLite\Model\OrderItem", mappedBy="order", cascade={"all"})
`protected Doctrine\Common\Collections\Collection`	`$surcharges`		# Order surcharges Order surcharges Since 1.0.0 See ____var_see____ OneToMany (targetEntity="XLite\Model\Order\Surcharge", mappedBy="owner", cascade={"all"}) OrderBy ({"id" = "ASC"})
`protected Doctrine\Common\Collections\Collection`	`$payment_transactions`		# Payment transactions Payment transactions Since 1.0.0 See ____var_see____ OneToMany (targetEntity="XLite\Model\Payment\Transaction", mappedBy="order", cascade={"all"})
`protected XLite\Model\Currency`	`$currency`		# Currency Currency Since 1.0.0 See ____var_see____ JoinColumn (name="currency_id", referencedColumnName="currency_id") ManyToOne (targetEntity="XLite\Model\Currency", inversedBy="orders", cascade={"merge","detach"})
`protected string`	`$addItemError`		# 'Add item' error code 'Add item' error code Since 1.0.0 See ____var_see____
`protected static array`	`$statusHandlers`	array( self::STATUS_TEMPORARY => array( self::STATUS_PROCESSED => array('checkout', 'process'), self::STATUS_COMPLETED => array('checkout', 'process'), self::STATUS_QUEUED => array('checkout'), self::STATUS_DECLINED => array('fail'), self::STATUS_FAILED => array('fail'), ), self::STATUS_INPROGRESS => array( self::STATUS_PROCESSED => array('checkout', 'process'), self::STATUS_COMPLETED => array('checkout', 'process'), self::STATUS_QUEUED => array('checkout', 'queue'), self::STATUS_DECLINED => array('fail'), self::STATUS_FAILED => array('fail'), ), self::STATUS_QUEUED => array( self::STATUS_TEMPORARY => array('uncheckout'), self::STATUS_INPROGRESS => array('uncheckout'), self::STATUS_PROCESSED => array('process'), self::STATUS_COMPLETED => array('process'), self::STATUS_DECLINED => array('uncheckout', 'fail'), self::STATUS_FAILED => array('uncheckout', 'fail'), ), self::STATUS_PROCESSED => array( self::STATUS_TEMPORARY => array('decline', 'uncheckout'), self::STATUS_INPROGRESS => array('decline', 'uncheckout'), self::STATUS_QUEUED => array('decline'), self::STATUS_DECLINED => array('decline', 'uncheckout', 'fail'), self::STATUS_FAILED => array('decline', 'uncheckout', 'fail'), ), self::STATUS_COMPLETED => array( self::STATUS_TEMPORARY => array('decline', 'uncheckout'), self::STATUS_INPROGRESS => array('decline', 'uncheckout'), self::STATUS_QUEUED => array('decline'), self::STATUS_DECLINED => array('decline', 'uncheckout', 'fail'), self::STATUS_FAILED => array('decline', 'uncheckout', 'fail'), ), self::STATUS_DECLINED => array( self::STATUS_PROCESSED => array('checkout', 'process'), self::STATUS_COMPLETED => array('checkout', 'process'), self::STATUS_QUEUED => array('checkout'), ), self::STATUS_FAILED => array( self::STATUS_PROCESSED => array('checkout', 'process'), self::STATUS_COMPLETED => array('checkout', 'process'), self::STATUS_QUEUED => array('checkout'), ), )	# List of change status handlers; top index - old status, second index - new one (<old_status> ----> <new_status>: $statusHandlers[$old][$new]) List of change status handlers; top index - old status, second index - new one (<old_status> ----> <new_status>: $statusHandlers[$old][$new]) Since 1.0.0 See ____var_see____
`protected string`	`$oldStatus`		# Order previous status Order previous status Since 1.0.0 See ____var_see____
`protected XLite\DataSet\Collection\OrderModifier`	`$modifiers`		# Modifiers (cache) Modifiers (cache) Since 1.0.0 See ____var_see____

Properties inherited from XLite\Model\Base\SurchargeOwner
`$subtotal, $total`

Properties inherited from XLite\Model\AEntity
`$cacheEnabled, $methodNames`

Namespaces

Classes

Class Order

Direct known subclasses

Parameters

Returns

Since

See

Parameters

Returns

Since

See

Returns

Since

See

Parameters

Returns

Since

See

Parameters

Returns

Since

See

Parameters

Returns

Since

See

Since

See

Returns

Since

See

Returns

Since

See

Returns

Since

See

Returns

Since

See

Returns

Since

See

Returns

Since

See

Returns

Since

See

Returns

Since

See

Returns

Since

See

Returns

Since

See

Parameters

Since

See

Parameters

Since

See

Parameters

Since

See

Returns

Since

See

Returns

Since

See

Returns

Since

See

Parameters

Returns

Since