Order

Type: Class
Namespace: craft\commerce\elements
Inherits: craft\commerce\elements\Order » craft\base\Element (opens new window) » craft\base\Component (opens new window) » craft\base\Model (opens new window) » yii\base\Model (opens new window) » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)
Implements: ArrayAccess (opens new window), IteratorAggregate (opens new window), craft\base\ComponentInterface (opens new window), craft\base\ElementInterface (opens new window), yii\base\Arrayable (opens new window), yii\base\Configurable (opens new window), yii\base\StaticInstanceInterface (opens new window)
Uses traits: craft\base\ClonefixTrait (opens new window), craft\base\ElementTrait (opens new window), craft\commerce\base\OrderDeprecatedTrait, craft\commerce\base\OrderValidatorsTrait, yii\base\ArrayableTrait (opens new window), yii\base\StaticInstanceTrait (opens new window)
Since: 2.0

Order or Cart model.

# Public Properties

Property	Description
activeValidators (opens new window)	yii\validators\Validator (opens new window) – The validators applicable to the current scenario (opens new window).
adjustmentSubtotal	float (opens new window), integer (opens new window)
adjustments	craft\commerce\models\OrderAdjustment[]
adjustmentsTotal	float (opens new window)
ancestors (opens new window)	craft\elements\db\ElementQueryInterface (opens new window), craft\base\ElementInterface (opens new window)
archived (opens new window)	boolean (opens new window) – Whether the element is archived
attributes (opens new window)	array (opens new window) – Attribute values (name => value).
availableShippingMethods	craft\commerce\base\ShippingMethodInterface[], craft\commerce\base\ShippingMethod[]
awaitingFieldValues (opens new window)	boolean (opens new window) – Whether the element is still awaiting its custom field values
behaviors (opens new window)	yii\base\Behavior (opens new window) – List of behaviors attached to this component
billingAddress	craft\commerce\models\Address, null (opens new window)
billingAddressId	integer (opens new window) – Billing address ID
billingSameAsShipping	boolean (opens new window) – Whether billing address should be set to the same address as shipping
cancelUrl	string (opens new window) – Cancel URL
children (opens new window)	craft\elements\db\ElementQueryInterface (opens new window), craft\base\ElementInterface (opens new window)
contentId (opens new window)	integer (opens new window), null (opens new window) – The element’s content row ID
contentTable (opens new window)	string (opens new window)
couponCode	string (opens new window) – Coupon Code
cpEditUrl	string (opens new window), null (opens new window)
currency	string (opens new window) – Currency
currentRevision (opens new window)	craft\base\ElementInterface (opens new window), null (opens new window)
customer	craft\commerce\models\Customer, null (opens new window)
customerId	integer (opens new window), null (opens new window)
dateCreated (opens new window)	DateTime (opens new window), null (opens new window) – The date that the element was created
dateDeleted (opens new window)	DateTime (opens new window), null (opens new window) – The date that the element was trashed
dateOrdered	DateTime (opens new window) – Date ordered
datePaid	DateTime (opens new window) – Date paid
dateUpdated (opens new window)	DateTime (opens new window), null (opens new window) – The date that the element was last updated
descendants (opens new window)	craft\elements\db\ElementQueryInterface (opens new window), craft\base\ElementInterface (opens new window)
dirtyAttributes (opens new window)	string (opens new window)[]
dirtyFields (opens new window)	string (opens new window)[]
draftId (opens new window)	integer (opens new window), null (opens new window) – The ID of the draft’s row in the `drafts` table
duplicateOf (opens new window)	craft\base\ElementInterface (opens new window), null (opens new window) – The element that this element is being duplicated by.
editorHtml (opens new window)	string (opens new window) – The HTML for the editor HUD
email	string (opens new window), null (opens new window)
enabled (opens new window)	boolean (opens new window) – Whether the element is enabled
enabledForSite (opens new window)	boolean (opens new window), null (opens new window) – Whether the element is enabled for the given site.
errors (opens new window)	array (opens new window) – Errors for all attributes or the specified attribute.
estimatedBillingAddress	craft\commerce\models\Address, null (opens new window)
estimatedBillingAddressId	integer (opens new window) – Billing address ID
estimatedBillingSameAsShipping	boolean (opens new window) – Whether estimated billing address should be set to the same address as estimated shipping
estimatedShippingAddress	craft\commerce\models\Address, null (opens new window)
estimatedShippingAddressId	integer (opens new window) – Shipping address ID
fieldColumnPrefix (opens new window)	string (opens new window)
fieldContext (opens new window)	string (opens new window)
fieldLayout	craft\models\FieldLayout (opens new window), null (opens new window)
fieldLayoutId (opens new window)	integer (opens new window), null (opens new window) – The element’s field layout ID
fieldParamNamespace (opens new window)	string (opens new window), null (opens new window) – The field param namespace
fieldValues (opens new window)	array (opens new window) – The field values (handle => value)
firstErrors (opens new window)	array (opens new window) – The first errors.
gateway	craft\commerce\base\GatewayInterface, null (opens new window)
gatewayId	integer (opens new window), null (opens new window) – Gateway ID
gqlTypeName (opens new window)	string (opens new window)
hardDelete (opens new window)	boolean (opens new window) – Whether the element is being hard-deleted.
hasDescendants (opens new window)	boolean (opens new window)
hasFreshContent (opens new window)	boolean (opens new window) – Whether the element’s content is fresh
histories	craft\commerce\models\OrderHistory[]
id (opens new window)	integer (opens new window), null (opens new window) – The element’s ID
isActiveCart	boolean (opens new window)
isCompleted	boolean (opens new window) – Is completed
isDraft (opens new window)	boolean (opens new window)
isEditable	boolean (opens new window)
isEmpty	boolean (opens new window)
isHomepage (opens new window)	boolean (opens new window)
isPaid	boolean (opens new window)
isRevision (opens new window)	boolean (opens new window)
isUnpaid	boolean (opens new window)
isUnsavedDraft (opens new window)	boolean (opens new window)
itemSubtotal	float (opens new window)
itemTotal	float (opens new window)
iterator (opens new window)	ArrayIterator (opens new window) – An iterator for traversing the items in the list.
lastIp	string (opens new window) – Last IP
lastTransaction	craft\commerce\models\Transaction, null (opens new window)
level (opens new window)	integer (opens new window), null (opens new window) – The element’s level within its structure
lft (opens new window)	integer (opens new window), null (opens new window) – The element’s left position within its structure
lineItems	craft\commerce\models\LineItem[]
link	`\Twig\Markup`, null (opens new window)
makePrimaryBillingAddress	boolean (opens new window) – Whether billing address should be made primary
makePrimaryShippingAddress	boolean (opens new window) – Whether shipping address should be made primary
message	string (opens new window) – Message
nestedTransactions	craft\commerce\models\Transaction[]
newSiteIds (opens new window)	integer (opens new window)[] – The site IDs that the element was just propagated to for the first time.
next (opens new window)	craft\base\ElementInterface (opens new window), null (opens new window)
nextSibling (opens new window)	craft\base\ElementInterface (opens new window), null (opens new window)
number	string (opens new window) – Number
orderAdjustments	array (opens new window)
orderLanguage	string (opens new window) – Order locale
orderLocale	string (opens new window)
orderStatus	craft\commerce\models\OrderStatus, null (opens new window)
orderStatusId	integer (opens new window) – Order status ID
outstandingBalance	float (opens new window)
paidStatus	string (opens new window)
paidStatusHtml	string (opens new window)
parent (opens new window)	craft\base\ElementInterface (opens new window), null (opens new window)
paymentCurrency	string (opens new window)
paymentSource	craft\commerce\models\PaymentSource, null (opens new window)
paymentSourceId	integer (opens new window), null (opens new window) – Payment source ID
pdfUrl	string (opens new window), null (opens new window) – The URL to the order’s PDF invoice, or null if the PDF template doesn’t exist
prev (opens new window)	craft\base\ElementInterface (opens new window), null (opens new window)
prevSibling (opens new window)	craft\base\ElementInterface (opens new window), null (opens new window)
previewTargets (opens new window)	array (opens new window)
previewing (opens new window)	boolean (opens new window) – Whether the element is currently being previewed.
propagateAll (opens new window)	boolean (opens new window) – Whether all element attributes should be propagated across all its supported sites, even if that means overwriting existing site-specific values.
propagating (opens new window)	boolean (opens new window) – Whether the element is being saved in the context of propagating another site's version of the element.
ref (opens new window)	string (opens new window), null (opens new window)
reference	string (opens new window) – Reference
registerUserOnOrderComplete	boolean (opens new window) – Register the email on order completion
resaving (opens new window)	boolean (opens new window) – Whether the element is being resaved by a ResaveElement job or a `resave` console command.
returnUrl	string (opens new window) – Return URL
revisionId (opens new window)	integer (opens new window) – The ID of the revision’s row in the `revisions` table
rgt (opens new window)	integer (opens new window), null (opens new window) – The element’s right position within its structure
root (opens new window)	integer (opens new window), null (opens new window) – The element’s structure’s root ID
route (opens new window)	`mixed` – The route that the request should use, or null if no special action should be taken
scenario (opens new window)	string (opens new window) – The scenario that this model is in.
searchScore (opens new window)	integer (opens new window), null (opens new window) – The element’s search score, if the craft\elements\db\ElementQuery::search() (opens new window) parameter was used when querying for the element
serializedFieldValues (opens new window)	array (opens new window)
shippingAddress	craft\commerce\models\Address, null (opens new window)
shippingAddressId	integer (opens new window) – Shipping address ID
shippingMethod	craft\commerce\models\ShippingMethod, null (opens new window)
shippingMethodHandle	string (opens new window) – Shipping Method Handle
shippingMethodId	integer (opens new window), null (opens new window)
shippingSameAsBilling	boolean (opens new window) – Whether shipping address should be set to the same address as billing
shortNumber	string (opens new window)
shouldRecalculateAdjustments	boolean (opens new window)
siblings (opens new window)	craft\elements\db\ElementQueryInterface (opens new window), craft\base\ElementInterface (opens new window)
site (opens new window)	craft\models\Site (opens new window)
siteId (opens new window)	integer (opens new window), null (opens new window) – The site ID the element is associated with
slug (opens new window)	string (opens new window), null (opens new window) – The element’s slug
sourceId (opens new window)	integer (opens new window), null (opens new window)
sourceUid (opens new window)	string (opens new window)
status (opens new window)	string (opens new window), null (opens new window)
structureId (opens new window)	integer (opens new window), null (opens new window) – The element’s structure ID
supportedSites (opens new window)	integer (opens new window)[], array (opens new window)
tempId (opens new window)	string (opens new window), null (opens new window) – The element’s temporary ID (only used if the element's URI format contains {id})
title (opens new window)	string (opens new window), null (opens new window) – The element’s title
total	float (opens new window)
totalDescendants (opens new window)	integer (opens new window)
totalDiscount	float (opens new window)
totalPaid	float (opens new window)
totalPrice	float (opens new window)
totalQty	integer (opens new window)
totalSaleAmount	float (opens new window)
totalShippingCost	float (opens new window)
totalTax	float (opens new window)
totalTaxIncluded	float (opens new window)
totalTaxablePrice	float (opens new window)
totalWeight	float (opens new window)
transactions	craft\commerce\models\Transaction[]
trashed (opens new window)	boolean (opens new window) – Whether the element has been soft-deleted.
uiLabel (opens new window)	string (opens new window)
uid (opens new window)	string (opens new window), null (opens new window) – The element’s UID
uri (opens new window)	string (opens new window), null (opens new window) – The element’s URI
uriFormat (opens new window)	string (opens new window), null (opens new window)
url (opens new window)	string (opens new window), null (opens new window)
user	craft\elements\User (opens new window), null (opens new window)
validators (opens new window)	ArrayObject (opens new window), yii\validators\Validator (opens new window) – All the validators declared in the model.

# `adjustmentSubtotal`

Type: float (opens new window), integer (opens new window)
Access: Read-only

View source (opens new window)

# `adjustments`

Type: craft\commerce\models\OrderAdjustment[]

View source (opens new window)

# `adjustmentsTotal`

Type: float (opens new window)
Access: Read-only

View source (opens new window)

Billing address ID

View source (opens new window)

# `billingSameAsShipping`

Type: boolean (opens new window)

Whether billing address should be set to the same address as shipping

View source (opens new window)

# `cancelUrl`

Type: string (opens new window)

Cancel URL

View source (opens new window)

# `couponCode`

Type: string (opens new window)

Coupon Code

View source (opens new window)

# `cpEditUrl`

Type: string (opens new window), null (opens new window)
Access: Read-only

View source (opens new window)

# `currency`

Type: string (opens new window)

Currency

View source (opens new window)

# `customer`

Type: craft\commerce\models\Customer, null (opens new window)
Access: Read-only

View source (opens new window)

# `customerId`

Type: integer (opens new window), null (opens new window)
Since: 2.2.23

View source (opens new window)

# `dateOrdered`

Type: DateTime (opens new window)

Date ordered

View source (opens new window)

# `datePaid`

Type: DateTime (opens new window)

Date paid

View source (opens new window)

# `email`

Type: string (opens new window), null (opens new window)

View source (opens new window)

# `estimatedBillingAddress`

Type: craft\commerce\models\Address, null (opens new window)
Since: 2.2

View source (opens new window)

# `estimatedBillingAddressId`

Type: integer (opens new window)
Since: 2.2

Billing address ID

View source (opens new window)

# `estimatedBillingSameAsShipping`

Type: boolean (opens new window)
Since: 2.2

Whether estimated billing address should be set to the same address as estimated shipping

View source (opens new window)

# `estimatedShippingAddress`

Type: craft\commerce\models\Address, null (opens new window)
Since: 2.2

View source (opens new window)

# `estimatedShippingAddressId`

Type: integer (opens new window)
Since: 2.2

Shipping address ID

View source (opens new window)

# `fieldLayout`

Type: craft\models\FieldLayout (opens new window), null (opens new window)
Access: Read-only

View source (opens new window)

# `gateway`

Type: craft\commerce\base\GatewayInterface, null (opens new window)
Access: Read-only

View source (opens new window)

# `gatewayId`

Type: integer (opens new window), null (opens new window)

Gateway ID

View source (opens new window)

# `histories`

Type: craft\commerce\models\OrderHistory[]
Access: Read-only

View source (opens new window)

# `isActiveCart`

Type: boolean (opens new window)
Access: Read-only

View source (opens new window)

# `isCompleted`

Type: boolean (opens new window)

Is completed

View source (opens new window)

# `isEditable`

Type: boolean (opens new window)
Access: Read-only

View source (opens new window)

# `isEmpty`

Type: boolean (opens new window)
Access: Read-only

View source (opens new window)

# `isPaid`

Type: boolean (opens new window)
Access: Read-only

View source (opens new window)

# `isUnpaid`

Type: boolean (opens new window)
Access: Read-only

View source (opens new window)

# `itemSubtotal`

Type: float (opens new window)
Access: Read-only

View source (opens new window)

# `itemTotal`

Type: float (opens new window)
Access: Read-only

View source (opens new window)

# `lastIp`

Type: string (opens new window)

Last IP

View source (opens new window)

# `lastTransaction`

Type: craft\commerce\models\Transaction, null (opens new window)
Access: Read-only

View source (opens new window)

# `lineItems`

Type: craft\commerce\models\LineItem[]

View source (opens new window)

# `link`

Type: \Twig\Markup, null (opens new window)
Access: Read-only

View source (opens new window)

# `makePrimaryBillingAddress`

Type: boolean (opens new window)

Whether billing address should be made primary

View source (opens new window)

# `makePrimaryShippingAddress`

Type: boolean (opens new window)

Whether shipping address should be made primary

View source (opens new window)

# `message`

Type: string (opens new window)

Message

View source (opens new window)

# `nestedTransactions`

Type: craft\commerce\models\Transaction[]
Access: Read-only

View source (opens new window)

# `number`

Type: string (opens new window)

Number

View source (opens new window)

# `orderAdjustments`

Type: array (opens new window)
Access: Read-only

View source (opens new window)

# `orderLanguage`

Type: string (opens new window)

Order locale

View source (opens new window)

# `orderStatus`

Type: craft\commerce\models\OrderStatus, null (opens new window)
Access: Read-only

View source (opens new window)

# `orderStatusId`

Type: integer (opens new window)

Order status ID

View source (opens new window)

# `outstandingBalance`

Type: float (opens new window)
Access: Read-only

View source (opens new window)

# `paidStatus`

Type: string (opens new window)
Access: Read-only

View source (opens new window)

# `paidStatusHtml`

Type: string (opens new window)
Access: Read-only

View source (opens new window)

# `paymentCurrency`

Type: string (opens new window)

View source (opens new window)

# `paymentSource`

Type: craft\commerce\models\PaymentSource, null (opens new window)

View source (opens new window)

# `paymentSourceId`

Type: integer (opens new window), null (opens new window)

Payment source ID

View source (opens new window)

# `pdfUrl`

Type: string (opens new window), null (opens new window)
Access: Read-only

The URL to the order’s PDF invoice, or null if the PDF template doesn’t exist

View source (opens new window)

# `reference`

Type: string (opens new window)

Reference

View source (opens new window)

# `registerUserOnOrderComplete`

Type: boolean (opens new window)

View source (opens new window)

# `returnUrl`

Type: string (opens new window)

Return URL

View source (opens new window)

# `shippingAddress`

Type: craft\commerce\models\Address, null (opens new window)

View source (opens new window)

# `shippingAddressId`

Type: integer (opens new window)

Shipping address ID

View source (opens new window)

# `shippingMethod`

Type: craft\commerce\models\ShippingMethod, null (opens new window)
Access: Read-only

View source (opens new window)

# `shippingMethodHandle`

Type: string (opens new window)

Shipping Method Handle

View source (opens new window)

# `shippingMethodId`

Type: integer (opens new window), null (opens new window)
Access: Read-only

View source (opens new window)

# `shippingSameAsBilling`

Type: boolean (opens new window)

Whether shipping address should be set to the same address as billing

View source (opens new window)

# `shortNumber`

Type: string (opens new window)
Access: Read-only

View source (opens new window)

# `shouldRecalculateAdjustments`

Type: boolean (opens new window)

View source (opens new window)

# `total`

Type: float (opens new window)
Access: Read-only

View source (opens new window)

# `totalDiscount`

Type: float (opens new window)
Access: Read-only

View source (opens new window)

# `totalPaid`

Type: float (opens new window)
Access: Read-only

View source (opens new window)

# `totalPrice`

Type: float (opens new window)
Access: Read-only

View source (opens new window)

# `totalQty`

Type: integer (opens new window)
Access: Read-only

View source (opens new window)

# `totalSaleAmount`

Type: float (opens new window)
Access: Read-only

View source (opens new window)

# `totalShippingCost`

Type: float (opens new window)
Access: Read-only

View source (opens new window)

# `totalTax`

Type: float (opens new window)
Access: Read-only

View source (opens new window)

# `totalTaxIncluded`

Type: float (opens new window)
Access: Read-only

View source (opens new window)

# `totalTaxablePrice`

Type: float (opens new window)
Access: Read-only

View source (opens new window)

# `totalWeight`

Type: float (opens new window)
Access: Read-only

View source (opens new window)

# `transactions`

Type: craft\commerce\models\Transaction[]
Access: Read-only

View source (opens new window)

# `user`

Type: craft\elements\User (opens new window), null (opens new window)
Access: Read-only

View source (opens new window)

# Protected Properties

Property	Description
revisionCreatorId (opens new window)	string (opens new window), null (opens new window) – Revision creator ID to be saved
revisionNotes (opens new window)	string (opens new window), null (opens new window) – Revision notes to be saved

# Public Methods

Method	Description
__call() (opens new window)	Calls the named method which is not a class method.
__clone() (opens new window)
__construct() (opens new window)	Constructor.
__get() (opens new window)	Returns the value of a component property.
__isset() (opens new window)	Checks if a property is set.
__set() (opens new window)	Sets the value of a component property.
__toString()	Returns the string representation of the element.
__unset() (opens new window)	Sets an object property to null.
_getAdjustmentsTotalByType()
actions() (opens new window)	Returns the available element actions (opens new window) for a given source.
activeAttributes() (opens new window)	Returns the attribute names that are subject to validation in the current scenario.
addError() (opens new window)	Adds a new error to the specified attribute.
addErrors() (opens new window)	Adds a list of errors.
addLineItem()	Adds a line item to the order. Updates the line item if the ID of that line item is already in the cart.
addModelErrors() (opens new window)	Adds errors from another model, with a given attribute name prefix.
afterDelete() (opens new window)	Performs actions after an element is deleted.
afterMoveInStructure() (opens new window)	Performs actions after an element is moved within a structure.
afterOrderComplete()	Called after the order successfully completes
afterPropagate() (opens new window)	Performs actions after an element is fully saved and propagated to other sites.
afterRestore() (opens new window)	Performs actions after an element is restored.
afterSave()	Performs actions after an element is saved.
afterValidate() (opens new window)	This method is invoked after validation ends.
attachBehavior() (opens new window)	Attaches a behavior to this component.
attachBehaviors() (opens new window)	Attaches a list of behaviors to the component.
attributeHints() (opens new window)	Returns the attribute hints.
attributeLabels() (opens new window)	Returns the attribute labels.
attributes()	Returns the list of attribute names.
beforeDelete() (opens new window)	Performs actions before an element is deleted.
beforeMoveInStructure() (opens new window)	Performs actions before an element is moved within a structure.
beforeRestore() (opens new window)	Performs actions before an element is restored.
beforeSave() (opens new window)	Performs actions before an element is saved.
beforeValidate()	This method is invoked before validation starts.
behaviors() (opens new window)	Returns a list of behaviors that this component should behave as.
canGetProperty() (opens new window)	Returns a value indicating whether a property can be read.
canSetProperty() (opens new window)	Returns a value indicating whether a property can be set.
className() (opens new window)	Returns the fully qualified name of this class.
clearErrors() (opens new window)	Removes errors for all attributes or a single attribute.
createValidators() (opens new window)	Creates validator objects based on the validation rules specified in rules() (opens new window).
datetimeAttributes()	Returns the names of any attributes that should hold DateTime (opens new window) values.
defaultTableAttributes() (opens new window)	Returns the list of table attribute keys that should be shown by default.
detachBehavior() (opens new window)	Detaches a behavior from the component.
detachBehaviors() (opens new window)	Detaches all behaviors from the component.
displayName()
eagerLoadingMap() (opens new window)	Returns an array that maps source-to-target element IDs based on the given sub-property handle.
ensureBehaviors() (opens new window)	Makes sure that the behaviors declared in behaviors() (opens new window) are attached to this component.
exporters() (opens new window)	Returns the available export options for a given source.
extraFields()	Returns the list of fields that can be expanded further and returned by toArray() (opens new window).
fields() (opens new window)	Returns the list of fields that should be returned by default by toArray() (opens new window) when no specific fields are specified.
find()	Creates an craft\elements\db\ElementQueryInterface (opens new window) instance for query purpose.
findAll() (opens new window)	Returns a list of elements that match the specified ID(s) or a set of element criteria parameters.
findOne() (opens new window)	Returns a single element instance by a primary key or a set of element criteria parameters.
formName() (opens new window)	Returns the form name that this model class should use.
generateAttributeLabel() (opens new window)	Generates a user friendly attribute label based on the give attribute name.
getActiveValidators() (opens new window)	Returns the validators applicable to the current scenario (opens new window).
getAdjustmentSubtotal()	Returns the total of adjustments made to order.
getAdjustments()
getAdjustmentsTotal()
getAdjustmentsTotalByType()
getAncestors() (opens new window)	Returns the element’s ancestors.
getAttributeHint() (opens new window)	Returns the text hint for the specified attribute.
getAttributeLabel() (opens new window)	Returns the text label for the specified attribute.
getAttributeStatus() (opens new window)	Returns the status of a given attribute.
getAttributes() (opens new window)	Returns attribute values.
getAvailableShippingMethods()
getBehavior() (opens new window)	Returns the named behavior object.
getBehaviors() (opens new window)	Returns all behaviors attached to this component.
getBillingAddress()
getChildren() (opens new window)	Returns the element’s children.
getContentTable() (opens new window)	Returns the name of the table this element’s content is stored in.
getCpEditUrl()	Returns the element’s edit URL in the control panel.
getCurrentRevision() (opens new window)	Returns the element’s current revision, if one exists.
getCustomer()
getCustomerId()
getDescendants() (opens new window)	Returns the element’s descendants.
getDirtyAttributes() (opens new window)	Returns a list of attribute names that have changed since the element was first loaded.
getDirtyFields() (opens new window)	Returns a list of custom field handles that have changed since the element was first loaded.
getEagerLoadedElementCount() (opens new window)	Returns the count of eager-loaded elements for a given handle.
getEagerLoadedElements() (opens new window)	Returns the eager-loaded elements for a given handle.
getEditorHtml() (opens new window)	Returns the HTML for the element’s editor HUD.
getEmail()	Returns the email for this order. Will always be the registered users email if the order's customer is related to a user.
getEnabledForSite() (opens new window)	Returns whether the element is enabled for the current site.
getError() (opens new window)	Returns the first error of the specified attribute.
getErrorSummary() (opens new window)	Returns the errors for all attributes as a one-dimensional array.
getErrors() (opens new window)	Returns the errors for all attributes or a single attribute.
getEstimatedBillingAddress()
getEstimatedShippingAddress()
getFieldColumnPrefix() (opens new window)	Returns the field column prefix this element’s content uses.
getFieldContext() (opens new window)	Returns the field context this element’s content uses.
getFieldLayout()	Returns the field layout used by this element.
getFieldParamNamespace() (opens new window)	Returns the namespace used by custom field params on the request.
getFieldStatus() (opens new window)	Returns the status of a given field.
getFieldValue() (opens new window)	Returns the value for a given field.
getFieldValues() (opens new window)	Returns the element’s normalized custom field values, indexed by their handles.
getFirstError() (opens new window)	Returns the first error of the specified attribute.
getFirstErrors() (opens new window)	Returns the first error of every attribute in the model.
getGateway()
getGqlTypeName() (opens new window)	Returns the GraphQL type name for this element type.
getHasDescendants() (opens new window)	Returns whether the element has descendants.
getHasFreshContent() (opens new window)	Returns whether the element’s content is "fresh" (unsaved and without validation errors).
getHistories()
getHtmlAttributes() (opens new window)	Returns any attributes that should be included in the element’s DOM representation in the control panel.
getId() (opens new window)	Returns the element’s ID.
getIsActiveCart()	Returns whether this order is the user's current active cart.
getIsDraft() (opens new window)	Returns whether this is a draft.
getIsEditable()	Returns whether the current user can edit the element.
getIsEmpty()	Returns whether the order has any items in it.
getIsHomepage() (opens new window)	Returns whether this element represents the site homepage.
getIsPaid()
getIsRevision() (opens new window)	Returns whether this is a revision.
getIsUnpaid()
getIsUnsavedDraft() (opens new window)	Returns whether the element is an unsaved draft.
getItemSubtotal()	Returns the total of all line item's subtotals.
getItemTotal()
getIterator() (opens new window)	Returns an iterator for traversing the attributes in the model.
getLastTransaction()
getLineItems()
getLink()	Returns an anchor pre-filled with this element’s URL and title.
getNestedTransactions()	Returns an array of transactions for the order that have child transactions set on them.
getNext() (opens new window)	Returns the next element relative to this one, from a given set of criteria.
getNextSibling() (opens new window)	Returns the element’s next sibling.
getOrderAdjustments()
getOrderLocale()
getOrderStatus()
getOutstandingBalance()	Returns the difference between the order amount and amount paid.
getPaidStatus()	What is the status of the orders payment
getPaidStatusHtml()	Paid status represented as HTML
getParent() (opens new window)	Returns the element’s parent.
getPaymentCurrency()	Returns the current payment currency, and defaults to the primary currency if not set.
getPaymentSource()	Returns the order's selected payment source if any.
getPdfUrl()	Returns the URL to the order’s PDF invoice.
getPrev() (opens new window)	Returns the previous element relative to this one, from a given set of criteria.
getPrevSibling() (opens new window)	Returns the element’s previous sibling.
getPreviewTargets() (opens new window)	Returns the additional locations that should be available for previewing the element, besides its primary URL (opens new window).
getRef() (opens new window)	Returns the reference string to this element.
getRoute() (opens new window)	Returns the route that should be used when the element’s URI is requested.
getScenario() (opens new window)	Returns the scenario that this model is used in.
getSearchKeywords()	Returns the search keywords for a given search attribute.
getSerializedFieldValues() (opens new window)	Returns an array of the element’s serialized custom field values, indexed by their handles.
getShippingAddress()
getShippingMethod()
getShippingMethodId()
getShortNumber()
getShouldRecalculateAdjustments()
getSiblings() (opens new window)	Returns all of the element’s siblings.
getSite() (opens new window)	Returns the site the element is associated with.
getSourceId() (opens new window)	Returns the element’s ID, or if it’s a draft/revision, its source element’s ID.
getSourceUid() (opens new window)	Returns the element’s UUID, or if it’s a draft/revision, its source element’s UUID.
getStatus() (opens new window)	Returns the element’s status.
getSupportedSites() (opens new window)	Returns the sites this element is associated with.
getTableAttributeHtml() (opens new window)	Returns the HTML that should be shown for a given attribute in Table View.
getThumbUrl() (opens new window)	Returns the URL to the element’s thumbnail, if there is one.
getTotal()	Returns the raw total of the order, which is the total of all line items and adjustments. This number can be negative, so it is not the price of the order.
getTotalDescendants() (opens new window)	Returns the total number of descendants that the element has.
getTotalDiscount()
getTotalPaid()	Returns the total `purchase` and `captured` transactions belonging to this order.
getTotalPrice()	Get the total price of the order, whose minimum value is enforced by the configured {@link Settings::minimumTotalPriceStrategy strategy set for minimum total price}.
getTotalQty()	Returns total number of items.
getTotalSaleAmount()	Returns the total sale amount.
getTotalShippingCost()
getTotalTax()
getTotalTaxIncluded()
getTotalTaxablePrice()	Returns the total price of the order, minus any tax adjustments.
getTotalWeight()
getTransactions()
getUiLabel() (opens new window)	Returns what the element should be called within the control panel.
getUriFormat() (opens new window)	Returns the URI format used to generate this element’s URI.
getUrl() (opens new window)	Returns the element’s full URL.
getUser()
getValidators() (opens new window)	Returns all the validators declared in rules() (opens new window).
gqlScopesByContext() (opens new window)	Returns the GraphQL scopes required by element's context.
gqlTypeNameByContext() (opens new window)	Returns the GraphQL type name by an element's context.
hasContent()	Returns whether elements of this type will be storing any data in the `content` table (titles or custom fields).
hasEagerLoadedElements() (opens new window)	Returns whether elements have been eager-loaded with a given handle.
hasErrors() (opens new window)	Returns a value indicating whether there is any validation error.
hasEventHandlers() (opens new window)	Returns a value indicating whether there is any handler attached to the named event.
hasMethod() (opens new window)	Returns a value indicating whether a method is defined.
hasOutstandingBalance()
hasProperty() (opens new window)	Returns a value indicating whether a property is defined.
hasStatuses() (opens new window)	Returns whether elements of this type have statuses.
hasTitles() (opens new window)	Returns whether elements of this type have traditional titles.
hasUris() (opens new window)	Returns whether elements of this type can have their own slugs and URIs.
indexHtml() (opens new window)	Returns the element index HTML.
init()	Initializes the object.
instance() (opens new window)	Returns static class instance, which can be used to obtain meta information.
isAncestorOf() (opens new window)	Returns whether this element is an ancestor of another one.
isAttributeActive() (opens new window)	Returns a value indicating whether the attribute is active in the current scenario.
isAttributeRequired() (opens new window)	Returns a value indicating whether the attribute is required.
isAttributeSafe() (opens new window)	Returns a value indicating whether the attribute is safe for massive assignments.
isChildOf() (opens new window)	Returns whether this element is a direct child of another one.
isDescendantOf() (opens new window)	Returns whether this element is a descendant of another one.
isFieldDirty() (opens new window)	Returns whether a custom field value has changed since the element was first loaded.
isFieldEmpty() (opens new window)	Returns whether a field is empty.
isLocalized() (opens new window)	Returns whether elements of this type store content on a per-site basis.
isNextSiblingOf() (opens new window)	Returns whether this element is the direct next sibling of another one.
isParentOf() (opens new window)	Returns whether this element is a direct parent of another one.
isPrevSiblingOf() (opens new window)	Returns whether this element is the direct previous sibling of another one.
isSiblingOf() (opens new window)	Returns whether this element is a sibling of another one.
load() (opens new window)	Populates the model with input data.
loadMultiple() (opens new window)	Populates a set of models with the data from end user.
lowerDisplayName() (opens new window)	Returns the lowercase version of displayName() (opens new window).
markAsClean() (opens new window)	Resets the record of dirty attributes and fields.
markAsComplete()	Marks the order as complete and sets the default order status, then saves the order.
markAsDirty() (opens new window)	Marks all fields and attributes as dirty.
off() (opens new window)	Detaches an existing event handler from this component.
offsetExists() (opens new window)	Returns whether there is an element at the specified offset.
offsetGet() (opens new window)	Returns the element at the specified offset.
offsetSet() (opens new window)	Sets the element at the specified offset.
offsetUnset() (opens new window)	Sets the element value at the specified offset to null.
on() (opens new window)	Attaches an event handler to an event.
onUnsafeAttribute() (opens new window)	This method is invoked when an unsafe attribute is being massively assigned.
pluralDisplayName() (opens new window)	Returns the plural version of displayName() (opens new window).
pluralLowerDisplayName() (opens new window)	Returns the plural, lowercase version of displayName() (opens new window).
recalculate()	Regenerates all adjusters and update line item and order totals.
refHandle() (opens new window)	Returns the handle that should be used to refer to this element type from reference tags.
removeBillingAddress()	Removes the billing address from the order
removeLineItem()	Removes a specific line item from the order.
removeShippingAddress()	Removes the shipping address from the order
rules()	Returns the validation rules for attributes.
safeAttributes() (opens new window)	Returns the attribute names that are safe to be massively assigned in the current scenario.
scenarios() (opens new window)	Returns a list of scenarios and the corresponding active attributes.
searchableAttributes() (opens new window)	Defines which element attributes should be searchable.
setAdjustments()
setAttributes() (opens new window)	Sets the attribute values in a massive way.
setBillingAddress()
setCustomerId()
setDirtyAttributes() (opens new window)	Sets the list of dirty attribute names.
setEagerLoadedElementCount() (opens new window)	Sets the count of eager-loaded elements for a given handle.
setEagerLoadedElements() (opens new window)	Sets some eager-loaded elements on a given handle.
setEmail()	Sets the orders email address. Will have no affect if the order's customer is a registered user.
setEnabledForSite() (opens new window)	Sets whether the element is enabled for the current site.
setEstimatedBillingAddress()
setEstimatedShippingAddress()
setFieldParamNamespace() (opens new window)	Sets the namespace used by custom field params on the request.
setFieldValue() (opens new window)	Sets the value for a given field.
setFieldValues() (opens new window)	Sets the element’s custom field values.
setFieldValuesFromRequest() (opens new window)	Sets the element’s custom field values, when the values have come from post data.
setGatewayId()	Sets the order's selected gateway id.
setLineItems()
setNext() (opens new window)	Sets the default next element.
setParent() (opens new window)	Sets the element’s parent.
setPaymentCurrency()
setPaymentSource()	Sets the order's selected payment source
setPrev() (opens new window)	Sets the default previous element.
setRevisionCreatorId() (opens new window)	Sets the revision creator ID to be saved.
setRevisionNotes() (opens new window)	Sets the revision notes to be saved.
setScenario() (opens new window)	Sets the scenario for the model.
setShippingAddress()
setShouldRecalculateAdjustments()
sortOptions() (opens new window)	Returns the sort options for the element type.
sources() (opens new window)	Returns the source definitions that elements of this type may belong to.
statuses() (opens new window)	Returns all of the possible statuses that elements of this type may have.
tableAttributes() (opens new window)	Defines all of the available columns that can be shown in table views.
toArray() (opens new window)	Converts the model into an array.
trackChanges() (opens new window)	Returns whether Craft should keep track of attribute and custom field changes made to this element type, including when the last time they were changed, and who was logged-in at the time.
trigger() (opens new window)	Triggers an event.
updateOrderPaidInformation()	Updates the paid status and paid date of the order, and marks as complete if the order is paid or authorized.
updateOrderPaidTotal()
validate() (opens new window)	Performs the data validation.
validateAddress()	Validates addresses, and also adds prefixed validation errors to order
validateAddressBelongsToOrdersCustomer()	Validates that an address belongs to the order‘s customer.
validateAddressReuse()	Validates that shipping address isn't being set to be the same as billing address, when billing address is set to be shipping address
validateCouponCode()
validateCustomFieldAttribute() (opens new window)	Calls a custom validation function on a custom field.
validateCustomFieldContentSize() (opens new window)	Validates that the content size is going to fit within the field’s database column.
validateGatewayId()
validateLineItems()	Validates line items, and also adds prefixed validation errors to order
validateMultiple() (opens new window)	Validates multiple models.
validatePaymentCurrency()
validatePaymentSourceId()

# `__toString()`

Returns the string representation of the element.

View source (opens new window)

Returns

string (opens new window)

# `_getAdjustmentsTotalByType()`

View source (opens new window)

Arguments

$types (string (opens new window), array (opens new window))
$included (boolean (opens new window))

Returns

float (opens new window), integer (opens new window)

# `addLineItem()`

Adds a line item to the order. Updates the line item if the ID of that line item is already in the cart.

View source (opens new window)

Arguments

$lineItem (craft\commerce\models\LineItem)

# `afterOrderComplete()`

Called after the order successfully completes

View source (opens new window)

# `afterSave()`

Performs actions after an element is saved.

View source (opens new window)

Arguments

$isNew (boolean (opens new window)) – Whether the element is brand new

# `attributes()`

Returns the list of attribute names.

By default, this method returns all public non-static properties of the class. You may override this method to change the default behavior.

View source (opens new window)

Returns

array (opens new window) – List of attribute names.

# `beforeValidate()`

This method is invoked before validation starts.

The default implementation raises a beforeValidate event. You may override this method to do preliminary checks before validation. Make sure the parent implementation is invoked so that the event can be raised.

View source (opens new window)

Returns

boolean (opens new window) – Whether the validation should be executed. Defaults to true. If false is returned, the validation will stop and the model is considered invalid.

# `datetimeAttributes()`

Returns the names of any attributes that should hold DateTime (opens new window) values.

View source (opens new window)

Returns

string (opens new window)[]

# `displayName()`

View source (opens new window)

Returns

null (opens new window), string (opens new window)

# `extraFields()`

Returns the list of fields that can be expanded further and returned by toArray() (opens new window).

This method is similar to fields() (opens new window) except that the list of fields returned by this method are not returned by default by toArray() (opens new window). Only when field names to be expanded are explicitly specified when calling toArray() (opens new window), will their values be exported.

The default implementation returns an empty array.

You may override this method to return a list of expandable fields based on some context information (e.g. the current application user).

View source (opens new window)

Returns

array (opens new window) – The list of expandable field names or field definitions. Please refer to fields() (opens new window) on the format of the return value.

# `find()`

Creates an craft\elements\db\ElementQueryInterface (opens new window) instance for query purpose.

The returned craft\elements\db\ElementQueryInterface (opens new window) instance can be further customized by calling methods defined in craft\elements\db\ElementQueryInterface (opens new window) before one() or all() is called to return populated \craft\commerce\elements\ElementInterface instances. For example,

// Find the entry whose ID is 5
$entry = Entry::find()->id(5)->one();
// Find all assets and order them by their filename:
$assets = Asset::find()
    ->orderBy('filename')
    ->all();

If you want to define custom criteria parameters for your elements, you can do so by overriding this method and returning a custom query class. For example,

class Product extends Element
{
    public static function find()
    {
        // use ProductQuery instead of the default ElementQuery
        return new ProductQuery(get_called_class());
    }
}

You can also set default criteria parameters on the ElementQuery if you don’t have a need for a custom query class. For example,

class Customer extends ActiveRecord
{
    public static function find()
    {
        return parent::find()->limit(50);
    }
}

View source (opens new window)

Returns

craft\commerce\elements\db\OrderQuery – The newly created craft\commerce\elements\db\OrderQuery instance.

# `getAdjustmentSubtotal()`

Returns the total of adjustments made to order.

View source (opens new window)

Returns

float (opens new window), integer (opens new window)

# `getAdjustments()`

View source (opens new window)

Returns

craft\commerce\models\OrderAdjustment[]

# `getAdjustmentsTotal()`

View source (opens new window)

Returns

float (opens new window)

# `getAdjustmentsTotalByType()`

DEPRECATED

Deprecated in 2.2

View source (opens new window)

Arguments

$types (string (opens new window), array (opens new window))
$included (boolean (opens new window))

Returns

float (opens new window), integer (opens new window)

# `getAvailableShippingMethods()`

View source (opens new window)

Returns

craft\commerce\base\ShippingMethodInterface[], craft\commerce\base\ShippingMethod[]

# `getBillingAddress()`

View source (opens new window)

Returns

craft\commerce\models\Address, null (opens new window)

# `getCpEditUrl()`

Returns the element’s edit URL in the control panel.

View source (opens new window)

Returns

string (opens new window), null (opens new window)

# `getCustomer()`

View source (opens new window)

Returns

craft\commerce\models\Customer, null (opens new window)

# `getCustomerId()`

Since: 2.2.23

View source (opens new window)

Returns

integer (opens new window), null (opens new window)

# `getEmail()`

Returns the email for this order. Will always be the registered users email if the order's customer is related to a user.

View source (opens new window)

Returns

string (opens new window), null (opens new window)

# `getEstimatedBillingAddress()`

Since: 2.2

View source (opens new window)

Returns

craft\commerce\models\Address, null (opens new window)

# `getEstimatedShippingAddress()`

Since: 2.2

View source (opens new window)

Returns

craft\commerce\models\Address, null (opens new window)

# `getFieldLayout()`

Returns the field layout used by this element.

View source (opens new window)

Returns

craft\models\FieldLayout (opens new window), null (opens new window)

# `getGateway()`

View source (opens new window)

Returns

craft\commerce\base\GatewayInterface, null (opens new window)

Throws

# `getHistories()`

View source (opens new window)

Returns

craft\commerce\models\OrderHistory[]

# `getIsActiveCart()`

Returns whether this order is the user's current active cart.

View source (opens new window)

Returns

boolean (opens new window)

# `getIsEditable()`

Returns whether the current user can edit the element.

View source (opens new window)

Returns

boolean (opens new window)

# `getIsEmpty()`

Returns whether the order has any items in it.

View source (opens new window)

Returns

boolean (opens new window)

# `getIsPaid()`

View source (opens new window)

Returns

boolean (opens new window)

# `getIsUnpaid()`

View source (opens new window)

Returns

boolean (opens new window)

# `getItemSubtotal()`

Returns the total of all line item's subtotals.

View source (opens new window)

Returns

float (opens new window)

# `getItemTotal()`

View source (opens new window)

Returns

float (opens new window)

# `getLastTransaction()`

View source (opens new window)

Returns

craft\commerce\models\Transaction, null (opens new window)

# `getLineItems()`

View source (opens new window)

Returns

craft\commerce\models\LineItem[]

# `getLink()`

Returns an anchor pre-filled with this element’s URL and title.

View source (opens new window)

Returns

\Twig\Markup, null (opens new window)

# `getNestedTransactions()`

Returns an array of transactions for the order that have child transactions set on them.

View source (opens new window)

Returns

craft\commerce\models\Transaction[]

# `getOrderAdjustments()`

View source (opens new window)

Returns

array (opens new window)

# `getOrderStatus()`

View source (opens new window)

Returns

craft\commerce\models\OrderStatus, null (opens new window)

# `getOutstandingBalance()`

Returns the difference between the order amount and amount paid.

View source (opens new window)

Returns

float (opens new window)

# `getPaidStatus()`

What is the status of the orders payment

View source (opens new window)

Returns

string (opens new window)

# `getPaidStatusHtml()`

Paid status represented as HTML

View source (opens new window)

Returns

string (opens new window)

# `getPaymentCurrency()`

Returns the current payment currency, and defaults to the primary currency if not set.

View source (opens new window)

Returns

string (opens new window)

# `getPaymentSource()`

Returns the order's selected payment source if any.

View source (opens new window)

Returns

craft\commerce\models\PaymentSource, null (opens new window)

Throws

yii\base\InvalidConfigException (opens new window)
if the payment source is being set by a guest customer.
yii\base\InvalidArgumentException (opens new window)
if the order is set to an invalid payment source.

# `getPdfUrl()`

Returns the URL to the order’s PDF invoice.

View source (opens new window)

Arguments

$option (string (opens new window), null (opens new window)) – The option that should be available to the PDF template (e.g. “receipt”)

Returns

string (opens new window), null (opens new window) – The URL to the order’s PDF invoice, or null if the PDF template doesn’t exist

Throws

yii\base\Exception (opens new window)

# `getSearchKeywords()`

Returns the search keywords for a given search attribute.

View source (opens new window)

Arguments

$attribute (string (opens new window))

Returns

string (opens new window)

# `getShippingAddress()`

View source (opens new window)

Returns

craft\commerce\models\Address, null (opens new window)

# `getShippingMethod()`

View source (opens new window)

Returns

craft\commerce\models\ShippingMethod, null (opens new window)

# `getShippingMethodId()`

View source (opens new window)

Returns

integer (opens new window), null (opens new window)

# `getShortNumber()`

View source (opens new window)

Returns

string (opens new window)

# `getShouldRecalculateAdjustments()`

View source (opens new window)

Returns

boolean (opens new window)

# `getTotal()`

Returns the raw total of the order, which is the total of all line items and adjustments. This number can be negative, so it is not the price of the order.

See also craft\commerce\elements\Order::getTotalPrice() – The actual total price of the order View source (opens new window)

Returns

float (opens new window)

# `getTotalDiscount()`

View source (opens new window)

Returns

float (opens new window)

# `getTotalPaid()`

Returns the total purchase and captured transactions belonging to this order.

View source (opens new window)

Returns

float (opens new window)

# `getTotalPrice()`

Get the total price of the order, whose minimum value is enforced by the configured {@link Settings::minimumTotalPriceStrategy strategy set for minimum total price}.

View source (opens new window)

Returns

float (opens new window)

# `getTotalQty()`

Returns total number of items.

View source (opens new window)

Returns

integer (opens new window)

# `getTotalSaleAmount()`

Returns the total sale amount.

View source (opens new window)

Returns

float (opens new window)

# `getTotalShippingCost()`

View source (opens new window)

Returns

float (opens new window)

# `getTotalTax()`

View source (opens new window)

Returns

float (opens new window)

# `getTotalTaxIncluded()`

View source (opens new window)

Returns

float (opens new window)

# `getTotalTaxablePrice()`

DEPRECATED

Deprecated in 2.2.9. Use craft\commerce\adjusters\Tax::_getOrderTotalTaxablePrice() instead.

Returns the total price of the order, minus any tax adjustments.

View source (opens new window)

Returns

float (opens new window)

# `getTotalWeight()`

View source (opens new window)

Returns

float (opens new window)

# `getTransactions()`

View source (opens new window)

Returns

craft\commerce\models\Transaction[]

# `getUser()`

View source (opens new window)

Returns

craft\elements\User (opens new window), null (opens new window)

# `hasContent()`

Returns whether elements of this type will be storing any data in the content table (titles or custom fields).

View source (opens new window)

Returns

boolean (opens new window) – Whether elements of this type will be storing any data in the content table.

# `hasOutstandingBalance()`

View source (opens new window)

Returns

boolean (opens new window)

# `init()`

Initializes the object.

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

View source (opens new window)

# `markAsComplete()`

Marks the order as complete and sets the default order status, then saves the order.

View source (opens new window)

Returns

boolean (opens new window)

Throws

# `recalculate()`

Regenerates all adjusters and update line item and order totals.

View source (opens new window)

Throws

yii\base\Exception (opens new window)

# `removeBillingAddress()`

Removes the billing address from the order

View source (opens new window)

# `removeLineItem()`

Removes a specific line item from the order.

View source (opens new window)

Arguments

$lineItem (craft\commerce\models\LineItem)

# `removeShippingAddress()`

Removes the shipping address from the order

View source (opens new window)

# `rules()`

Returns the validation rules for attributes.

Validation rules are used by validate() (opens new window) to check if attribute values are valid. Child classes may override this method to declare different validation rules.

Each rule is an array with the following structure:

[
    ['attribute1', 'attribute2'],
    'validator type',
    'on' => ['scenario1', 'scenario2'],
    //...other parameters...
]

where

attribute list: required, specifies the attributes array to be validated, for single attribute you can pass a string;
validator type: required, specifies the validator to be used. It can be a built-in validator name, a method name of the model class, an anonymous function, or a validator class name.
on: optional, specifies the scenarios (opens new window) array in which the validation rule can be applied. If this option is not set, the rule will apply to all scenarios.
additional name-value pairs can be specified to initialize the corresponding validator properties. Please refer to individual validator class API for possible properties.

A validator can be either an object of a class extending \craft\commerce\elements\Validator, or a model class method (called inline validator) that has the following signature:

// $params refers to validation parameters given in the rule
function validatorName($attribute, $params)

In the above $attribute refers to the attribute currently being validated while $params contains an array of validator configuration options such as max in case of string validator. The value of the attribute currently being validated can be accessed as $this->$attribute. Note the $ before attribute; this is taking the value of the variable $attribute and using it as the name of the property to access.

Yii also provides a set of built-in validators (opens new window). Each one has an alias name which can be used when specifying a validation rule.

Below are some examples:

[
    // built-in "required" validator
    [['username', 'password'], 'required'],
    // built-in "string" validator customized with "min" and "max" properties
    ['username', 'string', 'min' => 3, 'max' => 12],
    // built-in "compare" validator that is used in "register" scenario only
    ['password', 'compare', 'compareAttribute' => 'password2', 'on' => 'register'],
    // an inline validator defined via the "authenticate()" method in the model class
    ['password', 'authenticate', 'on' => 'login'],
    // a validator of class "DateRangeValidator"
    ['dateRange', 'DateRangeValidator'],
];

Note, in order to inherit rules defined in the parent class, a child class needs to merge the parent rules with child rules using functions such as array_merge().

View source (opens new window)

Returns

array (opens new window) – Validation rules

# `setAdjustments()`

View source (opens new window)

Arguments

$adjustments (craft\commerce\models\OrderAdjustment[])

# `setBillingAddress()`

View source (opens new window)

Arguments

$address (craft\commerce\models\Address, array (opens new window))

# `setCustomerId()`

Since: 2.2.23

View source (opens new window)

Arguments

$customerId (integer (opens new window))

# `setEmail()`

Sets the orders email address. Will have no affect if the order's customer is a registered user.

View source (opens new window)

Arguments

$value (string (opens new window), null (opens new window))

# `setEstimatedBillingAddress()`

Since: 2.2

View source (opens new window)

Arguments

$address (craft\commerce\models\Address, array (opens new window))

# `setEstimatedShippingAddress()`

Since: 2.2

View source (opens new window)

Arguments

$address (craft\commerce\models\Address, array (opens new window))

# `setGatewayId()`

Sets the order's selected gateway id.

View source (opens new window)

Arguments

$gatewayId (integer (opens new window))

# `setLineItems()`

View source (opens new window)

Arguments

$lineItems (craft\commerce\models\LineItem[])

# `setPaymentCurrency()`

View source (opens new window)

Arguments

$value (string (opens new window)) – The payment currency code

# `setPaymentSource()`

Sets the order's selected payment source

View source (opens new window)

Arguments

$paymentSource (craft\commerce\models\PaymentSource, null (opens new window))

# `setShippingAddress()`

View source (opens new window)

Arguments

$address (craft\commerce\models\Address, array (opens new window))

# `setShouldRecalculateAdjustments()`

View source (opens new window)

Arguments

$value (boolean (opens new window))

# `updateOrderPaidInformation()`

Updates the paid status and paid date of the order, and marks as complete if the order is paid or authorized.

View source (opens new window)

# `updateOrderPaidTotal()`

View source (opens new window)

# Protected Methods

Method	Description
defineActions()	Defines the available element actions for a given source.
defineDefaultTableAttributes()	Returns the list of table attribute keys that should be shown by default.
defineExporters() (opens new window)	Defines the available element exporters for a given source.
defineRules() (opens new window)	Returns the validation rules for attributes.
defineSearchableAttributes()	Defines which element attributes should be searchable.
defineSortOptions()	Returns the sort options for the element type.
defineSources()	Defines the sources that elements of this type may belong to.
defineTableAttributes()	Defines all of the available columns that can be shown in table views.
extractFieldsFor() (opens new window)	Extract nested fields from a fields collection for a given root field Nested fields are separated with dots (.). e.g: "item.id" The previous example would extract "id".
extractRootFields() (opens new window)	Extracts the root field names from nested fields.
fieldByHandle() (opens new window)	Returns the field with a given handle.
fieldLayoutFields() (opens new window)	Returns each of this element’s fields.
findByCondition() (opens new window)	Finds Element instance(s) by the given condition.
htmlAttributes() (opens new window)	Returns any attributes that should be included in the element’s DOM representation in the control panel.
normalizeFieldValue() (opens new window)	Normalizes a field’s value.
prepElementQueryForTableAttribute() (opens new window)	Preps the element criteria for a given table attribute
previewTargets() (opens new window)	Returns the additional locations that should be available for previewing the element, besides its primary URL (opens new window).
resolveFields() (opens new window)	Determines which fields can be returned by toArray() (opens new window).
route() (opens new window)	Returns the route that should be used when the element’s URI is requested.
tableAttributeHtml()	Returns the HTML that should be shown for a given attribute in Table View.

# `defineActions()`

Defines the available element actions for a given source.

View source (opens new window)

Arguments

$source (string (opens new window), null (opens new window)) – The selected source’s key, if any.

Returns

array (opens new window) – The available element actions.

# `defineDefaultTableAttributes()`

Returns the list of table attribute keys that should be shown by default.

View source (opens new window)

Arguments

$source (string (opens new window)) – The selected source’s key

Returns

string (opens new window)[] – The table attributes.

# `defineSearchableAttributes()`

Defines which element attributes should be searchable.

View source (opens new window)

Returns

string (opens new window)[] – The element attributes that should be searchable

# `defineSortOptions()`

Returns the sort options for the element type.

View source (opens new window)

Returns

array (opens new window) – The attributes that elements can be sorted by

# `defineSources()`

Defines the sources that elements of this type may belong to.

View source (opens new window)

Arguments

$context (string (opens new window), null (opens new window)) – The context ('index' or 'modal').

Returns

array (opens new window) – The sources.

# `defineTableAttributes()`

Defines all of the available columns that can be shown in table views.

View source (opens new window)

Returns

array (opens new window) – The table attributes.

# `tableAttributeHtml()`

Returns the HTML that should be shown for a given attribute in Table View.

This method can be used to completely customize what actually shows up within the table’s body for a given attribute, rather than simply showing the attribute’s raw value.

For example, if your elements have an email attribute that you want to wrap in a mailto: link, your getTableAttributesHtml() method could do this:

switch ($attribute) {
    case 'email':
        return $this->email ? Html::mailto(Html::encode($this->email)) : '';
    // ...
}
return parent::tableAttributeHtml($attribute);

WARNING

All untrusted text should be passed through craft\helpers\Html::encode() (opens new window) to prevent XSS attacks.

By default the following will be returned:

If the attribute name is link or uri, it will be linked to the front-end URL.
If the attribute is a custom field handle, it will pass the responsibility off to the field type.
If the attribute value is a DateTime (opens new window) object, the date will be formatted with a localized date format.
For anything else, it will output the attribute value as a string.

View source (opens new window)

Arguments

$attribute (string (opens new window)) – The attribute name.

Returns

string (opens new window) – The HTML that should be shown for a given attribute in Table View.

Throws

yii\base\InvalidConfigException (opens new window)

# Constants

Constant	Description
`ATTR_STATUS_CONFLICTED`
`ATTR_STATUS_MODIFIED`
`ATTR_STATUS_OUTDATED`
`HOMEPAGE_URI`
`PAID_STATUS_OVERPAID`
`PAID_STATUS_PAID`
`PAID_STATUS_PARTIAL`
`PAID_STATUS_UNPAID`
`SCENARIO_DEFAULT`	The name of the default scenario.
`SCENARIO_ESSENTIALS`
`SCENARIO_LIVE`
`STATUS_ARCHIVED`
`STATUS_DISABLED`
`STATUS_ENABLED`

# Events

# EVENT_AFTER_ADD_LINE_ITEM

Type: yii\base\Event (opens new window)

This event is raised when a line item is added to the order

Plugins can get notified after a line item has been added to the order

use craft\commerce\elements\Order;
use yii\events\Event;

Event::on(Order::class, Order::EVENT_AFTER_ADD_LINE_ITEM, function(Event $e) {
    $lineItem = $e->lineItem;
    $isNew = $e->isNew;
    // ...
});

# EVENT_AFTER_COMPLETE_ORDER

Type: yii\base\Event (opens new window)

This event is raised after an order is completed

Plugins can get notified after an order is completed

use craft\commerce\elements\Order;
use yii\base\Event;

Event::on(Order::class, Order::EVENT_AFTER_COMPLETE_ORDER, function(Event $e) {
    // @var Order $order
    $order = $e->sender;
    // ...
});

# EVENT_AFTER_ORDER_PAID

Type: yii\base\Event (opens new window)

This event is raised after an order is paid and completed

Plugins can get notified after an order is paid and completed

use craft\commerce\elements\Order;
use yii\base\Event;

Event::on(Order::class, Order::EVENT_AFTER_ORDER_PAID, function(Event $e) {
    // @var Order $order
    $order = $e->sender;
    // ...
});

# EVENT_AFTER_REMOVE_LINE_ITEM

Type: yii\base\Event (opens new window)

This event is raised when a line item is removed from the order

Plugins can get notified after a line item has been removed from the order

use craft\commerce\elements\Order;
use yii\base\Event;

Event::on(Order::class, Order::EVENT_AFTER_REMOVE_LINE_ITEM, function(Event $e) {
    $lineItem = $e->lineItem;
    $isNew = $e->isNew;
    // ...
});

# EVENT_BEFORE_ADD_LINE_ITEM

Type: yii\base\Event (opens new window)

This event is raised before a line item has been added to the order

Plugins can get notified before a new line item has been added to the order

use craft\commerce\elements\Order;
use yii\events\CancelableEvent

Event::on(Order::class, Order::EVENT_BEFORE_ADD_LINE_ITEM, function(CancelableEvent $e) {
    $lineItem = $e->lineItem;
    $isNew = $e->isNew;
    $isValid = $e->isValid;
    // ...
});

# EVENT_BEFORE_COMPLETE_ORDER

Type: yii\base\Event (opens new window)

This event is raised when an order is completed

Plugins can get notified before an order is completed

use craft\commerce\elements\Order;
use yii\base\Event;

Event::on(Order::class, Order::EVENT_BEFORE_COMPLETE_ORDER, function(Event $e) {
    // @var Order $order
    $order = $e->sender;
    // ...
});

← Donation Product →

Order

# Public Properties

# adjustmentSubtotal

# adjustments

# adjustmentsTotal

# availableShippingMethods

# billingAddress

# billingAddressId

# billingSameAsShipping

# cancelUrl

# couponCode

# cpEditUrl

# currency

# customer

# customerId

# dateOrdered

# datePaid

# email

# estimatedBillingAddress

# estimatedBillingAddressId

# estimatedBillingSameAsShipping

# estimatedShippingAddress

# estimatedShippingAddressId

# fieldLayout

# gateway

# gatewayId

# histories

# isActiveCart

# isCompleted

# isEditable

# isEmpty

# isPaid

# isUnpaid

# itemSubtotal

# itemTotal

# lastIp

# lastTransaction

# lineItems

# link

# makePrimaryBillingAddress

# makePrimaryShippingAddress

# message

# nestedTransactions

# number

# orderAdjustments

# orderLanguage

# orderStatus

# orderStatusId

# outstandingBalance

# paidStatus

# paidStatusHtml

# paymentCurrency

# paymentSource

# paymentSourceId

# pdfUrl

# reference

# registerUserOnOrderComplete

# returnUrl

# shippingAddress

# shippingAddressId

# shippingMethod

# shippingMethodHandle

# shippingMethodId

# shippingSameAsBilling

# shortNumber

# shouldRecalculateAdjustments

# total

# totalDiscount

# totalPaid

# totalPrice

# totalQty

# totalSaleAmount

# totalShippingCost

# totalTax

# totalTaxIncluded

# totalTaxablePrice

# totalWeight

# transactions

# user

# Protected Properties

# `adjustmentSubtotal`

# `adjustments`

# `adjustmentsTotal`

# `availableShippingMethods`

# `billingAddress`

# `billingAddressId`

# `billingSameAsShipping`

# `cancelUrl`

# `couponCode`

# `cpEditUrl`

# `currency`

# `customer`

# `customerId`

# `dateOrdered`

# `datePaid`

# `email`

# `estimatedBillingAddress`

# `estimatedBillingAddressId`

# `estimatedBillingSameAsShipping`

# `estimatedShippingAddress`

# `estimatedShippingAddressId`

# `fieldLayout`

# `gateway`

# `gatewayId`

# `histories`

# `isActiveCart`

# `isCompleted`

# `isEditable`

# `isEmpty`

# `isPaid`

# `isUnpaid`

# `itemSubtotal`

# `itemTotal`

# `lastIp`

# `lastTransaction`

# `lineItems`

# `link`

# `makePrimaryBillingAddress`

# `makePrimaryShippingAddress`

# `message`

# `nestedTransactions`

# `number`

# `orderAdjustments`

# `orderLanguage`

# `orderStatus`

# `orderStatusId`

# `outstandingBalance`

# `paidStatus`

# `paidStatusHtml`

# `paymentCurrency`

# `paymentSource`

# `paymentSourceId`

# `pdfUrl`

# `reference`

# `registerUserOnOrderComplete`

# `returnUrl`

# `shippingAddress`

# `shippingAddressId`

# `shippingMethod`

# `shippingMethodHandle`

# `shippingMethodId`

# `shippingSameAsBilling`

# `shortNumber`

# `shouldRecalculateAdjustments`

# `total`

# `totalDiscount`

# `totalPaid`

# `totalPrice`

# `totalQty`

# `totalSaleAmount`

# `totalShippingCost`

# `totalTax`

# `totalTaxIncluded`

# `totalTaxablePrice`

# `totalWeight`

# `transactions`

# `user`

# `__toString()`

# `_getAdjustmentsTotalByType()`

# `addLineItem()`