Order
- Type
- Class
- Namespace
- craft\commerce\records
- Inherits
- craft\commerce\records\Order » craft\db\ActiveRecord (opens new window) » yii\db\ActiveRecord (opens new window) » yii\db\BaseActiveRecord (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), yii\base\Arrayable (opens new window), yii\base\Configurable (opens new window), yii\base\StaticInstanceInterface (opens new window), yii\db\ActiveRecordInterface (opens new window)
- Uses traits
- yii\base\ArrayableTrait (opens new window), yii\base\StaticInstanceTrait (opens new window)
- Since
- 2.0
Order or Cart record.
View source (opens new window)
# Public Properties
# billingAddress
- Default value
null- Access
- Read-only
View source (opens new window)
# billingAddressId
- Type
- integer (opens new window), null (opens new window)
- Default value
null
View source (opens new window)
# cancelUrl
- Type
- string (opens new window)
- Default value
null
View source (opens new window)
# couponCode
- Type
- string (opens new window)
- Default value
null
View source (opens new window)
# currency
- Type
- string (opens new window)
- Default value
null
View source (opens new window)
# customer
- Type
- yii\db\ActiveQueryInterface (opens new window)
- Default value
null
View source (opens new window)
# customerId
- Type
- integer (opens new window)
- Default value
null
View source (opens new window)
# dateAuthorized
- Type
- DateTime (opens new window)
- Default value
null
View source (opens new window)
# dateOrdered
- Type
- DateTime (opens new window)
- Default value
null
View source (opens new window)
# datePaid
- Type
- DateTime (opens new window)
- Default value
null
View source (opens new window)
# discount
- Type
- yii\db\ActiveQueryInterface (opens new window)
- Default value
null
View source (opens new window)
# element
- Type
- yii\db\ActiveQueryInterface (opens new window)
- Default value
null
View source (opens new window)
# email
- Type
- string (opens new window)
- Default value
null
View source (opens new window)
# estimatedBillingAddressId
- Type
- integer (opens new window)
- Default value
null
View source (opens new window)
# estimatedShippingAddressId
- Type
- integer (opens new window)
- Default value
null
View source (opens new window)
# gateway
- Type
- yii\db\ActiveQueryInterface (opens new window)
- Default value
null
View source (opens new window)
# gatewayId
- Type
- integer (opens new window)
- Default value
null
View source (opens new window)
# histories
- Type
- craft\commerce\records\OrderHistory[]
- Default value
null
View source (opens new window)
# id
- Type
- integer (opens new window)
- Default value
null
View source (opens new window)
# isCompleted
- Type
- boolean (opens new window)
- Default value
null
View source (opens new window)
# itemSubtotal
- Type
- float (opens new window)
- Default value
null
View source (opens new window)
# itemTotal
- Type
- float (opens new window)
- Default value
null
View source (opens new window)
# lastIp
- Type
- string (opens new window)
- Default value
null
View source (opens new window)
# lineItems
- Type
- craft\commerce\records\LineItem[]
- Default value
null
View source (opens new window)
# message
- Type
- string (opens new window)
- Default value
null
View source (opens new window)
# number
- Type
- string (opens new window)
- Default value
null
View source (opens new window)
# orderCompletedEmail
- Type
- string (opens new window)
- Default value
null
View source (opens new window)
# orderLanguage
- Type
- string (opens new window)
- Default value
null
View source (opens new window)
# orderSiteId
- Type
- integer (opens new window)
- Default value
null
View source (opens new window)
# orderStatus
- Type
- craft\commerce\records\OrderStatus
- Default value
null
View source (opens new window)
# orderStatusId
- Type
- integer (opens new window)
- Default value
null
View source (opens new window)
# origin
- Type
- string (opens new window)
- Default value
null
View source (opens new window)
# paidStatus
- Type
- string (opens new window)
- Default value
null
View source (opens new window)
# paymentCurrency
- Type
- string (opens new window)
- Default value
null
View source (opens new window)
# paymentSource
- Type
- yii\db\ActiveQueryInterface (opens new window)
- Default value
null
View source (opens new window)
# paymentSourceId
- Type
- integer (opens new window)
- Default value
null
View source (opens new window)
# recalculationMode
- Type
- string (opens new window)
- Default value
null
View source (opens new window)
# reference
- Type
- string (opens new window)
- Default value
null
View source (opens new window)
# registerUserOnOrderComplete
- Type
- boolean (opens new window)
- Default value
null
View source (opens new window)
# returnUrl
- Type
- string (opens new window)
- Default value
null
View source (opens new window)
# saveBillingAddressOnOrderComplete
- Type
- boolean (opens new window)
- Default value
null
View source (opens new window)
# saveShippingAddressOnOrderComplete
- Type
- boolean (opens new window)
- Default value
null
View source (opens new window)
# shippingAddress
- Default value
null- Access
- Read-only
View source (opens new window)
# shippingAddressId
- Type
- integer (opens new window), null (opens new window)
- Default value
null
View source (opens new window)
# shippingMethodHandle
- Type
- string (opens new window)
- Default value
null
View source (opens new window)
# shippingMethodName
- Type
- string (opens new window)
- Default value
null
View source (opens new window)
# sourceBillingAddressId
- Type
- integer (opens new window)
- Default value
null
View source (opens new window)
# sourceShippingAddressId
- Type
- integer (opens new window)
- Default value
null
View source (opens new window)
# total
- Type
- float (opens new window)
- Default value
null
View source (opens new window)
# totalDiscount
- Type
- float (opens new window)
- Default value
null
View source (opens new window)
# totalPaid
- Type
- float (opens new window)
- Default value
null
View source (opens new window)
# totalPrice
- Type
- float (opens new window)
- Default value
null
View source (opens new window)
# totalQty
- Type
- float (opens new window)
- Default value
null
View source (opens new window)
# totalShippingCost
- Type
- float (opens new window)
- Default value
null
View source (opens new window)
# totalTax
- Type
- float (opens new window)
- Default value
null
View source (opens new window)
# totalTaxIncluded
- Type
- float (opens new window)
- Default value
null
View source (opens new window)
# transactions
- Type
- craft\commerce\records\Transaction[]
- Default value
null
View source (opens new window)
# Public Methods
| Method | Description |
|---|---|
| __call() (opens new window) | Calls the named method which is not a class method. |
| __clone() (opens new window) | This method is called after the object is created by cloning an existing one. |
| __construct() (opens new window) | Constructor. |
| __get() (opens new window) | PHP getter magic method. |
| __isset() (opens new window) | Checks if a property value is null. |
| __set() (opens new window) | PHP setter magic method. |
| __unset() (opens new window) | Sets a component property to be null. |
| 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. |
| afterDelete() (opens new window) | This method is invoked after deleting a record. |
| afterFind() (opens new window) | This method is called when the AR object is created and populated with the query result. |
| afterRefresh() (opens new window) | This method is called when the AR object is refreshed. |
| afterSave() (opens new window) | This method is called at the end of inserting or updating a record. |
| 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() (opens new window) | Returns the list of all attribute names of the model. |
| beforeDelete() (opens new window) | This method is invoked before deleting a record. |
| beforeSave() (opens new window) | This method is called at the beginning of inserting or updating a record. |
| beforeValidate() (opens new window) | 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). |
| delete() (opens new window) | Deletes the table row corresponding to this active record. |
| deleteAll() (opens new window) | Deletes rows in the table using the provided conditions. |
| detachBehavior() (opens new window) | Detaches a behavior from the component. |
| detachBehaviors() (opens new window) | Detaches all behaviors from the component. |
| ensureBehaviors() (opens new window) | Makes sure that the behaviors declared in behaviors() (opens new window) are attached to this component. |
| equals() (opens new window) | Returns a value indicating whether the given active record is the same as the current one. |
| extraFields() (opens new window) | 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() (opens new window) | Creates an \craft\db\ActiveQueryInterface instance for query purpose. |
| findAll() (opens new window) | Returns a list of active record models that match the specified primary key value(s) or a set of column values. |
| findBySql() (opens new window) | See yii\db\ActiveRecord::findBySql() (opens new window) for more info. |
| findOne() (opens new window) | Returns a single active record model instance by a primary key or an array of column values. |
| 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). |
| getAttribute() (opens new window) | Returns the named attribute value. |
| getAttributeHint() (opens new window) | Returns the text hint for the specified attribute. |
| getAttributeLabel() (opens new window) | Returns the text label for the specified attribute. |
| getAttributes() (opens new window) | Returns attribute values. |
| getBehavior() (opens new window) | Returns the named behavior object. |
| getBehaviors() (opens new window) | Returns all behaviors attached to this component. |
| getBillingAddress() | |
| getCustomer() | |
| getDb() (opens new window) | Returns the database connection used by this AR class. |
| getDirtyAttributes() (opens new window) | Returns the attribute values that have been modified since they are loaded or saved most recently. |
| getDiscount() | |
| getElement() | |
| 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. |
| 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() | |
| getHistories() | |
| getIsNewRecord() (opens new window) | Returns a value indicating whether the current record is new. |
| getIterator() (opens new window) | Returns an iterator for traversing the attributes in the model. |
| getLineItems() | |
| getOldAttribute() (opens new window) | Returns the old value of the named attribute. |
| getOldAttributes() (opens new window) | Returns the old attribute values. |
| getOldPrimaryKey() (opens new window) | Returns the old primary key value(s). |
| getOrderStatus() | |
| getPaymentSource() | |
| getPrimaryKey() (opens new window) | Returns the primary key value(s). |
| getRelatedRecords() (opens new window) | Returns all populated related records. |
| getRelation() (opens new window) | Returns the relation object with the specified name. |
| getScenario() (opens new window) | Returns the scenario that this model is used in. |
| getShippingAddress() | |
| getTableSchema() (opens new window) | Returns the schema information of the DB table associated with this AR class. |
| getTransactions() | |
| getValidators() (opens new window) | Returns all the validators declared in rules() (opens new window). |
| hasAttribute() (opens new window) | Returns a value indicating whether the model has an attribute with the specified name. |
| 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. |
| hasMany() (opens new window) | See yii\db\BaseActiveRecord::hasMany() (opens new window) for more info. |
| hasMethod() (opens new window) | Returns a value indicating whether a method is defined. |
| hasOne() (opens new window) | See yii\db\BaseActiveRecord::hasOne() (opens new window) for more info. |
| hasProperty() (opens new window) | Returns a value indicating whether a property is defined for this component. |
| init() (opens new window) | Initializes the object. |
| insert() (opens new window) | Inserts a row into the associated database table using the attribute values of this record. |
| instance() (opens new window) | Returns static class instance, which can be used to obtain meta information. |
| instantiate() (opens new window) | Creates an active record instance. |
| isAttributeActive() (opens new window) | Returns a value indicating whether the attribute is active in the current scenario. |
| isAttributeChanged() (opens new window) | Returns a value indicating whether the named attribute has been changed. |
| 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. |
| isPrimaryKey() (opens new window) | Returns a value indicating whether the given set of attributes represents the primary key for this model. |
| isRelationPopulated() (opens new window) | Check whether the named relation has been populated with records. |
| isTransactional() (opens new window) | Returns a value indicating whether the specified operation is transactional in the current scenario (opens new window). |
| link() (opens new window) | Establishes the relationship between two models. |
| load() (opens new window) | Populates the model with input data. |
| loadDefaultValues() (opens new window) | Loads default values from database table schema. |
| loadMultiple() (opens new window) | Populates a set of models with the data from end user. |
| markAttributeDirty() (opens new window) | Marks an attribute 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. |
| optimisticLock() (opens new window) | Returns the name of the column that stores the lock version for implementing optimistic locking. |
| populateRecord() (opens new window) | Populates an active record object using a row of data from the database/storage. |
| populateRelation() (opens new window) | Populates the named relation with the related records. |
| primaryKey() (opens new window) | Returns the primary key name(s) for this AR class. |
| refresh() (opens new window) | Repopulates this active record with the latest data. |
| rules() (opens new window) | 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. |
| save() (opens new window) | Saves the current record. |
| scenarios() (opens new window) | Returns a list of scenarios and the corresponding active attributes. |
| setAttribute() (opens new window) | Sets the named attribute value. |
| setAttributes() (opens new window) | Sets the attribute values in a massive way. |
| setIsNewRecord() (opens new window) | Sets the value indicating whether the record is new. |
| setOldAttribute() (opens new window) | Sets the old value of the named attribute. |
| setOldAttributes() (opens new window) | Sets the old attribute values. |
| setScenario() (opens new window) | Sets the scenario for the model. |
| tableName() | Declares the name of the database table associated with this AR class. |
| toArray() (opens new window) | Converts the model into an array. |
| transactions() (opens new window) | Declares which DB operations should be performed within a transaction in different scenarios. |
| trigger() (opens new window) | Triggers an event. |
| unlink() (opens new window) | Destroys the relationship between two models. |
| unlinkAll() (opens new window) | Destroys the relationship in current model. |
| update() (opens new window) | Saves the changes to this active record into the associated database table. |
| updateAll() (opens new window) | Updates the whole table using the provided attribute values and conditions. |
| updateAllCounters() (opens new window) | Updates the whole table using the provided counter changes and conditions. |
| updateAttributes() (opens new window) | Updates the specified attributes. |
| updateCounters() (opens new window) | Updates one or several counter columns for the current AR object. |
| validate() (opens new window) | Performs the data validation. |
| validateMultiple() (opens new window) | Validates multiple models. |
# getBillingAddress()
View source (opens new window)
# getCustomer()
View source (opens new window)
# getDiscount()
View source (opens new window)
# getElement()
View source (opens new window)
# getGateway()
View source (opens new window)
# getHistories()
View source (opens new window)
# getLineItems()
View source (opens new window)
# getOrderStatus()
View source (opens new window)
# getPaymentSource()
View source (opens new window)
# getShippingAddress()
View source (opens new window)
# getTransactions()
View source (opens new window)
# tableName()
Declares the name of the database table associated with this AR class.
By default this method returns the class name as the table name by calling yii\helpers\Inflector::camel2id() (opens new window)
with prefix yii\db\Connection::$tablePrefix (opens new window). For example if yii\db\Connection::$tablePrefix (opens new window) is tbl_,
Customer becomes tbl_customer, and OrderItem becomes tbl_order_item. You may override this method
if the table is not named after this convention.
View source (opens new window)
Returns
string (opens new window) – The table name
# Protected Methods
| Method | Description |
|---|---|
| createRelationQuery() (opens new window) | Creates a query instance for has-one or has-many relation. |
| deleteInternal() (opens new window) | Deletes an ActiveRecord without considering transaction. |
| 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. |
| insertInternal() (opens new window) | Inserts an ActiveRecord into DB without considering transaction. |
| prepareForDb() (opens new window) | Sets the dateCreated, dateUpdated, and uid attributes on the record. |
| refreshInternal() (opens new window) | Repopulates this active record with the latest data from a newly fetched instance. |
| resolveFields() (opens new window) | Determines which fields can be returned by toArray() (opens new window). |
| updateInternal() (opens new window) |
# Constants
| Constant | Description |
|---|---|
OP_ALL | All three operations: insert, update, delete. |
OP_DELETE | The delete operation. This is mainly used when overriding transactions() (opens new window) to specify which operations are transactional. |
OP_INSERT | The insert operation. This is mainly used when overriding transactions() (opens new window) to specify which operations are transactional. |
OP_UPDATE | The update operation. This is mainly used when overriding transactions() (opens new window) to specify which operations are transactional. |
SCENARIO_DEFAULT | The name of the default scenario. |